Skip to content

Commit 354853b

Browse files
Update README.md
Added Git LFS requirement.
1 parent dff8f64 commit 354853b

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -90,19 +90,21 @@ https://youtu.be/VJyvjJUfjv8
9090

9191
* Ubuntu 18.04 or 20.04 (may work on MacOS or Windows but currently untested)
9292
* Unity 2020.x or greater
93+
* Git LFS
9394
* ROS Melodic (ZeroSim provides a pre-built Docker container for ROS functionality https://hub.docker.com/r/zerodog/zerosim_ros_vnc)
9495
* Note: ROS Melodic is our primary supported development environment, but ZeroSim has reportedly been able to run on Noetic and ROS2.
9596

9697
### Setting up a new Unity Project
9798

9899
1. In Unity Hub create a new Unity project using Unity 2020.x or later. ![New Unity Project](Documentation~/images/new_unity_project.png)
99100
2. Add ZeroSim via Unity Packages:
100-
1. Unity Menu `Window -> Package Manager`
101-
2. Select the `+` dropdown:
101+
1. IMPORTANT: Make sure GIT LFS is installed on your system before continuing!
102+
2. Unity Menu `Window -> Package Manager`
103+
3. Select the `+` dropdown:
102104
![Dropdown](Documentation~/images/unity_package_manager.png)
103-
1. Select `Add Package From Git URL...` and enter `[email protected]:fsstudio-team/ZeroSimROSUnity.git`. Note this can take upto a few minutes to update but you should see the following:
105+
4. Select `Add Package From Git URL...` and enter `[email protected]:fsstudio-team/ZeroSimROSUnity.git`. Note this can take upto a few minutes to update but you should see the following:
104106
![ZeroSim Package Installed](Documentation~/images/zerosim_package_installed.png)
105-
1. Import the ZeroSim Samples by selecting the Samples `Import` button in the Package Manager:
107+
5. Import the ZeroSim Samples by selecting the Samples `Import` button in the Package Manager:
106108
![Import ZeroSim Samples](Documentation~/images/import_zerosim_samples.png)
107109
3. **IMPORTANT** the default Unity physics settings do not work well with a lot of simulations. It is very much recommended (required for probably most all simulations) to set the physics settings by opening the Unity menu `Edit -> Project Settings... -> Physics` and set the `Default Solver Iterations` to `30` and the `Default Solver Velocity Iterations` to `60`. ![Unity Physics Settings](Documentation~/images/unity_physics_settings.png)
108110
4. **IMPORTANT** the default Unity fixed timestep setting does not work well with a lot of simulions. It is very much recommended to set the `Fixed Timestep` setting by `Edit -> Project Settings... -> Time` to `0.005` ![Timestep Settings](Documentation~/images/unity_timestep_settings.png)

0 commit comments

Comments
 (0)