ricmua / empty_ros_unity_3d_project Goto Github PK

This repository contains an empty Unity project that has been prepared for use with Git and ROS2. For recent versions of Unity, Git should mostly work out-of-the-box -- provided that there is an appropriate .gitignore file -- but the documentation is still a bit fragmented.¹

To use this project, clone the repository and then open it in the Unity Editor.²³ Make any desired changes to your project, and save to disk. Commit the changes as normal via a git command.

1. Create an empty project via Unity Hub and the Unity Editor.

2. Initialize Git in the project root:

   git init

3. Initialize Git Large File Storage (LFS):²

   git lfs install

4. Download the Unity .gitignore file from the GitHub gitignore template repository⁴ into the repository root:

   wget -O .gitignore https://raw.githubusercontent.com/github/gitignore/main/Unity.gitignore
   

5. Download the .gitattributes file from the GitHub for Unity project into the repository root:

   wget https://raw.githubusercontent.com/github-for-unity/Unity/master/.gitattributes
   

6. Create this README in the project root directory.

7. Add all files to the repository: git add * .gitattributes .gitignore. Commit.

8. With the project open in the Unity Editor, add Unity's ROS-TCP-Connector to the package.

   • For this repository, the package was added from this URL: https://github.com/Unity-Technologies/ROS-TCP-Connector.git?path=/com.unity.robotics.ros-tcp-connector

9. Save the project.