Configuration Reference

Create a file named CliqueSync.xml in the same folder as CliqueSync.exe.

Sample: https://github.com/ProjectBorealis/PBCore/blob/main/PBSync.xml

git/version

Version string for git to enforce/download

Optional, defaults to any installed version of Git

git/lfsversion

Version string for git-lfs to enforce/download

Optional, defaults to any installed version of Git LFS

git/gcmversion

Version string for Git Credential Manager to enforce/download

Optional, defaults to any installed version of Git Credential Manager

git/expectedbranch

Your stable/main branches used by artists, that you wish to do most automatic sync by default. For us, this is promoted.

Defaults to main

git/url

The repository URL

Required for Git-based syncing workflows. Optional for other source control.

git/branches/branch...

Multiple nodes in git/branches to designate all status branches. Like so:

<git>
    <branches>
        <branch>trunk-dev</branch>
        <branch>trunk</branch>
        <branch>main</branch>
        <branch>promoted</branch>
    </branches>
</git>

Defaults to main

log/file

The path of CliqueSync's log.

Defaults to cliquesync_log.txt

project/userconfig

The path of CliqueSync's user config

Defaults to .user-sync

project/ciconfig

The path of CliqueSync's CI config

Defaults to .ci-sync

versionator/defaultbundle

The default engine "bundle" for custom engine builds. A bundle is a packaging setup for an engine, like a collection of specific plugins, build switches (maybe skipping packaging UnrealGame Test and Shipping configurations), alongside the base UnrealEditor.

Defaults to editor

versionator/cibundle

The default engine bundle when running on a CI machine. This allows you to ship an editor with UnrealGame support only to your build machines, to save space for users which do not need build functionality.

Defaults to engine.

project/uprojectname

The file name of your project. Ex: ProjectBorealis.uproject. This can also be a folder path that contains project folders containing a .uproject file. In this case, the user will be prompted to select the project they wish to launch. If empty, it will search the current folder and use the first project found.

Defaults to empty

project/packagepdbs

Whether to package PDBs or not for distribution

Defaults to false

project/repo_folder

What folder to search for tools in. If set to default, then this will be based upon your Git host. .github for GitHub, and .gitlab for GitLab. Tools if not using Git.

Defaults to "default"

project/enginebaseversion

The major engine version, like 5.7. Example full engine version: 5.7-IB-20251127.

Related: versionator/engineprefix

Required for engine syncing features

versionator/engineprefix

The prefix to add to your engine versions, we use IB. Example full engine version: 5.7-IB-20251127.

Related: project/enginebaseversion

Required for engine syncing features

versionator/enginetype

The type of engine, either ue5 or ue4

Defaults to ue5

versionator/versionedbranch

For source installs of the engine, if this is a versioned branch (like 5.8-PB, or 5.8-UE5), or part of a main stream (like pb-main, or ue5-main).

Defaults to True

versionator/cloud_storage

If you use cloud storage for extra features. Configure your URL for your bucket in .ueversionator (documented separately)

Can be one of the following values:

• gcs: Google Cloud Storage
• s3: AWS S3 compatible storage
• empty: does not use cloud storage

Defaults to empty

versionator/uses_longtail

If you use advanced Longtail storage mechanism for engine build distribution

Defaults to false

msg/git_instructions

What instructions to show regarding setting up Git

Defaults to https://github.com/ProjectBorealis/PBCore/wiki/Prerequisites

msg/support_channel

A description of a location like a chat channel or support ticket URL users can get support when CliqueSync encounters an issue or users may need guidance resolving conflicts

Defaults to "your support contact"

publish/publisher...

A multinode of all the publishers you wish to use to distribute builds of your game. Valid options:

• steamcmd for Steam
• butler for Itch

Defaults to empty

publish/stagedir

The directory where to find game builds for publishing

Defaults to Saved/StagedBuilds

dispatch/config

The dispatch.json location

Required for Dispatch usage

butler/project

The butler project to push to

Required for Butler usage

butler/manifest

The butler manifest file to use

Required for Butler usage

steamcmd/script

The app build vdf script to use

Required for steamcmd usage

steamcmd/drm/appid

The app ID to request DRM for your module

Required for steamcmd DRM usage

steamcmd/drm/targetbinary

The target binary to encode DRM for. Typically this is Saved/StagedBuilds/Windows/YOURPROJECT/Binaries/Win64/YOURPROJECT-Win64-Shipping.exe

Required for steamcmd DRM usage

steamcmd/drm/useonprem

Whether to use Valve's local DRM storage location instead of cloud. local DRM is slower but more reliable.

Defaults to False