UE Source Control
We'll be using Unreal Engine's Source Control to handle checking out different files we're working on. This should prevent people working on the same files to avoid any merge conflicts!
Prerequisites
- Each member working in the project will need to set this up on their local machine
- Ensure that Git is installed on your system. If not, download and install it from Git's official website.
- Ensure you have access to the WinterJam repository
In the Unreal Editor, click on Source Control on the bottom-right of the editor and click on Connect to Source Control
In the prompt, select Git (beta version) as the Provider, confirm the Git Path points to the correct path, confirm the rest of the information is correct (specific to you). Finally, click on Accept Settings
You can adjust any Source Control settings in your Editor Preferences > Loading & Savings section
If you added a new file, you'll see a red plus in the top-right corner of the asset that will be added
You have the option to commit the file from the Unreal Editor at the bottom-right corner of the editor
You'll be prompted to add a description/commit message
Once you click Submit, you'll see a message that it was committed to your branch
You can confirm this by looking in the history in the GitHub Desktop UI > History
NOTE: You don't have to commit anything in the Unreal Editor if you prefer using the GitHub Desktop UI since this will still show up as a new file
You'll see a red checkmark in the top-right corner of the file if you've made any modifications to the file
You can either commit this change in the Unreal Editor or use the GitHub Desktop UI. Below is an example of the change in the GitHub Desktop UI
You can check to see what you've changed in the file by right-clicking on an asset and clicking on Diff Against Depot
The areas changed are in yellow text on the left. Selecting this will display the diff
You can also revert changes by right-clicking on the asset and selecting Source Control > Revert
This will open a prompt to select any files you want to revert
The asset should update by removing any status icons from the top-right corner
