User Config Reference

This is a reference for the user configuration file, .user-sync by default in the root project directory, or .ci-sync for automated build machines.

Usage

.user-sync is a user-specific file that each user can create and should be ignored by Git. Some of these options, like download_dir and symbols, are controlled by PBSync with a guided process when downloading a custom engine. A sample config file:

[ue4v-user]
symbols = true
download_dir = C:\ue
source_dir = C:\src\ue

[project]
autosync = true
binaries = off
launch = none

.ci-sync is a global file that can define how options are defined in environment variables for CI. See example.

You can change the path of this file using PBSync.xml in the project/userconfig and project/ciconfig keys.

Entries

project

binaries

Default: on

• on: downloads binaries if current branch is expected_branch_name
• off: never downloads binaries
• build: like off, but also generates SLN and builds binaries every sync
• force: always downloads binaries

launch

Default: editor

What program to launch after syncing.

• editor: launches the Unreal Editor (if it is not open with the project already)
• vs: launches the SLN after syncing
• rider: launches the SLN in Rider IDE
• debug (not functional): launches the Unreal Editor with VS debugger
• none: don't launch anything

editor_args

If set, and launch is set to editor, then launch the Unreal Editor with the specified arguments, space separated.

bundle

Default: uev_default_bundle

The name of the engine bundle to download from cloud storage. If the bundle name contains "engine", game packaging support is required, while other bundles can be editor only.

autosync

Default: true

If the project repo should be synced even when the current branch is not expected_branch_name. Note: this is forced on if project.binaries is set to force.

version

Default: latest

If latest, download binaries for the project version in DefaultGame.ini. Otherwise, download binaries for the specified release tag.

ue4v-user

clean

Default: true

Clean old engine installations after installing a new engine.

download_dir

Default: none

The path to download and install the engine to. If not set, will ask to set upon engine download. If set to the location of a Git repo, PBSync will manage the engine as "source" mode, as treat the Git repo as the location of the UnrealEngine source repo.

source_dir

Default: none

The path to use as an engine source directory. This directory will be used as the download_dir in all cases except when explicitly using the --build source command, which will use the download_dir engine for editor binaries distribution.

symbols

Default: none

Whether to download engine symbols. If not set, will ask to set upon engine download.

paths

git

Default: git

The path to the git command

git-lfs

Default: git-lfs

The path to the git-lfs command

dispatch

app_id

Default: none

The Discord app ID to publish to

x_bid

Default: none

The Discord app branch ID to publish, keyed by the argument of --publish. Default key is internal_bid.