Skip to content

ThunderKit Project Setup

Indigocoder1 edited this page Oct 24, 2024 · 7 revisions

ThunderKit is a powerful tool, but it can be tedious to set up.

Creating the Unity Project

The first thing you will need to do is download the Unity Hub and the version of Unity that Subnautica uses (Version 2019.4.36f).
If you already have Unity Hub installed you only need to download the correct version.

Unity hub: https://unity.com/download
Unity version archive: https://unity.com/releases/editor/archive

Once you've installed both, open the Unity hub and click "New Project" in the top right. This window will appear. Unity Hub create new project screen

You'll want to ensure your version is the correct one, and then select 3D Core from the templates list. Select a project name and location and then click "Create Project".
Unity will now open. This may take a while.

Installing ThunderKit

The next thing we’ll do is install ThunderKit. To do this, first go to Window → Package manager in Unity. Then, click the plus at the top left and select “Add package from git URL”. The URL you will want to use is this: https://github.com/PassivePicasso/ThunderKit.git

TK will now install, which may take some time. Once the installation is complete, a new window will pop up to configure your import settings.

Click on “ThunderKit settings”, and then click “Browse”. Then, navigate to your Subnautica folder and double click the .exe. ThunderKit import settings window

Once that is done, click “Import”. You will get a prompt asking if you want to disable the Automatic Assembly Updater. Select yes. You will also get a prompt asking to restart your project. You should select yes as leaving it open can cause errors.

Once the installation is complete, you will be prompted to restart your project again. This is recommended, but not required. You also may have noticed that the TK window pops up every time you open the project. To disable this, untick the “Show at Startup” option.
TK "Show on startup" setting

Possible Errors

You may have some errors in the console such as Unloading broken assembly ______, this assembly can cause crashes in the runtime. or Could not delete file Library/ScriptAssemblies/_____. You can ignore these files as they won’t actually break anything.
Various script errors in Unity

Removing Publicized Files

If you are using publicized game files, TK will automatically import them into Unity, and they should be deleted. This can be done by going to “Packages/Subnautica” in Unity and deleting the 2 publicized assembly files there. Publicized files image

And that's it! You've successfully set up ThunderKit. You can test it out to see if it's working by trying to add a component such as the ReaperLeviathan component to any GameObject in the scene. If it shows up in the available scripts, TK is working. If not, try restarting the Unity editor or go through these steps again.