UGS Client Setup

How to set up an Unreal Game Sync client

This guide will go over the simplest route to setting up the UnrealGameSync (UGS) client for a new user, but if you need more detailed information or additional methods, check out the UGS Quick Start guide. This also assumes that your team has already set up their Perforce server, added all the proper source and content files, installed the proper version of Perforce on the machines you will use UGS with, and have distributed UGS to members who will use it.

If you need additional setup information, please refer to the UGS Overview.

  1. Before you install UGS, confirm that you have set up a Perforce Workspace and have pointed it to the stream that you want to sync your project from. Try to make the local path to your workspace as short as possible.

    Perforce (P4) setup is normally done by someone who has experience with the version control system, and has experience with using it with Unreal Engine (UE). If you are experiencing issues seeing files in Perforce, and have all the proper permissions, this may be due to having an out of date version of Perforce that does not handle the modern features used in Epic's tools. 2020.1 has been confirmed to work with UGS, but even more recent versions could as well.

  2. Run the UGS Installer that was distributed by the owner of UGS at your studio. Make sure you have administrator privileges when running it.

  3. When UGS starts up, you will see this UI:

    Unreal Game Sync start up user interface

    • In the Server and User fields, enter your Perforce connection settings that you use for connecting through P4V.

    • Set the Depot Path to where your binaries for UGS are being stored on Perforce.

    • After you've confirmed that these fields match your Perforce credentials and the location of the UGS binaries, click Connect.

  1. After UGS successfully connects to your Perforce server, you will see the Getting Started menu. Click Open Project.

    Open a project in unreal game sync

  2. In the Open Project dialog box, click Browse and look for the Workspace you set up in step 1.

    After clicking Open Project you can safely follow the Workspace method detailed in the UGS Quick Start Guide to get your project open. If you'd like to use the Local File method instead, see the Local File section of the UGS Quick Start Guide. The steps are also described here with updated screenshots.

    Click Browse next to the Name field

    Select a workspace

    Depending on how the Workspace was set up, you may need to uncheck Only show workspaces for this computer in the bottom left to see your workspace.

  3. Now that you've selected your previously created workspace, click Browse next to the Path field, and select either a .uprojectdirs file (shown by enabling Show *.uprojectdirs files in the Select Project dialog), or a .uproject file from within one of the projects in that stream. For this example we'll be using a .uprojectidirs file, but you can just as easily select a .uproject file.

    Click Browse next to the Path field

    Select a project

    After this, the Path field will be filled in and you can click Ok to continue.

    Click OK

  4. Before proceeding to sync everything to your machine and build / run your project, review the UGS Sync Filter Setup documentation, to see if Sync Filters will help your workflow.

    Sync Filters are helpful for making sure that you're not syncing more data than you need. For example, if you have multiple large projects in the same stream, you can set up a filter to sync only the one you need to work on. These are very powerful, but they can lead to unintended consequences if they're too widely applied. Use them with care, and if in doubt, double check them with someone on your team that's comfortable with using sync filters.

  5. After opening your project, you will see the main menu, which is typically where you'll be working from day-to-day.

    For a full overview of this menu, refer to the UGS Menus Overview documentation.

    Sync to the latest changelist for your build either by double-clicking the top-most changelist in the Changelists area by clicking Sync Now in the Project Overview area.

    Select Latest in the Changelists area:

    Select the latest changelist

    Click Sync Now:

    Click Sync Now

    The options for To… that apply to what changelist Sync Now syncs are Latest, Latest Good, and Latest Starred which are the absolute latest, the latest approved, and latest manually marked builds, respectively.

  6. After your project is synchronized, you should be able to open the project in Visual Studio using the Visual Studio option in the Project Overview area, or open the project's Editor using the Unreal Editor option in the same area, if you're using precompiled binaries or you've built the Editor.

    You may be prompted to build the project if you haven't before when opening the Editor, and you're not using precompiled binaries.

    Open the project in Visual Studio or Unreal Editor

    You can make building, opening the Visual Studio project, and running the project happen automatically using the After syncing options at the bottom of the window.

    After syncing options

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey