Installation Guide
Installing Unity
The simulation environment is developed for Unity 6 (the latest tested version is 6000.0.25f1). All later LTS versions of Unity 6 should work as well.
To install this version, you can follow the instructions on the Unity download page. The steps are described in more detail below.
1. Install Unity Hub
The Unity Hub is an application that manages your Unity installs and projects.
- For Windows and Mac: Download the correct installer from the download page and run it.
- For Linux: Follow the instructions on the Linux installation page.
2. Install Unity Editor and an IDE
- Launch Unity Hub
- Download and install Unity version 6:
- Under the "Installs" tab, click the "Install Editor" button
- Unity 6 should be marked as recommended version
- In the "Add modules" window, select the correct modules:
- Under "Dev Tools", select Microsoft Visual Studio or another supported IDE that works on your platform
- Under "Platforms", select the Build Support option for your platform (Dedicated Server Build is not required)
- Also select "Documentation"
- Click "Install" and wait for the installation to finish
Note
When installing Microsoft Visual Studio, you may be prompted to select "Workloads" to install. Please select the "Game development with Unity" Workload.
3. Get a Unity License
- It may be necessary that you create a Unity profile and obtain a license to proceed
- You can do both from the Unity Hub, by clicking the profile button in the top-left corner and selecting "Manage licenses"
- If you are prompted to log in before managing your licenses, press the "Sign in" button
- This will redirect you to the Unity login page, where you can log into your Unity profile or register a new profile by creating a Unity ID
- After signing in, you can press the "Add license" button in the Unity Hub and select "Get a free personal license" (see also this support page)
- The free personal license grants access to all Unity features required to work with the simulator
Troubleshooting
- If the module selection window does not open when installing the Editor, you can add modules later on:
- In the "Installs" tab of the Unity Hub, find your installed Editor version and click on the gear icon
- Then select "Add modules" and select the modules that are still missing
- If some of the modules are not installed successfully (such as Visual Studio):
- Close Unity Hub (make sure to quit the application completely, it may remain in the system tray if you only close the window)
- Launch Unity Hub as administrator
- If the Editor installation failed, follow the instructions in step 2
- If the Editor was installed already but some modules are missing, follow the above instructions for adding modules to an existing install
- If Visual Studio still cannot be installed via modules, you can also install it manually
- Make sure to select the "Game development with Unity" Workload in the installer
- You may have to configure Unity to use Visual Studio as default editor manually (see simulator setup)
- If the simulation environment does not work for the latest Unity version, you can download version 6000.0.25f1 from the download archive
- The "Install" button will open the Unity Hub, after which you can proceed as described above
When Unity has been installed successfully, you can move on to setting up the simulator.