HOW TO SET UP GITHUB FOR UNREAL ENGINE 4/5

Downloadable Version Here :

STEP 1: (ALL) APPLY FOR GITHUB STUDENT DEVELOPER PACK

1. On your web browser, create a GitHub account and apply for the Student Developer Pack.
   You will need access to your university email, to confirm you are a student. The email may
   be sent into spam or bin folder, it may take up to 10 minutes to receive the email.

2. Keep note of the email / Username of your GitHub account and send those details to your
   project Lead so they can add you to the repository.

STEP 2: (ALL) DOWNLOAD GITHUB DESKTOP

Download GitHub desktop for your respective platform, Windows or macOS.

STEP 3: (ALL EXCEPT PROJECT LEAD) CLONE THE REPO

1. Sign into GitHub Desktop using the details you used in Step 1.
2. Select “Clone a repository from the internet”.

3. Once you have added to the Repo by your Project lead, you should see the repositories name, select it.
4. Choose a space you would like to store the project repo, under “Local path” and by selecting “Choose button”.

5. Now Select “Clone” Button. Now the Repo is downloading, it may take a while!

STEP 4: (ALL) OPEN PROJECT USING UNREAL

1. Once the Repository has downloaded, locate the installation folder you selected in Step 3 : Part 4.
2. Right-click the “Unreal Engine project.exe” and create a shortcut.

3. Put that shortcut onto your desktop and open it.

STEP 5: (ALL) GITHUB DESKTOP BASICS

1. Any changes you make to the unreal project now, it will show under the “Changes Tab”. (It can be a very long list, if you do a lot).
2. Once you have added something to the project, In GitHub desktop add a “summary” Bottom
   left. Give a brief/ Easy to understand change you made. E.g. GunAssetAdded or
   RenderSettingChanged.
3. Adding a description is important, go into detail in what you added or changed. It’s
   important, especially if you change someone’s work so, they understand why it changed.
4. Commit to Main, once the summary/description have been added.
5. All members can now “Fetch to origin” This will download and apply your changes.
6. If you make a mistake in your update, you can roll back changes !
   Tip: Try creating/adding basic object into the world, communicate with members and experiment
   and get comfortable with GitHub before jumping in and starting your team project.

STEP 1: (PROJECT LEAD) CREATE UNREAL PROJECT

1. Make sure you all have the same version of Unreal Engine installed and communicate this to your team. E.g Unreal Engine 5.1.0. You can update the project to a newer version of the engine, at any time, but make a backup.
2. When creating the base project, select the type of project you want to create. E.g Blank or Third Person.
3. Select the project location on your local system.
4. Name the project.

STEP 2: (PROJECT LEAD) FIND THE PROJECT

1. Find the directory of the Unreal Project you would like to turn into a GitHub repo. Copy the address location of the repo.

STEP 3: (PROJECT LEAD) CREATING THE GITHUB REPO

1. Once GitHub desktop opens, select “Create a New Repository on your hard drive…”

STEP 4: (PROJECT LEAD) GITHUB REPO SETTINGS

1. Name for the Repo
2. Find the location of the project you created in step 1/2 and select the folder Dir.
   E.g : E:\UEProjectLocationHere
3. Git ignore, select “UnrealEngine”. This stops issues when pushing an update to the project.

STEP 5: (PROJECT LEAD) GIVING ACCESS TO THE REPO

1. Go to “https://github.com/” and select the new repo you created in step 4.
2. Select the “Settings” tab .
3. Then select the “Collaborators” tab

4. Once the Collaborators page has loaded, ask your team members for their GitHub Username or email.
5. Then Input their Username or email into the search bar query. They will have to confirm their invitation to the repo, by accepting an invitation email. From this page, you can see if they have confirmed their invitations or not.