This guide was made for IL2CPP version of Core Keeper and no longer applies. Please refer to: https://mod.io/g/corekeeper/r/core-keeper-mod-sdk-introduction
This guide provides step by step guide on how to setup your Unity project to create custom assets or view game assets
With the release of Quality of Love update devs have changed Unity version to 2021.3.14
and switched to Universal Rendering Pipeline. Both of these changes complicate Unity project setup.
With the release of the Desert update devs have changed Unity version to 2020.3.37
and also have refactored their assemblies. These changes will heavily break existing setups.
If you have setup Unity project before and there was Unity version update, I HIGHLY recommend to back it up, and start from scratch. After you setup the project from scratch you will need NG Tools Missing Script Recovery tool to fix scripts in your assets.
With release of the mono build of the game it is now possible to use ThunderKit to setup our Unity project.
Install Unity Hub from https://unity.com/download
Install Unity version 2021.3.14f1
from the Unity Download Archive: https://unity3d.com/get-unity/download/archive using Unity Hub
Go through the standard Unity installation and wait until it's done.
Make sure that you have git installed and it's executable is in your PATH environment variable. After installing git make sure to close Unity and Unity hub completely!
Install Core Keeper mono version
Create a new project from 2D Core template using Unity Hub. Wait until project is created and imported.
Now in the menu bar click on Window/Package Manager
. A window will appear. In the top left corner click install button, select add package from git URL
and paste in this link: https://github.com/kremnev8/ThunderKit.git#master
Wait for ThunderKit to be installed
In the menu bar go to Tools/ThunderKit/Packages
. Now install Core Keeper Import Extensions
package.
Once it is installed in the ThunderKit settings tab Import Configuration
. You should see a bunch of new importers.
In ThunderKit settings tab ThunderKit Settings
. Click on the Browse
button. Select the executable of your Mono Core Keeper. Now click on the Import
button
This step might take a while to complete. Once it's done, you will be asked to restart Unity, click Restart Project
At this point your project is functional. You can create custom assets and export them. Next steps are optional.
Download the latest version of AssetRipper from their GitHub repository at https://github.com/AssetRipper/AssetRipper. The name is pretty descriptive of what it does.
Extract the zipfile and open AssetRipper.exe.
Leave all the settings on default except for Script Export Format
and Script Content Level
, these should respectively be set to Dll Export Without Renaming
and Level 2
Then drag and drop your game folder (The whole folder called Core Keeper
) into AssetRipper.
Wait until AssetRipper is done loading the game content and then click on Export > Export all files
in the left upper corner, and select a temporary folder.
You should now have a folder with all the assets of the game.
In the extracted folder look for Assets
folder. From it you want every folder APART from Plugins
.
In your project Assets
folder create a folder to house these assets, for example Core Keeper
and move all files from exported Assets
there.
Now Unity will start to import these. This will take a while to complete.
There might be missing script references. This tool will help with the missing script references.
Previous version of this guide can be found here