Getting started

GitLab

We will be using GitLab.com to host all of our code and in-game assets. This means if you wish to contribute you will need an account.

Go to GitLab.com and sign up. Once signed up you will need to be added to the Team19 group on GitLab.

Contact @stewmcc to add you.

Once added have a look around GitLab Group Page, and the Team19 Project.

You will need to go back to this site to find the Git Repository link, the text in the box beside the copy button.

SourceTree

Setup

SourceTree is a really nice app for handling source control on the user’s end. It means you don’t need to write any commands into the command prompt. It shows everything visually making it much easier to use, and to describe how to use.

Go to SourceTreeApp.com and download SourceTree (requires window or mac) Setup an Atlassian account, this account is just to allow you to use SourceTree it is not very important but is needed. Once Installed you may have a screen similar to the Image below, make sure you install git.

We wont be using SSH keys, so cancel this.

Remotes will be setup later this step can be skipped.

Once you are into SourceTree go to Tools -> Options -> Git Tab, then Press "Update Embedded Git". as shown in the picture. This will ensure you have all the required software to pull from GitLab.

Clone Repository

Now to get the project from GitLab, click the Clone/new repository button, on the next screen the "Source Path" is the URL of the GitLab project we wish to download. Either go back to gitlab.com, open up the Team19 project and copy the repository address, or copy this address GitLab Repo. Once you press clone it will ask for your Username and password, this is your GitLab Details. This can sometimes take a while, wait till it is finished please.

Remember the destination path

You will need this later to point Unity at it.

Make your own branch

So far you have gained access to all of the branches in the repository, the Branches; master, develop and pages are special branches and you cannot work in these.

We need to create a new Branch to work in, but some precursor steps first. Open the Remotes section, and Origin sub-section, and double click master and develop, this will check-out these branches. Press the Git Flow button on SourceTree, use the default settings and press ok. This will ensure some settings are setup properly, this will be explained in much more detail in the Git Flow Section next.

The easiest way to make a new branch now is to press Git Flow button again and pick "Start New Feature". Give the feature a sensible name; level_loading, charactor_art,ui_art, etc. As long as it describes what you wish to do. Then press ok, this will create you a branch you can work on separate from everything else. We will discuss adding your changes to the repository in the next section Git Flow Section.

The feature name must follow the rules

  • All lower case no spaces, use underscore (_) to represent spaces if you want.
  • Must describe the purpose of the feature.
  • Short and brief.

Unity

Setup

Unity is very easy to use and very expandable hence we are using it. Go to Unity3d.com and download Unity 5.6.2f1, it will be version Locked at a later date. Install it following the on Screen instructions you will want to add the Android Support as we will be building for Android though this requires extra files and steps that will be covered later.

If you don't already have a Unity Account sign up for a free account. Unity is free but it does require an account, similar to SourceTree. Once everything is installed start up Unity, click open and go to where you put the repository and select the project folder, Unity will do the rest.

Now you have everything ready to play with the project, press file-> build & run, to see the current build. Play with Unity and familiarize yourself with Unity's UI, there is plenty of tutorials online. The next step is discussing Git Flow, and how you will add your changes back in to the repository.