Repository Instructions

Cloning Project Source Into Your Workspace

1. Go to the folder where you would like to download the repo, The repo will be downloaded to a new folder within that folder called REDACTED. Right click in an empty space, and click Git Bash here. This will open a new Git Bash window for your current folder.

2. Copy and paste one of these commands into Git Bash according to your team:

(CREATIVES) git -c filter.lfs.smudge= -c filter.lfs.process= -c filter.lfs.required=false clone --depth 1 -b promoted REDACTED && cd REDACTED && git-lfs pull

(PROGRAMMERS) git -c filter.lfs.smudge= -c filter.lfs.process= -c filter.lfs.required=false clone --depth 1 -b trunk REDACTED && cd REDACTED && git-lfs pull

Then continue from here:

1. Press enter.

2. A GitHub sign in prompt will appear. Login to GitHub to authenticate.

3. In the REDACTED folder, just double click UpdateProject.bat

to start our synchronization tool, PBSync. After PBSync sets up your git config & workspace, it will start downloading latest available engine build in your working branch. You should select where to download the engine if you get a prompt about that. As the next step, according to your team:

(CREATIVES) PBSync will also download required pre-compiled binaries for you.

(PROGRAMMERS) You need to compile project from the source manually after these steps.

1. If you face an error on one of those steps, error log will be written into pbsync_log.txt

2. Now that you've gotten your repo setup, move on to editor setup.