Get started with Unity Version Control via the Unity Hub

You can add Unity Version Control (UVCS) to your Unity Editor projects through the Unity Hub.

If you don't already have DevOps set up, then you get a free trial of the DevOps services when you enable Version Control through the Hub. You can also set up DevOps through your Unity Cloud Dashboard. For more information, refer to Get started with Unity DevOps.

Note: If you’ve been added to a Unity organization or Unity Cloud project that uses DevOps, all you need to get started is a Unity ID. For detailed instructions, refer to Add projects from UVCS to your Hub.

View your projects in the Unity Hub

The second column on the Projects page of the Unity Hub shows whether each project has UVCS enabled:

  • The link icon means that the project uses UVCS. Hover the link icon and select the link to view your repository in the Unity Cloud Dashboard.
  • The broken link icon means that the project doesn't use UVCS.

Enable UVCS for your projects

Create a project with UVCS

Important: We are in the process of updating the Version Control experience. If you are not on the New experience, step 4 also prompts you to enter a UVCS organization name.

To create a new Unity Editor project in the Unity Hub and connect the repository to UVCS:

  1. Select New project.
  2. On the right side panel, enter a Project Name and select the Location.
  3. Check the Use Unity Version Control checkbox.
  4. Review the auto filled Repository Name, and Server location fields, and edit if you need to.
  5. Select Create project.

Add UVCS to an existing project

To enable UVCS for existing Unity Editor projects in the Hub:

  1. Open the contextual menu for the project.
  2. Select Use Unity Version Control.
  3. Review the auto filled UVCS fields, and edit if you need to.
  4. Select Connect to Version Control.

Add projects from UVCS to your Hub

If you've been added to a Unity organization or Unity Cloud project that contains Unity Editor projects, you can add those projects to the Hub:

Important: We are in the process of updating the Version Control experience. If you are not on the New experience, you can add repositories from all of the UVCS organizations you belong to.

  1. Select Add > Add from repository.
  2. Select the repository and then select Next.
  3. Select the Location where you want to download the repository, then select Next.
  4. Select the Editor version and platform and select Open.
    • If you don't have a compatible Unity Editor version for the project, a dialog opens and prompts you to install one.
  5. The Unity Editor opens with the most recent project in the repository, which is added to the Hub.

Add encrypted repositories to your Hub

Important: We are in the process of updating the Version Control experience. If you are not on the New experience, you can add repositories from all encrypted UVCS organizations you belong to.

If you have been invited to an encrypted UVCS repository, you can add its contained projects to the Hub by following these steps:

  1. Ensure you have the encryption key needed to access the repository contents.
  2. If you haven't already, install the UVCS desktop client.
  3. Use the UVCS desktop client to download the repository contents to your local machine, entering the encryption key when prompted.
  4. In the Hub, select Add > Add project from disk, and select the project location.
  5. If the repository contains multiple projects, repeat step 4 for each project you want to work with.

Add repositories that don't contain Unity projects to your local machine

A repository must contain the file ProjectSettings/ProjectVersion.txt to be recognized as a Unity project. If you have been invited to a UVCS repository that doesn't contain a Unity project in the root directory, you can still add it to your local machine by following these steps:

  1. If you haven't already, install the UVCS desktop client.
  2. Download the repository contents to your local machine using the UVCS desktop client.

If the repository contains Unity projects within subdirectories, you can add them to the Hub after following the previous steps by doing the following:

  1. Select Add > Add project from disk.
  2. Select the project location within your local workspace inside the downloaded repository.

Add projects from already added repositories

If you have already added a repository to the Hub, you can add more projects from the same repository by following these steps:

  1. Select Add > Add project from disk.
  2. Select the project location in your local workspace within the already downloaded repository.

If you want to use different workspaces for different projects in the same repository, allowing you to work on different branches for each project, follow these steps:

  1. If you haven't already, install the UVCS desktop client.
  2. In the UVCS desktop client, create a new workspace for the repository.
  3. In the Hub, select Add > Add project from disk, and select the project location in the new workspace.

Open your UVCS connected projects

When you open an Editor project that you enabled UVCS on, the Editor opens the project with the Unity Version Control tab open.

Note: If the Unity Version Control tab isn’t displayed, select Window > Unity Version Control to open the tab.

For information on how to use UVCS through the Unity Editor, refer to the Tutorials section.

Additional resources

Unity logo Documentation
Copyright © 2024 Unity Technologies
"Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.