GitHub Desktop to manage your project

Rate this Article:
5.00
(2 votes)

Approved for Versions:4.10 - 4.14

Approved for GitHub Desktop ( Windows ) Versions: 3.1.1.4 - 3.3.3.0

How to use GitHub Desktop to manage your Unreal Engine 4 project.

GitHub Desktop is a distributed revision control and source code management tool.

Note The current version of this tutorial was designed for an one-man band to keep it as simple as possible. For more advanced team orientated tutorials please have a look at the Version Control category.

Note GitHub.com currently does not support files larger than 100 MB.

Note If you create an UE4 C++ project with GitHub Desktop you need to add the files ending with *.VC.db to your ignore list in the These project files can be generated by the engine section. ( This has been reported to GitHub.com.)


1. Prerequirements

  • Unreal Engine 4

Free tools you need:

Free accounts you need:


2. GitHub Desktop


2.1. Repository

The next step depends on if you:

  • create a repository with GitHub Desktop or
  • create one online at GitHub.com or
  • already have an Unreal Engine 4 project

Note Advanced: The in-engine Git Source Control plugin is able to auto-create your Git repository from any project. Please have a look at the See Also section for more details.


2.1.1. Create New ( Desktop )

To create a new repository for your new ( not yet created ) Unreal Engine 4 project with GitHub Desktop do the following:

  • Open GitHub Desktop and click the + button on the upper left side and select the Create tab.

CreateNewGitHubProject2.JPG

  • Name the new project and select a path ( in this example it is: E:\2016\GitHub\MyUE4Project ) on your harddisc where you want to save it.
  • Select the Git ignore file for by setting it to UnrealEngine to ignore some files that are only needed on your local copy of your Unreal Engine 4 project you need to set up an Git ignore file. This will help to keep the project size small on the GitHub server.
  • Click Create repository.
  • Skip to the chapter Unreal Engine Project.

2.1.2. Create New ( Online )

To create a new repository for your new ( not yet created ) Unreal Engine 4 project online do the following:

  • Go to GitHub.com and log in your account.
  • Switch to the Repositories tab and click New.

RepositoryTabNew.JPG

  • Choose a Repository name and a Description.
  • Optional: Initialize this repository with a README and choose a license with Add a license:.
  • Click Add .gitignore: and select UnrealEngine to ignore some files that are only needed on your local copy of your Unreal Engine 4 project you need to set up an Git ignore file. This will help to keep the project size small on the GitHub server.
  • Click Create repository.

NewUE4ProjectWithIgnore.JPG

  • Open GitHub Desktop and click the + button on the upper left side and select the Clone tab.
  • Select your MyUE4Project repository.
  • Click Clone MyUE4Project.

CloneUE4Project.JPG

  • Select a folder where you want to save the repository and click OK.

CloneSelectFolder.JPG

  • The cloned project should look like this in GitHub Desktop:

CloneResult.JPG


2.1.3. Add Existing UE Project


3. Unreal Engine Project

  • Launch the Unreal Engine and create a New Project in the same directory on your harddisc where your GitHub repository is located. This is important that the .gitignore file works. In this example it looks like this:

NewUE4Project.JPG


4. GitHub Server

  • In the Changes tab of GitHub Desktop you can now see the files Unreal Engine has created.

SwitchToChanges.JPG

  • Add a Summary to the commit and optionally a Description. Then click Commit to master to commit your change in this project to the master branch on your harddisc.
  • To save a copy of this local project / repository to the GitHub server just click the Publish button on the upper right.

PublishToServer.JPG

  • Login with your GitHub account ( if you are not yet logged in ), add a Name and a Description and click Publish MyUE4Project. For future changes in this project this button will be named 69 Sync. Click it always when you want to synchronize your local data with the data located on the server.

PublishProject.JPG

  • Online at GitHub.com you should see something like this in your internet browser:

ProjectAtGitHub.JPG


5. Get Project

To download an existing project ( repository ) from GitHub just clone it to your harddisc.


6. Backup

Please note that GitHub is not a backup system. For your regular backups please use the Download ZIP button located online at the Code tab of your project's site at GitHub.com.

DownloadBackup.JPG

You can download any public project at GitHub.com like this without to use a Git client.


7. See Also