uVersion
English
Download →

Wiki

Quickstart

Your first checkin in under 10 minutes, no terminal.

This page is for you if you are joining a uVersion project and want to start working. Everything happens in the desktop client: no command line to type.

You just need to know your studio's uVersion server address, your username, and your password (your studio admin has given you this information).

1. Install the desktop client

Download the client for your system from uversion.io/downloads:

  • Windows: uVersion_x.y.z_x64-setup.exe. Double-click and follow the installer.
  • macOS (Apple Silicon): uVersion_x.y.z_macos-arm64.app.zip. Unzip it, then drag uVersion.app into Applications.
  • Linux: uVersion_x.y.z_amd64.AppImage (portable) or uVersion_x.y.z_amd64.deb (apt).

2. Sign in to the server

Launch the desktop client. On first open, it asks you for three things:

  • Server address: your studio's address (e.g. https://uversion.mygamestudio.com)
  • Username
  • Password

Once signed in, the client remembers your session. You won't have to re-enter your password day to day.

3. Get the project onto your machine

The project list with the Clone button and a download progress bar.

In the desktop client:

  1. You see the list of projects you have access to
  2. Click Clone next to the project you want
  3. Choose where to download it on your disk (an empty folder)
  4. The client downloads the whole project. You see a progress bar

Expect roughly 1 to 2 minutes per 10 GB on a fiber connection. Once finished, the project is ready to open in Unreal.

4. Edit and submit a file

The checkout state showing a teammate's name and the Request release button.

The typical 3-step workflow:

  1. Reserve the file before editing it (checkout). No one else can change it while you have it reserved.
  2. Edit the file in Unreal or in any other tool.
  3. Submit your change (checkin) with a short message explaining what you changed.

If a teammate has already reserved the file, you see their name and a Request release button that sends them a notification.

Why can't I save this file? Project files are read-only until you reserve them (checkout). This is a safeguard: it prevents you from editing an asset by mistake while a teammate is working on it. Do a checkout from the desktop client or directly in Unreal, and the file becomes editable.

5. Work directly from Unreal

If your project includes the uVersion plugin (a Plugins/uVersion/ folder in the project), you can do everything without leaving the editor:

  1. Open the project in Unreal
  2. Menu Tools → Source Control → Connect to Source Control
  3. Choose uVersion from the dropdown
  4. Confirm. Your credentials are picked up automatically from the desktop client.

Once connected, all source control lives in Unreal:

  • Right-click an asset → Source Control → Check Out to reserve it
  • Small icons in the Content Browser show the state of each asset
  • Blueprint diff available from the history
  • Automatic validation at checkin time (Blueprint compiles, naming conventions, etc.)

Next