-
Notifications
You must be signed in to change notification settings - Fork 52
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
36fd6bf
commit b7d7b1a
Showing
4 changed files
with
79 additions
and
32 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,55 +1,101 @@ | ||
|  | ||
|  | ||
| [](https://github.com/Autodesk/synthesis/actions/workflows/Engine.yml) | ||
| [](https://github.com/Autodesk/synthesis/actions/workflows/API.yml) | ||
| [](https://github.com/Autodesk/synthesis/actions/workflows/ClangFormat.yml) | ||
| [](https://github.com/Autodesk/synthesis/actions/workflows/BlackFormat.yml) | ||
|
|
||
| Synthesis is a robotics simulator designed to help FIRST Robotics teams design, strategize, test, and practice. Teams can import their own robot and field designs or use preexisting ones into the simulator for a variety of uses, including: | ||
| * Testing robot designs | ||
| * Exploring the field environment | ||
| * Driver practice & strategy | ||
| Synthesis is a robotics simulator designed by and for FIRST robotics students to help teams design, strategize, test and practice. Teams have the ability to import their own robots and fields using our [Fusion 360 Exporter](/exporter/) or use the pre-packaged ones that come included with every release of Synthesis. | ||
|
|
||
| Developed solely by FIRST students, Synthesis is built with a direct focus on the FIRST community. We've also made the project completely open source in order to better involve the community. This way contributors can help make Synthesis better or modify Synthesis to better suit their team’s needs. | ||
| For more information on the product itself or the team, visit [http://synthesis.autodesk.com/](http://synthesis.autodesk.com/). | ||
|
|
||
| For more information on the product itself or the team, visit http://synthesis.autodesk.com/ | ||
| ## Goals | ||
|
|
||
| Synthesis is built with a direct focus on the FIRST community. Every single one of our developers is a FIRST student, striving to better the community. We've also made the project completely open source in order to better involve the community. This way contributors can help make Synthesis better or modify Synthesis to better suit their team’s needs. | ||
|
|
||
| Here are some of our primary goals for Synthesis: | ||
|
|
||
| - **Ease of Use**: It's important for us that Synthesis is out of the box ready for teams to use. We want to make sure that teams can get up and running with Synthesis as quickly as possible. To that end, every release of Synthesis comes pre-packaged with a variety of robots and fields; in addition to the ability to export and import your own. | ||
| - **Testing Robot Designs**: Synthesis is designed to be a tool for teams to quickly test their robot designs in a semi-realistic environment. Are you a builder who wants to use some crazy virtual four-bar linkage and your team says it's a waste of time? Well now you can prove them wrong by testing it in Synthesis! | ||
| - **Exploring the Field Environment**: Every year on kickoff, for both FTC and FRC FIRST competitions, synthesis has a new release with the brand new field for that year included. This allows teams to explore the field through a 3D model, drive a robot around, and begin to strategize for the upcoming season's game. | ||
| - **Driver Practice & Strategy**: Not getting enough driver practice or don't have a full field available to you? Synthesis has you covered with the ability to drive your robot around with a gamepad from a first-person view at the driver station; allowing you to get a feel for potential control scheme layouts and any line-of-sight challenges that may arise. This also allows the drive team and the programmers to communicate about what control layouts work best for each driver. | ||
|
|
||
| ## Getting Started | ||
|
|
||
| Synthesis is comprised of 4 separate components that are mostly developed independently of each other. You will want to clone the entire repository first, then follow a different set of steps depending on which component you wish to work on. The links below will lead you to specific instructions that will get you a copy of that component up and running on your local machine for development and testing purposes. | ||
| If your a FIRST robotics student who just wants to use Synthesis, you *don't* need this repo. Simply **install the latest release of Synthesis from [synthesis.autodesk.com/download](https://synthesis.autodesk.com/download.html)**. | ||
|
|
||
| If you're a developer who wants to contribute to Synthesis, you're in the right place. Synthesis is comprised of 3 main components that can be developed separately. These components include: | ||
|
|
||
| - [Synthesis API](/api/) | ||
| - [Simulation Engine](/engine/) | ||
| - [Fusion Robot Exporter (Fusion 360 Plugin)](/exporter/) | ||
|
|
||
| * [Simulation Engine](/engine/README.md) | ||
| * [Fusion Robot Exporter (Fusion 360 Plugin)](/exporter/SynthesisFusionAddin/) | ||
| * [API](/api/) | ||
| Each of this components can be manually compiled separately, but this is not recommended. Instead, we recommend using the *init* scripts provided (`init.bat` & `init.sh` respectively) to build and link each component together (excluding the Fusion Robot Exporter). | ||
|
|
||
| ## Installing | ||
| ### Dependencies | ||
|
|
||
| Get the latest release [here](https://github.com/Autodesk/synthesis/releases/latest/). | ||
| You can find all of our other releases on the [releases page](https://github.com/Autodesk/synthesis/releases/) | ||
| Synthesis Version `6.0.0` has the following dependencies: | ||
|
|
||
| ### Windows | ||
| - DotNet 7.0 | ||
| - Protobuf 23.3 | ||
| - Unity Version 2022.3.2f1 (d74737c6db50) | ||
|
|
||
| Download and run SynthesisWin[Version Number].exe. | ||
| These dependencies need to be satisfied before attempting to build Synthesis with unity. You can either install these dependencies manually or use the *resolve dependencies* scripts (`scripts/win/resolve_deps.bat` & `scripts/osx/resolve_deps.sh` respectively) to install some of them for you. | ||
|
|
||
| ### MacOS | ||
| To automatically install DotNet and Protobuf run the following script depending on your operating system: | ||
| - Windows: `scripts/win/resolve_deps.bat` | ||
| - MacOS & Linux: `scripts/osx/resolve_deps.sh` | ||
|
|
||
| Download and Unzip SynthesisOSX[Version Number].zip. | ||
| Navigate to the Synthesis.pkg, and use that to install Synthesis. | ||
| Note that the windows script requires admin privileges to install DotNet and Protobuf to the system PATH. For this reason it is not included by default in `init.bat` unlike how `init.sh` includes `resolve_deps.sh`. | ||
|
|
||
| ### Linux | ||
| Note that Unity must be installed manually through the Unity Hub app which can be downloaded from [https://unity.com/download](https://unity.com/download). | ||
|
|
||
| Download the Synthesis_x86_64.appimage file. | ||
| You can run that directly or move it to your ~/Applications/ directory to have it registered as an app within ubuntu or whatever debian system you are using. | ||
| ### How To Build Synthesis Using `init` and Unity | ||
|
|
||
| The linux installer does not come with the Fusion360 Addin for exporting robots and fields. | ||
| Before attempting to build Synthesis, ensure you have all dependencies installed. | ||
|
|
||
| **NOTE FOR NON DEBIAN USERS**: Synthesis can be installed and ran on other distros, however our linux package is tailored to Debian. | ||
| 1. Open a command prompt. | ||
| 2. Change directories to a location where you'd like to clone the Synthesis repository. | ||
| 3. Clone the Synthesis repository using `git clone https://github.com/Autodesk/synthesis --recurse-submodules`. | ||
| 4. Change directories into the root of the Synthesis repository and run the `init` script for your operating system. | ||
| - Windows: `init.bat` | ||
| - MacOS & Linux: `init.sh` | ||
| 5. Open `synthesis/engine` in Unity. | ||
| 6. From there you can run the simulation engine inside the Unity editor or build it as a standalone application. | ||
| - To build Synthesis as a standalone application, go to `File -> Build Settings` and select your target platform. Then click `Build` and select a location to save the built application. | ||
|
|
||
| ## Contributing | ||
|
|
||
| When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. This way, we can ensure that there is no overlap between contributions and internal development work. You may contact us at [email protected]. | ||
| This project welcomes community suggestions and contributions. Synthesis is 100% open source and relies on the FIRST community to help make it better. The [Synthesis Contribution Guide](/CONTRIBUTING.md) suggests ways in which you can get involved through development and non-development avenues. | ||
|
|
||
| Before you contribute to this repository, please first discuss the change you wish to make via a GitHub issue, email us ([[email protected]](mailto:[email protected])), or reach out through our [community discord](https://www.discord.gg/hHcF9AVgZA). This way we can ensure that there is no overlap between outside contributors and internal development work. | ||
|
|
||
| When ready to contribute, just submit a pull request and be sure to include a clear and detailed description of the changes you've made so that we can verify them and eventually merge. Feel free to check out our [contributing guidelines](/CONTRIBUTING.md) to learn more. | ||
|
|
||
| ## Code Formatting and Style | ||
|
|
||
| Synthesis uses [clang-format](https://clang.llvm.org/docs/ClangFormat.html) and [black](https://black.readthedocs.io/en/stable/) to format all of our `C++`, `C#` and `Python` code. Additionally we have GitHub workflows that verify these formatting standards for each and every pull request. For more information about how to run these formatters yourself, check out the [formatting tools](/scripts/format/) we use. | ||
|
|
||
| When ready to contribute, just submit a pull request and be sure to include a clear and detailed description of the changes you've made so that we can verify them and eventually merge. Feel free to check out our [contributing guidlines](CONTRIBUTING.md) to learn more. | ||
| ## Immersion Program | ||
|
|
||
| Annually, since 2014, Autodesk has sponsored the Synthesis Immersion Program for FIRST robotics students to develop Synthesis. The immersion program is a 10 week paid work experience at the Portland, Oregon Autodesk office from June 20th to August 25th. The immersion program focuses on not only developing Synthesis, but also allowing for opportunities to meet and collaborate with other Autodesk employees. For more information about the immersion program, visit our website at [synthesis.autodesk.com/internship](https://synthesis.autodesk.com/internship.html). | ||
|
|
||
| ### Want to be a Part of the Team? | ||
|
|
||
| If you're a FIRST robotics student who wants to be a part of the Synthesis development team here is some basic information about applying. | ||
|
|
||
| Applicants must be: | ||
|
|
||
| - At least 16 years of age | ||
| - Been a member of a FIRST Robotics team for at least one full season | ||
|
|
||
| Applications open each year during the spring. For more information about applying, exceptions to these requirements or for more info about specific positions offered, please visit the [Synthesis Immersion Program](https://synthesis.autodesk.com/internship.html) website. | ||
|
|
||
| ## Contact | ||
|
|
||
| If you have any questions, you can contact us using the email mentioned above. | ||
| We also have a [community discord](https://www.discord.gg/hHcF9AVgZA) you can join to get updates about Synthesis and consult directly with the students who make it. | ||
| If you have any questions, about Synthesis or the Immersion Program, you can contact us through email ([[email protected]](mailto:[email protected])). Additionally please reach out through our [community discord](https://www.discord.gg/hHcF9AVgZA), it's the best way to get in touch with not only the community but Synthesis' current development team. | ||
|
|
||
| ## License | ||
|
|
||
| Copyright (c) Autodesk | ||
|
|
||
| SPDX-License-Identifier: Apache-2.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters