Creating a Unity project for making modules - mariusz-tang/KTaNE-Module-Template GitHub Wiki

There are two versions of the KTaNE ModKit: the Official ModKit, and the Community ModKit. The Official ModKit is no longer being maintained, so it's recommended that you use the Community ModKit, which has more features such as the plugin manager and the assembly forwarder, fixes a lot of bugs, and has other QoL improvements like the ability to use C#6, upgraded from C#4 in the Official ModKit.

This guide assumes that you are using the Community ModKit.

Creating your repository

From the Community ModKit GitHub page, click Use this template > Create a new repository, and give your repository a suitable name and description. You can decided to make your repository private if you wish, although I recommend you keep it public as this allows other people to help debug problems or even draw inspiration from your code!

Finally hit Create repository from template, leaving Include all branches unchecked.

Creating your repository

Next, you'll need to clone the repository onto your local machine. To do this, open GitHub Desktop, and click File > Clone repository..., then select your repository from under GitHub.com—you may need to refresh the list. Choose a suitable directory in which to store the repository (I recommend creating a directory specifically for KTaNE modules).

Hit Clone.

Cloning your repo

Opening the Unity project

In Unity Hub, click Open, then navigate to the repository directory and open it. Unity Hub will remember the project, so you won't have to do this in the future.

Opening the project

Setting your code editor

If you are doing this for the first time, you may need to configure Unity to use your preferred code editor. Simply go to Edit > Preferences > External Tools and set the External Script Editor field to your preferred editor. You may need to click Browse... if it is not already available.

Set text editor