Modding Guide

Step 1

Install Unity

Download and install Unity 2022.3.62f2. The version must match exactly or your AssetBundles will not load.

When creating your project, select 2D (Built-in Render Pipeline) as the template.

Step 2

Install ThunderKit

ThunderKit lets your mod project reference the game's types and assemblies so you can create ScriptableObjects and write code mods.

1. In Unity, open Window > Package Manager
2. Click the + button (top-left) and choose Add package from git URL
3. Paste the following URL and click Add:

After ThunderKit installs, a settings window will appear:

1. Click Browse and select your Star Vortex.exe game executable
2. Click Import
3. When prompted to disable the Assembly Updater, click Restart
4. When prompted that import is complete, click Restart again

This imports all of the game's types into your project so you can create mod content.

Step 3

Import the Mod SDK

The StarVortexModSDK.unitypackage contains build tools, language templates, and full modding documentation. It is included with the game.

You can find it at:

To import it into your Unity project:

1. Open your mod project in Unity
2. Go to Assets > Import Package > Custom Package
3. Navigate to the path above and select the .unitypackage file
4. Click Import in the dialog that appears

The SDK includes a detailed MODDING_GUIDE.txt and README.txt with full field references for every item type, weapon type, and ScriptableObject in the game.

Step 4

Build Your Mod

Once your content is ready, use the menu items added by the SDK to build and package:

1. Star Vortex Mod > Build AssetBundles — compiles your assets
2. Star Vortex Mod > Generate Language File — creates translation strings
3. Star Vortex Mod > Package Mod — packages everything into a mod folder

Copy the resulting mod folder into the game's StarVortex_Data/Mods/ directory to test it locally.

Step 5

Publish to Steam Workshop

Star Vortex includes a Workshop Uploader tool for publishing your mod to the Steam Workshop. You can find it in the game's install directory:

Mods published to the Steam Workshop are automatically downloaded and loaded for anyone who subscribes.