Installing and developing AoTTG2

This page is only intended for developers

Before continuing, assure that you have read:

• Getting Started
• Github Introduction
• You are part of the AoTTG2 development team on Github
• Please use the English language for your Visual Studio and Unity Editor, so other developers are able to assist you if needed
• Have installed Git LFS

Once you have done above, then let's get started.

Setting up your Visual Studio 2019

1. Open your Visual Studio Installer. If there is an update available, always update to the latest version.
2. Select "Modify" of your Visual Studio 2019
3. Select Individual components.

Assure that you have at least installed the following:

• .NET Framework 4.8 targeting pack
• Git
• Github Extension for Visual Studio
• Live Share
• Visual Studio Tools for Unity

4. Select "Modify", as this will install any of the missing components.

Useful Extensions

This is purely optional, but some recommendations:

• Discord RPC for Visual Studio
• ReSharper. Although this one is not free, it does increase your productivity a lot

Setting up Unity

1. Open Unity Hub
2. Click on Installs
3. Select your Unity VERSION installation, and select "Add Modules"
4. Assure that Mac Build Support is installed

Cloning AoTTG2 to your Visual Studio

1. Open Visual Studio, and select "Clone a repository" under the "Get Started" category.
2. Under repository location, enter: https://github.com/AoTTG-2/AoTTG-2.git
3. Choose a location where you want to have the project installed
4. Select "Clone"
5. After the cloning is done, assure that you are using the "AoTTG-2.sln"

Your Visual Studio will now clone the entire project. Once this is done, you have installed the AoTTG2 development environments correctly.

Creating and Switching to your issue branch in Visual Studio

By default, you are within the development branch. Because of various reasons, nobody has permissions to directly commit towards this branch, which is why we are using issue branches. Assure that you do git fetch (Team Explorer > Sync > Fetch) first!

Creating a new Issue Branch in Visual Studio

1. Open the Team Explorer (View > Team Explorer)
2. Select branches
3. Select "Create new branch"
4. Enter the issue branch name following the naming convention
5. Assure that you base this new branch off "origin/developement"!
6. Click on "Create Branch"

You have now created an issue branch. Don't forget to publish the branch!

Switching to another Issue Branch in Visual Studio

1. Open the Team Explorer (View > Team Explorer)
2. Select branches
3. Open the "remotes/origin" folder
4. Find the issue branch you are looking for, and double click on it

You have now switched to another issue branch.

Opening AoTTG2 in the Unity Editor

1. Open your Unity Hub
2. Select "Add"
3. Select the correct path to the project
4. Select unity VERSION

Now, open AoTTG2 in Unity by clicking on the newly added project from the Unity hub. It might take several minutes to load the project.

5. Select the AoTTG2.unity scene located inside the Assets folder.
6. Click on the Play button in the editor

If you followed all these steps correctly. Then you can now run AoTTG2 and start developing!