Modding Guide

Star Vortex has first-party mod support. Create new content or patch game mechanics with code mods.

Step 1

Install Unity

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

https://unity.com/releases/editor/whats-new/2022.3.62

When creating your project, select the Universal 2D template. The game uses URP — do not pick the Built-in 2D template or the game's shaders will fail to render with no error (sprites appear invisible).

The game runs on URP 14.0.12. Unity 2022.3.62 LTS's Universal 2D template ships a compatible 14.0.x version by default; you can pin to 14.0.12 via Package Manager if you want exact parity.

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:
https://github.com/PassivePicasso/ThunderKit.git

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:

Star Vortex/StarVortex_Data/StreamingAssets/StarVortexModSDK.unitypackage

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

Import Game Content

The SDK can import every base game ScriptableObject into your project so you can browse, inspect, and duplicate them.

  1. Go to Star Vortex Mod > Import Game Content
  2. Point it at your Star Vortex installation folder
  3. All game data appears in Assets/GameContent/

You can now browse every item, squadron, star design, boss loadout, loot table, and more in the Unity Inspector with all values and cross-references intact.

Overriding existing content:

  1. Find the asset you want to change in Assets/GameContent/
  2. Select it and press Ctrl+D to duplicate
  3. Move the copy to your own mod folder
  4. Edit the copy — change any values you want
  5. Keep the same name and resourcePath as the original
  6. Assign it to your AssetBundle and build as normal

At runtime, your version replaces the original. This works for any ScriptableObject type.

Note: Prefab, sprite, material, and audio references appear as "Missing" in GameContent — this is normal. The game automatically inherits these from the base original at runtime. You only need to change the values you care about.
Step 5

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.

Note: Every mod folder must contain a mod.json manifest. The SDK template includes one — just update the fields with your mod's details.
Step 6

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:

Star Vortex/tools/WorkshopUploader/WorkshopUploader.exe

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

Note: You need to own Star Vortex on Steam and be logged in to upload Workshop content.