Kerbal Space Program 2 Modding Wiki - User contributions [en]

Migrating from SpaceWarp 1.x

2025-12-05T15:46:47Z

Dandoesstuff: update

Note: It is seriously recommended you use this guide instead. https://docs.rendezvous.dev/s/0a4a3e31-0b40-48e0-bd81-e14856f80d3d/doc/spacewarp-1-2-migration-eGXoU487gH. This page was a WIP and isn't good either
Redux features a brand new version of SpaceWarp. While it's all shiny and cool, it breaks support with older versions. Now you're probably wondering: How do I migrate to SpaceWarp 2.x? This guide is for you.

'''<big>What's different?</big>'''

Since Redux has SpaceWarp built-in, there's no need to have BepInEx anymore. This means all mods get stored in a dedicated Mods folder in the main KSP2 directory called "mods"... and that you can't use BepInEx's stuff anymore.

The SpaceWarp namespace has been renamed to SpaceWarp2.

'''<big>API</big>'''

SpaceWarp2 now has following classes:

GeneralMod

MonoBehaviourMod

KerbalMod. (technically a Redux thing) It has access to useful game classes like Game, Assets, Messages, etc. Equivalent to BaseSpaceWarpPlugin. Found in Redux.ExtraModTypes

SpaceWarp2 also has a bunch of different members. Some of it has also been split up into ReduxLib and Redux.

SpaceWarp2.API.Configuration = ReduxLib.Configuration

SpaceWarp.API.UI.Appbar = SpaceWarp2.UI.API.Appbar

BepInExConfigFile = JsonConfigFile

'''<big>Example plugin before & after migration:</big>'''

Before:<syntaxhighlight lang="c#">
using System.Reflection;
using BepInEx;
using JetBrains.Annotations;
using SpaceWarp;
using SpaceWarp.API.Assets;
using SpaceWarp.API.Mods;
using SpaceWarp.API.UI.Appbar;
using SpaceWarpModUI.UI;
using UitkForKsp2.API;
using UnityEngine;
using UnityEngine.UIElements;

namespace SpaceWarpModUI;

[BepInPlugin(MyPluginInfo.PLUGIN_GUID, MyPluginInfo.PLUGIN_NAME, MyPluginInfo.PLUGIN_VERSION)]
[BepInDependency(SpaceWarpPlugin.ModGuid, SpaceWarpPlugin.ModVer)]
public class SpaceWarpModUIPlugin : BaseSpaceWarpPlugin
{
// Useful in case some other mod wants to use this mod a dependency
[PublicAPI] public const string ModGuid = MyPluginInfo.PLUGIN_GUID;
[PublicAPI] public const string ModName = MyPluginInfo.PLUGIN_NAME;
[PublicAPI] public const string ModVer = MyPluginInfo.PLUGIN_VERSION;

/// Singleton instance of the plugin class
[PublicAPI] public static SpaceWarpModUIPlugin Instance { get; set; }

// AppBar button IDs
internal const string ToolbarFlightButtonID = "BTN-SpaceWarpModUIFlight";
internal const string ToolbarOabButtonID = "BTN-SpaceWarpModUIOAB";
internal const string ToolbarKscButtonID = "BTN-SpaceWarpModUIKSC";

/// <summary>
/// Runs when the mod is first initialized.
/// </summary>
public override void OnInitialized()
{
base.OnInitialized();

Instance = this;

// Load all the other assemblies used by this mod
LoadAssemblies();

// Load the UI from the asset bundle
var myFirstWindowUxml = AssetManager.GetAsset<VisualTreeAsset>(
// The case-insensitive path to the asset in the bundle is composed of:
// - The mod GUID:
$"{ModGuid}/" +
// - The name of the asset bundle:
"SpaceWarpModUI_ui/" +
// - The path to the asset in your Unity project (without the "Assets/" part)
"ui/myfirstwindow/myfirstwindow.uxml"
);

// Create the window options object
var windowOptions = new WindowOptions
{
// The ID of the window. It should be unique to your mod.
WindowId = "SpaceWarpModUI_MyFirstWindow",
// The transform of parent game object of the window.
// If null, it will be created under the main canvas.
Parent = null,
// Whether or not the window can be hidden with F2.
IsHidingEnabled = true,
// Whether to disable game input when typing into text fields.
DisableGameInputForTextFields = true,
MoveOptions = new MoveOptions
{
// Whether or not the window can be moved by dragging.
IsMovingEnabled = true,
// Whether or not the window can only be moved within the screen bounds.
CheckScreenBounds = true
}
};

// Create the window
var myFirstWindow = Window.Create(windowOptions, myFirstWindowUxml);
// Add a controller for the UI to the window's game object
var myFirstWindowController = myFirstWindow.gameObject.AddComponent<MyFirstWindowController>();

// Register Flight AppBar button
Appbar.RegisterAppButton(
ModName,
ToolbarFlightButtonID,
AssetManager.GetAsset<Texture2D>($"{ModGuid}/images/icon.png"),
isOpen => myFirstWindowController.IsWindowOpen = isOpen
);

// Register OAB AppBar Button
Appbar.RegisterOABAppButton(
ModName,
ToolbarOabButtonID,
AssetManager.GetAsset<Texture2D>($"{ModGuid}/images/icon.png"),
isOpen => myFirstWindowController.IsWindowOpen = isOpen
);

// Register KSC AppBar Button
Appbar.RegisterKSCAppButton(
ModName,
ToolbarKscButtonID,
AssetManager.GetAsset<Texture2D>($"{ModGuid}/images/icon.png"),
() => myFirstWindowController.IsWindowOpen = !myFirstWindowController.IsWindowOpen
);
}

/// <summary>
/// Loads all the assemblies for the mod.
/// </summary>
private static void LoadAssemblies()
{
// Load the Unity project assembly
var currentFolder = new FileInfo(Assembly.GetExecutingAssembly().Location).Directory!.FullName;
var unityAssembly = Assembly.LoadFrom(Path.Combine(currentFolder, "SpaceWarpModUI.Unity.dll"));
// Register any custom UI controls from the loaded assembly
CustomControls.RegisterFromAssembly(unityAssembly);
}
}
</syntaxhighlight>After:<syntaxhighlight lang="c#">
using JetBrains.Annotations;
using Redux.ExtraModTypes;
using SpaceWarp2.UI.API.Appbar;
using SpaceWarpModUI.UI;
using UitkForKsp2.API;
using UnityEngine;
using UnityEngine.UIElements;

namespace SpaceWarpModUI;

public abstract class SpaceWarpModUIPlugin : KerbalMod
{
[PublicAPI] public const string ModGuid = "SpaceWarpModUI"; // ModGuid here
[PublicAPI] public const string ModName = "SpaceWarpUIMod";
//[PublicAPI] public const string ModVer = MyPluginInfo.PLUGIN_VERSION;

/// Singleton instance of the plugin class
[PublicAPI] public static SpaceWarpModUIPlugin Instance { get; set; }

// AppBar button IDs
internal const string ToolbarFlightButtonID = "BTN-SpaceWarpModUIFlight";
internal const string ToolbarOabButtonID = "BTN-SpaceWarpModUIOAB";
internal const string ToolbarKscButtonID = "BTN-SpaceWarpModUIKSC";

/// <summary>
/// Runs before the game is loaded, as early as possible.
/// You would want to use this to register loading actions (like loading JSONs from addressables).
/// </summary>

public override void OnPreInitialized()
{
Debug.Log("Pre Initialized");
}

/// <summary>
/// Runs after the game is loaded and after your mod assets are loaded.
/// </summary>

public override void OnInitialized()
{
Debug.Log("Is Initializing"); // You can use Debug.Log to log things.
Instance = this;

// Load the UI from the asset bundle
var myFirstWindowUxml = Assets.LoadAssetAsync<VisualTreeAsset>(
// The case-insensitive path to the asset in the bundle is composed of:
// - The mod GUID:
$"{ModGuid}/" +
// - The name of the asset bundle:
"SpaceWarpModUI_ui/" +
// - The path to the asset in your Unity project (without the "Assets/" part)
"ui/myfirstwindow/myfirstwindow.uxml"
).Result;

// Create the window options object
var windowOptions = new WindowOptions
{
// The ID of the window. It should be unique to your mod.
WindowId = "SpaceWarpModUI_MyFirstWindow",
// The transform of parent game object of the window.
// If null, it will be created under the main canvas.
Parent = null,
// Whether the window can be hidden with F2.
IsHidingEnabled = true,
// Whether the UI will use the "Scale" option in the settings.
UseStockScale = true,
// Whether to disable game input when typing into text fields.
DisableGameInputForTextFields = true,
MoveOptions = new MoveOptions
{
// Whether the window can be moved by dragging.
IsMovingEnabled = true,
// Whether the window can only be moved within the screen bounds.
CheckScreenBounds = true
}
};

// Create the window
var myFirstWindow = Window.Create(windowOptions, myFirstWindowUxml);
// Add a controller for the UI to the window's game object
var myFirstWindowController = myFirstWindow.gameObject.AddComponent<MyFirstWindowController>();

// Register Flight AppBar button
Appbar.RegisterAppButton(
ModName,
ToolbarFlightButtonID,
Assets.LoadAssetAsync<Texture2D>($"{ModGuid}/images/icon.png").Result,
isOpen => myFirstWindowController.IsWindowOpen = isOpen
);

// Register OAB AppBar Button
Appbar.RegisterOABAppButton(
ModName,
ToolbarOabButtonID,
Assets.LoadAssetAsync<Texture2D>($"{ModGuid}/images/icon.png").Result,
isOpen => myFirstWindowController.IsWindowOpen = isOpen
);

// Register KSC AppBar Button
Appbar.RegisterKSCAppButton(
ModName,
ToolbarKscButtonID,
Assets.LoadAssetAsync<Texture2D>($"{ModGuid}/images/icon.png").Result,
() => myFirstWindowController.IsWindowOpen = !myFirstWindowController.IsWindowOpen
);
}

/// <summary>
/// Runs after all mods have done their 2nd stage initialization.
/// You would want to use this to interact with game systems, since they're guaranteed to be loaded on this stage.
/// </summary>

public override void OnPostInitialized()
{
Debug.Log("Post Initialized");
}

// You can create controls directly in Unity. No need for this method anymore.
//private static void LoadAssemblies()
//{
// // Load the Unity project assembly
// var currentFolder = new FileInfo(Assembly.GetExecutingAssembly().Location).Directory!.FullName;
// var unityAssembly = Assembly.LoadFrom(Path.Combine(currentFolder, "SpaceWarpModUI.Unity.dll"));
// // Register any custom UI controls from the loaded assembly
// CustomControls.RegisterFromAssembly(unityAssembly);
//}
}
</syntaxhighlight>For more examples you can look at some of the "Reduxed" mods we've made for Redux here: https://github.com/orgs/KSP2Community/repositories?type=all

Migrating from SpaceWarp 1.x

2025-11-26T18:19:33Z

Dandoesstuff:

Redux features a brand new version of SpaceWarp. While it's all shiny and cool, it breaks support with older versions. Now you're probably wondering: How do I migrate to SpaceWarp 2.x? This guide is for you.

'''<big>What's different?</big>'''

Since Redux has SpaceWarp built-in, there's no need to have BepInEx anymore. This means all mods get stored in a dedicated Mods folder in the main KSP2 directory called "mods"... and that you can't use BepInEx's stuff anymore.

The SpaceWarp namespace has been renamed to SpaceWarp2.

'''<big>API</big>'''

SpaceWarp2 now has following classes:

GeneralMod

MonoBehaviourMod

KerbalMod. (technically a Redux thing) It has access to useful game classes like Game, Assets, Messages, etc. Equivalent to BaseSpaceWarpPlugin. Found in Redux.ExtraModTypes

SpaceWarp2 also has a bunch of different members. Some of it has also been split up into ReduxLib and Redux.

SpaceWarp2.API.Configuration = ReduxLib.Configuration

SpaceWarp.API.UI.Appbar = SpaceWarp2.UI.API.Appbar

BepInExConfigFile = JsonConfigFile

'''<big>Example plugin before & after migration:</big>'''

Before:<syntaxhighlight lang="c#">
using System.Reflection;
using BepInEx;
using JetBrains.Annotations;
using SpaceWarp;
using SpaceWarp.API.Assets;
using SpaceWarp.API.Mods;
using SpaceWarp.API.UI.Appbar;
using SpaceWarpModUI.UI;
using UitkForKsp2.API;
using UnityEngine;
using UnityEngine.UIElements;

namespace SpaceWarpModUI;

[BepInPlugin(MyPluginInfo.PLUGIN_GUID, MyPluginInfo.PLUGIN_NAME, MyPluginInfo.PLUGIN_VERSION)]
[BepInDependency(SpaceWarpPlugin.ModGuid, SpaceWarpPlugin.ModVer)]
public class SpaceWarpModUIPlugin : BaseSpaceWarpPlugin
{
// Useful in case some other mod wants to use this mod a dependency
[PublicAPI] public const string ModGuid = MyPluginInfo.PLUGIN_GUID;
[PublicAPI] public const string ModName = MyPluginInfo.PLUGIN_NAME;
[PublicAPI] public const string ModVer = MyPluginInfo.PLUGIN_VERSION;

/// Singleton instance of the plugin class
[PublicAPI] public static SpaceWarpModUIPlugin Instance { get; set; }

// AppBar button IDs
internal const string ToolbarFlightButtonID = "BTN-SpaceWarpModUIFlight";
internal const string ToolbarOabButtonID = "BTN-SpaceWarpModUIOAB";
internal const string ToolbarKscButtonID = "BTN-SpaceWarpModUIKSC";

/// <summary>
/// Runs when the mod is first initialized.
/// </summary>
public override void OnInitialized()
{
base.OnInitialized();

Instance = this;

// Load all the other assemblies used by this mod
LoadAssemblies();

// Load the UI from the asset bundle
var myFirstWindowUxml = AssetManager.GetAsset<VisualTreeAsset>(
// The case-insensitive path to the asset in the bundle is composed of:
// - The mod GUID:
$"{ModGuid}/" +
// - The name of the asset bundle:
"SpaceWarpModUI_ui/" +
// - The path to the asset in your Unity project (without the "Assets/" part)
"ui/myfirstwindow/myfirstwindow.uxml"
);

// Create the window options object
var windowOptions = new WindowOptions
{
// The ID of the window. It should be unique to your mod.
WindowId = "SpaceWarpModUI_MyFirstWindow",
// The transform of parent game object of the window.
// If null, it will be created under the main canvas.
Parent = null,
// Whether or not the window can be hidden with F2.
IsHidingEnabled = true,
// Whether to disable game input when typing into text fields.
DisableGameInputForTextFields = true,
MoveOptions = new MoveOptions
{
// Whether or not the window can be moved by dragging.
IsMovingEnabled = true,
// Whether or not the window can only be moved within the screen bounds.
CheckScreenBounds = true
}
};

// Create the window
var myFirstWindow = Window.Create(windowOptions, myFirstWindowUxml);
// Add a controller for the UI to the window's game object
var myFirstWindowController = myFirstWindow.gameObject.AddComponent<MyFirstWindowController>();

// Register Flight AppBar button
Appbar.RegisterAppButton(
ModName,
ToolbarFlightButtonID,
AssetManager.GetAsset<Texture2D>($"{ModGuid}/images/icon.png"),
isOpen => myFirstWindowController.IsWindowOpen = isOpen
);

// Register OAB AppBar Button
Appbar.RegisterOABAppButton(
ModName,
ToolbarOabButtonID,
AssetManager.GetAsset<Texture2D>($"{ModGuid}/images/icon.png"),
isOpen => myFirstWindowController.IsWindowOpen = isOpen
);

// Register KSC AppBar Button
Appbar.RegisterKSCAppButton(
ModName,
ToolbarKscButtonID,
AssetManager.GetAsset<Texture2D>($"{ModGuid}/images/icon.png"),
() => myFirstWindowController.IsWindowOpen = !myFirstWindowController.IsWindowOpen
);
}

/// <summary>
/// Loads all the assemblies for the mod.
/// </summary>
private static void LoadAssemblies()
{
// Load the Unity project assembly
var currentFolder = new FileInfo(Assembly.GetExecutingAssembly().Location).Directory!.FullName;
var unityAssembly = Assembly.LoadFrom(Path.Combine(currentFolder, "SpaceWarpModUI.Unity.dll"));
// Register any custom UI controls from the loaded assembly
CustomControls.RegisterFromAssembly(unityAssembly);
}
}
</syntaxhighlight>After:<syntaxhighlight lang="c#">
using JetBrains.Annotations;
using Redux.ExtraModTypes;
using SpaceWarp2.UI.API.Appbar;
using SpaceWarpModUI.UI;
using UitkForKsp2.API;
using UnityEngine;
using UnityEngine.UIElements;

namespace SpaceWarpModUI;

public abstract class SpaceWarpModUIPlugin : KerbalMod
{
[PublicAPI] public const string ModGuid = "SpaceWarpModUI"; // ModGuid here
[PublicAPI] public const string ModName = "SpaceWarpUIMod";
//[PublicAPI] public const string ModVer = MyPluginInfo.PLUGIN_VERSION;

/// Singleton instance of the plugin class
[PublicAPI] public static SpaceWarpModUIPlugin Instance { get; set; }

// AppBar button IDs
internal const string ToolbarFlightButtonID = "BTN-SpaceWarpModUIFlight";
internal const string ToolbarOabButtonID = "BTN-SpaceWarpModUIOAB";
internal const string ToolbarKscButtonID = "BTN-SpaceWarpModUIKSC";

/// <summary>
/// Runs before the game is loaded, as early as possible.
/// You would want to use this to register loading actions (like loading JSONs from addressables).
/// </summary>

public override void OnPreInitialized()
{
Debug.Log("Pre Initialized");
}

/// <summary>
/// Runs after the game is loaded and after your mod assets are loaded.
/// </summary>

public override void OnInitialized()
{
Debug.Log("Is Initializing"); // You can use Debug.Log to log things.
Instance = this;

// Load the UI from the asset bundle
var myFirstWindowUxml = Assets.LoadAssetAsync<VisualTreeAsset>(
// The case-insensitive path to the asset in the bundle is composed of:
// - The mod GUID:
$"{ModGuid}/" +
// - The name of the asset bundle:
"SpaceWarpModUI_ui/" +
// - The path to the asset in your Unity project (without the "Assets/" part)
"ui/myfirstwindow/myfirstwindow.uxml"
).Result;

// Create the window options object
var windowOptions = new WindowOptions
{
// The ID of the window. It should be unique to your mod.
WindowId = "SpaceWarpModUI_MyFirstWindow",
// The transform of parent game object of the window.
// If null, it will be created under the main canvas.
Parent = null,
// Whether the window can be hidden with F2.
IsHidingEnabled = true,
// Whether the UI will use the "Scale" option in the settings.
UseStockScale = true,
// Whether to disable game input when typing into text fields.
DisableGameInputForTextFields = true,
MoveOptions = new MoveOptions
{
// Whether the window can be moved by dragging.
IsMovingEnabled = true,
// Whether the window can only be moved within the screen bounds.
CheckScreenBounds = true
}
};

// Create the window
var myFirstWindow = Window.Create(windowOptions, myFirstWindowUxml);
// Add a controller for the UI to the window's game object
var myFirstWindowController = myFirstWindow.gameObject.AddComponent<MyFirstWindowController>();

// Register Flight AppBar button
Appbar.RegisterAppButton(
ModName,
ToolbarFlightButtonID,
Assets.LoadAssetAsync<Texture2D>($"{ModGuid}/images/icon.png").Result,
isOpen => myFirstWindowController.IsWindowOpen = isOpen
);

// Register OAB AppBar Button
Appbar.RegisterOABAppButton(
ModName,
ToolbarOabButtonID,
Assets.LoadAssetAsync<Texture2D>($"{ModGuid}/images/icon.png").Result,
isOpen => myFirstWindowController.IsWindowOpen = isOpen
);

// Register KSC AppBar Button
Appbar.RegisterKSCAppButton(
ModName,
ToolbarKscButtonID,
Assets.LoadAssetAsync<Texture2D>($"{ModGuid}/images/icon.png").Result,
() => myFirstWindowController.IsWindowOpen = !myFirstWindowController.IsWindowOpen
);
}

/// <summary>
/// Runs after all mods have done their 2nd stage initialization.
/// You would want to use this to interact with game systems, since they're guaranteed to be loaded on this stage.
/// </summary>

public override void OnPostInitialized()
{
Debug.Log("Post Initialized");
}

// You can create controls directly in Unity. No need for this method anymore.
//private static void LoadAssemblies()
//{
// // Load the Unity project assembly
// var currentFolder = new FileInfo(Assembly.GetExecutingAssembly().Location).Directory!.FullName;
// var unityAssembly = Assembly.LoadFrom(Path.Combine(currentFolder, "SpaceWarpModUI.Unity.dll"));
// // Register any custom UI controls from the loaded assembly
// CustomControls.RegisterFromAssembly(unityAssembly);
//}
}
</syntaxhighlight>For more examples you can look at some of the "Reduxed" mods we've made for Redux here: https://github.com/orgs/KSP2Community/repositories?type=all

Migrating from SpaceWarp 1.x

2025-11-22T20:38:09Z

Dandoesstuff: remove my confusion in the after code

Redux features a brand new version of SpaceWarp. While it's all shiny and cool, it breaks support with older versions. Now you're probably wondering: How do I migrate to SpaceWarp 2.x? This guide is for you.

'''<big>What's different?</big>'''

Since Redux has SpaceWarp built-in, there's no need to have BepInEx anymore. This means all mods get stored in a dedicated Mods folder in the main KSP2 directory called "mods"... and that you can't use BepInEx's stuff anymore.

The SpaceWarp namespace has been renamed to SpaceWarp2.

'''<big>API</big>'''

SpaceWarp2 now has following classes:

GeneralMod

MonoBehaviourMod

KerbalMod. (technically a Redux thing) It has access to useful game classes like Game, Assets, Messages, etc. Equivalent to BaseSpaceWarpPlugin. Found in Redux.ExtraModTypes

SpaceWarp2 also has a bunch of different members. Some of it has also been split up into ReduxLib and Redux.

SpaceWarp2.API.Configuration = ReduxLib.Configuration

SpaceWarp.API.UI.Appbar = SpaceWarp2.UI.API.Appbar

BepInExConfigFile = JsonConfigFile

'''<big>Example plugin before & after migration:</big>'''

Before:<syntaxhighlight lang="c#">
using System.Reflection;
using BepInEx;
using JetBrains.Annotations;
using SpaceWarp;
using SpaceWarp.API.Assets;
using SpaceWarp.API.Mods;
using SpaceWarp.API.UI.Appbar;
using SpaceWarpModUI.UI;
using UitkForKsp2.API;
using UnityEngine;
using UnityEngine.UIElements;

namespace SpaceWarpModUI;

[BepInPlugin(MyPluginInfo.PLUGIN_GUID, MyPluginInfo.PLUGIN_NAME, MyPluginInfo.PLUGIN_VERSION)]
[BepInDependency(SpaceWarpPlugin.ModGuid, SpaceWarpPlugin.ModVer)]
public class SpaceWarpModUIPlugin : BaseSpaceWarpPlugin
{
// Useful in case some other mod wants to use this mod a dependency
[PublicAPI] public const string ModGuid = MyPluginInfo.PLUGIN_GUID;
[PublicAPI] public const string ModName = MyPluginInfo.PLUGIN_NAME;
[PublicAPI] public const string ModVer = MyPluginInfo.PLUGIN_VERSION;

/// Singleton instance of the plugin class
[PublicAPI] public static SpaceWarpModUIPlugin Instance { get; set; }

// AppBar button IDs
internal const string ToolbarFlightButtonID = "BTN-SpaceWarpModUIFlight";
internal const string ToolbarOabButtonID = "BTN-SpaceWarpModUIOAB";
internal const string ToolbarKscButtonID = "BTN-SpaceWarpModUIKSC";

/// <summary>
/// Runs when the mod is first initialized.
/// </summary>
public override void OnInitialized()
{
base.OnInitialized();

Instance = this;

// Load all the other assemblies used by this mod
LoadAssemblies();

// Load the UI from the asset bundle
var myFirstWindowUxml = AssetManager.GetAsset<VisualTreeAsset>(
// The case-insensitive path to the asset in the bundle is composed of:
// - The mod GUID:
$"{ModGuid}/" +
// - The name of the asset bundle:
"SpaceWarpModUI_ui/" +
// - The path to the asset in your Unity project (without the "Assets/" part)
"ui/myfirstwindow/myfirstwindow.uxml"
);

// Create the window options object
var windowOptions = new WindowOptions
{
// The ID of the window. It should be unique to your mod.
WindowId = "SpaceWarpModUI_MyFirstWindow",
// The transform of parent game object of the window.
// If null, it will be created under the main canvas.
Parent = null,
// Whether or not the window can be hidden with F2.
IsHidingEnabled = true,
// Whether to disable game input when typing into text fields.
DisableGameInputForTextFields = true,
MoveOptions = new MoveOptions
{
// Whether or not the window can be moved by dragging.
IsMovingEnabled = true,
// Whether or not the window can only be moved within the screen bounds.
CheckScreenBounds = true
}
};

// Create the window
var myFirstWindow = Window.Create(windowOptions, myFirstWindowUxml);
// Add a controller for the UI to the window's game object
var myFirstWindowController = myFirstWindow.gameObject.AddComponent<MyFirstWindowController>();

// Register Flight AppBar button
Appbar.RegisterAppButton(
ModName,
ToolbarFlightButtonID,
AssetManager.GetAsset<Texture2D>($"{ModGuid}/images/icon.png"),
isOpen => myFirstWindowController.IsWindowOpen = isOpen
);

// Register OAB AppBar Button
Appbar.RegisterOABAppButton(
ModName,
ToolbarOabButtonID,
AssetManager.GetAsset<Texture2D>($"{ModGuid}/images/icon.png"),
isOpen => myFirstWindowController.IsWindowOpen = isOpen
);

// Register KSC AppBar Button
Appbar.RegisterKSCAppButton(
ModName,
ToolbarKscButtonID,
AssetManager.GetAsset<Texture2D>($"{ModGuid}/images/icon.png"),
() => myFirstWindowController.IsWindowOpen = !myFirstWindowController.IsWindowOpen
);
}

/// <summary>
/// Loads all the assemblies for the mod.
/// </summary>
private static void LoadAssemblies()
{
// Load the Unity project assembly
var currentFolder = new FileInfo(Assembly.GetExecutingAssembly().Location).Directory!.FullName;
var unityAssembly = Assembly.LoadFrom(Path.Combine(currentFolder, "SpaceWarpModUI.Unity.dll"));
// Register any custom UI controls from the loaded assembly
CustomControls.RegisterFromAssembly(unityAssembly);
}
}
</syntaxhighlight>After:<syntaxhighlight lang="c#">
using JetBrains.Annotations;
using Redux.ExtraModTypes;
using SpaceWarp2.UI.API.Appbar;
using SpaceWarpModUI.UI;
using UitkForKsp2.API;
using UnityEngine;
using UnityEngine.UIElements;

namespace SpaceWarpModUI;

public abstract class SpaceWarpModUIPlugin : KerbalMod
{
[PublicAPI] public const string ModGuid = "SpaceWarpModUI"; // ModGuid here
[PublicAPI] public const string ModName = "SpaceWarpUIMod";
//[PublicAPI] public const string ModVer = MyPluginInfo.PLUGIN_VERSION;

/// Singleton instance of the plugin class
[PublicAPI] public static SpaceWarpModUIPlugin Instance { get; set; }

// AppBar button IDs
internal const string ToolbarFlightButtonID = "BTN-SpaceWarpModUIFlight";
internal const string ToolbarOabButtonID = "BTN-SpaceWarpModUIOAB";
internal const string ToolbarKscButtonID = "BTN-SpaceWarpModUIKSC";

/// <summary>
/// Runs before the game is loaded, as early as possible.
/// </summary>

public override void OnPreInitialized()
{
Debug.Log("Pre Initialized");
}

/// <summary>
/// Runs after the game is loaded and after your mod assets are loaded.
/// </summary>

public override void OnInitialized()
{
Debug.Log("Is Initializing"); // You can use Debug.Log to log things.
Instance = this;

// Load the UI from the asset bundle
var myFirstWindowUxml = Assets.LoadAssetAsync<VisualTreeAsset>(
// The case-insensitive path to the asset in the bundle is composed of:
// - The mod GUID:
$"{ModGuid}/" +
// - The name of the asset bundle:
"SpaceWarpModUI_ui/" +
// - The path to the asset in your Unity project (without the "Assets/" part)
"ui/myfirstwindow/myfirstwindow.uxml"
).Result;

// Create the window options object
var windowOptions = new WindowOptions
{
// The ID of the window. It should be unique to your mod.
WindowId = "SpaceWarpModUI_MyFirstWindow",
// The transform of parent game object of the window.
// If null, it will be created under the main canvas.
Parent = null,
// Whether the window can be hidden with F2.
IsHidingEnabled = true,
// Whether the UI will use the "Scale" option in the settings.
UseStockScale = true,
// Whether to disable game input when typing into text fields.
DisableGameInputForTextFields = true,
MoveOptions = new MoveOptions
{
// Whether the window can be moved by dragging.
IsMovingEnabled = true,
// Whether the window can only be moved within the screen bounds.
CheckScreenBounds = true
}
};

// Create the window
var myFirstWindow = Window.Create(windowOptions, myFirstWindowUxml);
// Add a controller for the UI to the window's game object
var myFirstWindowController = myFirstWindow.gameObject.AddComponent<MyFirstWindowController>();

// Register Flight AppBar button
Appbar.RegisterAppButton(
ModName,
ToolbarFlightButtonID,
Assets.LoadAssetAsync<Texture2D>($"{ModGuid}/images/icon.png").Result,
isOpen => myFirstWindowController.IsWindowOpen = isOpen
);

// Register OAB AppBar Button
Appbar.RegisterOABAppButton(
ModName,
ToolbarOabButtonID,
Assets.LoadAssetAsync<Texture2D>($"{ModGuid}/images/icon.png").Result,
isOpen => myFirstWindowController.IsWindowOpen = isOpen
);

// Register KSC AppBar Button
Appbar.RegisterKSCAppButton(
ModName,
ToolbarKscButtonID,
Assets.LoadAssetAsync<Texture2D>($"{ModGuid}/images/icon.png").Result,
() => myFirstWindowController.IsWindowOpen = !myFirstWindowController.IsWindowOpen
);
}

/// <summary>
/// Runs after all mods have done their 2nd stage initialization.
/// </summary>

public override void OnPostInitialized()
{
Debug.Log("Post Initialized");
}

// You can create controls directly in Unity. No need for this method anymore.
//private static void LoadAssemblies()
//{
// // Load the Unity project assembly
// var currentFolder = new FileInfo(Assembly.GetExecutingAssembly().Location).Directory!.FullName;
// var unityAssembly = Assembly.LoadFrom(Path.Combine(currentFolder, "SpaceWarpModUI.Unity.dll"));
// // Register any custom UI controls from the loaded assembly
// CustomControls.RegisterFromAssembly(unityAssembly);
//}
}
</syntaxhighlight>For more examples you can look at some of the "Reduxed" mods we've made for Redux here: https://github.com/orgs/KSP2Community/repositories?type=all

Migrating from SpaceWarp 1.x

2025-11-22T14:40:24Z

Dandoesstuff: Make code make more sense and add a more explanations. Will add examples for configs

Redux features a brand new version of SpaceWarp. While it's all shiny and cool, it breaks support with older versions. Now you're probably wondering: How do I migrate to SpaceWarp 2.x? This guide is for you.

'''<big>What's different?</big>'''

Since Redux has SpaceWarp built-in, there's no need to have BepInEx anymore. This means all mods get stored in a dedicated Mods folder in the main KSP2 directory called "mods"... and that you can't use BepInEx's stuff anymore.

The SpaceWarp namespace has been renamed to SpaceWarp2.

'''<big>API</big>'''

SpaceWarp2 now has following classes:

GeneralMod

MonoBehaviourMod

KerbalMod. (technically a Redux thing) It has access to useful game classes like Game, Assets, Messages, etc. Equivalent to BaseSpaceWarpPlugin. Found in Redux.ExtraModTypes

SpaceWarp2 also has a bunch of different members. Some of it has also been split up into ReduxLib and Redux.

SpaceWarp2.API.Configuration = ReduxLib.Configuration

SpaceWarp.API.UI.Appbar = SpaceWarp2.UI.API.Appbar

BepInExConfigFile = JsonConfigFile

'''<big>Example plugin before & after migration:</big>'''

Before:<syntaxhighlight lang="c#">
using System.Reflection;
using BepInEx;
using JetBrains.Annotations;
using SpaceWarp;
using SpaceWarp.API.Assets;
using SpaceWarp.API.Mods;
using SpaceWarp.API.UI.Appbar;
using SpaceWarpModUI.UI;
using UitkForKsp2.API;
using UnityEngine;
using UnityEngine.UIElements;

namespace SpaceWarpModUI;

[BepInPlugin(MyPluginInfo.PLUGIN_GUID, MyPluginInfo.PLUGIN_NAME, MyPluginInfo.PLUGIN_VERSION)]
[BepInDependency(SpaceWarpPlugin.ModGuid, SpaceWarpPlugin.ModVer)]
public class SpaceWarpModUIPlugin : BaseSpaceWarpPlugin
{
// Useful in case some other mod wants to use this mod a dependency
[PublicAPI] public const string ModGuid = MyPluginInfo.PLUGIN_GUID;
[PublicAPI] public const string ModName = MyPluginInfo.PLUGIN_NAME;
[PublicAPI] public const string ModVer = MyPluginInfo.PLUGIN_VERSION;

/// Singleton instance of the plugin class
[PublicAPI] public static SpaceWarpModUIPlugin Instance { get; set; }

// AppBar button IDs
internal const string ToolbarFlightButtonID = "BTN-SpaceWarpModUIFlight";
internal const string ToolbarOabButtonID = "BTN-SpaceWarpModUIOAB";
internal const string ToolbarKscButtonID = "BTN-SpaceWarpModUIKSC";

/// <summary>
/// Runs when the mod is first initialized.
/// </summary>
public override void OnInitialized()
{
base.OnInitialized();

Instance = this;

// Load all the other assemblies used by this mod
LoadAssemblies();

// Load the UI from the asset bundle
var myFirstWindowUxml = AssetManager.GetAsset<VisualTreeAsset>(
// The case-insensitive path to the asset in the bundle is composed of:
// - The mod GUID:
$"{ModGuid}/" +
// - The name of the asset bundle:
"SpaceWarpModUI_ui/" +
// - The path to the asset in your Unity project (without the "Assets/" part)
"ui/myfirstwindow/myfirstwindow.uxml"
);

// Create the window options object
var windowOptions = new WindowOptions
{
// The ID of the window. It should be unique to your mod.
WindowId = "SpaceWarpModUI_MyFirstWindow",
// The transform of parent game object of the window.
// If null, it will be created under the main canvas.
Parent = null,
// Whether or not the window can be hidden with F2.
IsHidingEnabled = true,
// Whether to disable game input when typing into text fields.
DisableGameInputForTextFields = true,
MoveOptions = new MoveOptions
{
// Whether or not the window can be moved by dragging.
IsMovingEnabled = true,
// Whether or not the window can only be moved within the screen bounds.
CheckScreenBounds = true
}
};

// Create the window
var myFirstWindow = Window.Create(windowOptions, myFirstWindowUxml);
// Add a controller for the UI to the window's game object
var myFirstWindowController = myFirstWindow.gameObject.AddComponent<MyFirstWindowController>();

// Register Flight AppBar button
Appbar.RegisterAppButton(
ModName,
ToolbarFlightButtonID,
AssetManager.GetAsset<Texture2D>($"{ModGuid}/images/icon.png"),
isOpen => myFirstWindowController.IsWindowOpen = isOpen
);

// Register OAB AppBar Button
Appbar.RegisterOABAppButton(
ModName,
ToolbarOabButtonID,
AssetManager.GetAsset<Texture2D>($"{ModGuid}/images/icon.png"),
isOpen => myFirstWindowController.IsWindowOpen = isOpen
);

// Register KSC AppBar Button
Appbar.RegisterKSCAppButton(
ModName,
ToolbarKscButtonID,
AssetManager.GetAsset<Texture2D>($"{ModGuid}/images/icon.png"),
() => myFirstWindowController.IsWindowOpen = !myFirstWindowController.IsWindowOpen
);
}

/// <summary>
/// Loads all the assemblies for the mod.
/// </summary>
private static void LoadAssemblies()
{
// Load the Unity project assembly
var currentFolder = new FileInfo(Assembly.GetExecutingAssembly().Location).Directory!.FullName;
var unityAssembly = Assembly.LoadFrom(Path.Combine(currentFolder, "SpaceWarpModUI.Unity.dll"));
// Register any custom UI controls from the loaded assembly
CustomControls.RegisterFromAssembly(unityAssembly);
}
}
</syntaxhighlight>After:<syntaxhighlight lang="c#">
using JetBrains.Annotations;
using Redux.ExtraModTypes;
using SpaceWarp2.UI.API.Appbar;
using SpaceWarpModUI.UI;
using UitkForKsp2.API;
using UnityEngine;
using UnityEngine.UIElements;

namespace SpaceWarpModUI;

public abstract class SpaceWarpModUIPlugin : KerbalMod
{
[PublicAPI] public const string ModGuid = "SpaceWarpModUI"; // ModGuid here
[PublicAPI] public const string ModName = "SpaceWarpUIMod";
//[PublicAPI] public const string ModVer = MyPluginInfo.PLUGIN_VERSION;

/// Singleton instance of the plugin class
[PublicAPI] public static SpaceWarpModUIPlugin Instance { get; set; }

// AppBar button IDs
internal const string ToolbarFlightButtonID = "BTN-SpaceWarpModUIFlight";
internal const string ToolbarOabButtonID = "BTN-SpaceWarpModUIOAB";
internal const string ToolbarKscButtonID = "BTN-SpaceWarpModUIKSC";

/// <summary>
/// Runs before the game is loaded, as early as possible.
/// </summary>

public override void OnPreInitialized()
{
Debug.Log("Pre Initialized");
}

/// <summary>
/// Runs after the game is loaded and after your mod assets are loaded.
/// </summary>

public override void OnInitialized()
{
Debug.Log("Is Initializing"); // You can use Debug.Log to log things.
Instance = this;

// Load the UI from the asset bundle
var myFirstWindowUxml = Assets.LoadAssetAsync<VisualTreeAsset>(
// The case-insensitive path to the asset in the bundle is composed of:
// - The mod GUID:
$"{ModGuid}/" +
// - The name of the asset bundle:
"SpaceWarpModUI_ui/" +
// - The path to the asset in your Unity project (without the "Assets/" part)
"ui/myfirstwindow/myfirstwindow.uxml"
).Result;

// Create the window options object
var windowOptions = new WindowOptions
{
// The ID of the window. It should be unique to your mod.
WindowId = "SpaceWarpModUI_MyFirstWindow",
// The transform of parent game object of the window.
// If null, it will be created under the main canvas.
Parent = null,
// Whether the window can be hidden with F2.
IsHidingEnabled = true,
// Whether the UI will use the "Scale" option in the settings.
UseStockScale = true,
// Whether to disable game input when typing into text fields.
DisableGameInputForTextFields = true,
MoveOptions = new MoveOptions
{
// Whether the window can be moved by dragging.
IsMovingEnabled = true,
// Whether the window can only be moved within the screen bounds.
CheckScreenBounds = true
}
};

// Create the window
var myFirstWindow = Window.Create(windowOptions, myFirstWindowUxml);
// Add a controller for the UI to the window's game object
var myFirstWindowController = myFirstWindow.gameObject.AddComponent<MyFirstWindowController>();

// Register Flight AppBar button
Appbar.RegisterAppButton(
ModName,
ToolbarFlightButtonID,
Assets.LoadAssetAsync<Texture2D>($"{ModGuid}/images/icon.png").Result,
isOpen => myFirstWindowController.IsWindowOpen = isOpen
);

// Register OAB AppBar Button
Appbar.RegisterOABAppButton(
ModName,
ToolbarOabButtonID,
Assets.LoadAssetAsync<Texture2D>($"{ModGuid}/images/icon.png").Result,
isOpen => myFirstWindowController.IsWindowOpen = isOpen
);

// Register KSC AppBar Button
Appbar.RegisterKSCAppButton(
ModName,
ToolbarKscButtonID,
Assets.LoadAssetAsync<Texture2D>($"{ModGuid}/images/icon.png").Result,
() => myFirstWindowController.IsWindowOpen = !myFirstWindowController.IsWindowOpen
);
}

/// <summary>
/// Runs after all mods have done their 2nd stage initialization.
/// </summary>

public override void OnPostInitialized()
{
Debug.Log("Post Initialized");
}

// You can create controls directly in Unity. No need for this method anymore.
//private static void LoadAssemblies()
//{
// // Load the Unity project assembly
// var currentFolder = new FileInfo(Assembly.GetExecutingAssembly().Location).Directory!.FullName;
// var unityAssembly = Assembly.LoadFrom(Path.Combine(currentFolder, "SpaceWarpModUI.Unity.dll"));
// // Register any custom UI controls from the loaded assembly
// CustomControls.RegisterFromAssembly(unityAssembly); //??
//}
}
</syntaxhighlight>For more examples you can look at some of the "Reduxed" mods we've made for Redux here: https://github.com/orgs/KSP2Community/repositories?type=all

Migrating from SpaceWarp 1.x

2025-11-20T20:17:29Z

Dandoesstuff:

Redux features a brand new version of SpaceWarp. While it's all shiny and cool, it breaks support with older versions. Now you're probably wondering: How do I migrate to SpaceWarp 2.x? This guide is for you.

'''<big>What's different?</big>'''

Since Redux has SpaceWarp built-in, there's no need to have BepInEx anymore. This means all mods get stored in a dedicated Mods folder in the main KSP2 directory called "mods"... and that you can't use BepInEx's stuff anymore.

The SpaceWarp namespace has been renamed to SpaceWarp2.

'''<big>API</big>'''

SpaceWarp2 now has following classes:

GeneralMod

MonoBehaviourMod

KerbalMod. (technically a Redux thing) It has access to useful game classes like Game, Assets, Messages, etc. Equivalent to BaseSpaceWarpPlugin. Found in Redux.ExtraModTypes

SpaceWarp2 also has a bunch of different members. Some of it has also been split up into ReduxLib and Redux.

SpaceWarp2.API.Configuration = ReduxLib.Configuration

SpaceWarp.API.UI.Appbar = SpaceWarp2.UI.API.Appbar

BepInExConfigFile = JsonConfigFile

'''<big>Example plugin before & after migration:</big>'''

Before:<syntaxhighlight lang="c#">
using System.Reflection;
using BepInEx;
using JetBrains.Annotations;
using SpaceWarp;
using SpaceWarp.API.Assets;
using SpaceWarp.API.Mods;
using SpaceWarp.API.UI.Appbar;
using SpaceWarpModUI.UI;
using UitkForKsp2.API;
using UnityEngine;
using UnityEngine.UIElements;

namespace SpaceWarpModUI;

[BepInPlugin(MyPluginInfo.PLUGIN_GUID, MyPluginInfo.PLUGIN_NAME, MyPluginInfo.PLUGIN_VERSION)]
[BepInDependency(SpaceWarpPlugin.ModGuid, SpaceWarpPlugin.ModVer)]
public class SpaceWarpModUIPlugin : BaseSpaceWarpPlugin
{
// Useful in case some other mod wants to use this mod a dependency
[PublicAPI] public const string ModGuid = MyPluginInfo.PLUGIN_GUID;
[PublicAPI] public const string ModName = MyPluginInfo.PLUGIN_NAME;
[PublicAPI] public const string ModVer = MyPluginInfo.PLUGIN_VERSION;

/// Singleton instance of the plugin class
[PublicAPI] public static SpaceWarpModUIPlugin Instance { get; set; }

// AppBar button IDs
internal const string ToolbarFlightButtonID = "BTN-SpaceWarpModUIFlight";
internal const string ToolbarOabButtonID = "BTN-SpaceWarpModUIOAB";
internal const string ToolbarKscButtonID = "BTN-SpaceWarpModUIKSC";

/// <summary>
/// Runs when the mod is first initialized.
/// </summary>
public override void OnInitialized()
{
base.OnInitialized();

Instance = this;

// Load all the other assemblies used by this mod
LoadAssemblies();

// Load the UI from the asset bundle
var myFirstWindowUxml = AssetManager.GetAsset<VisualTreeAsset>(
// The case-insensitive path to the asset in the bundle is composed of:
// - The mod GUID:
$"{ModGuid}/" +
// - The name of the asset bundle:
"SpaceWarpModUI_ui/" +
// - The path to the asset in your Unity project (without the "Assets/" part)
"ui/myfirstwindow/myfirstwindow.uxml"
);

// Create the window options object
var windowOptions = new WindowOptions
{
// The ID of the window. It should be unique to your mod.
WindowId = "SpaceWarpModUI_MyFirstWindow",
// The transform of parent game object of the window.
// If null, it will be created under the main canvas.
Parent = null,
// Whether or not the window can be hidden with F2.
IsHidingEnabled = true,
// Whether to disable game input when typing into text fields.
DisableGameInputForTextFields = true,
MoveOptions = new MoveOptions
{
// Whether or not the window can be moved by dragging.
IsMovingEnabled = true,
// Whether or not the window can only be moved within the screen bounds.
CheckScreenBounds = true
}
};

// Create the window
var myFirstWindow = Window.Create(windowOptions, myFirstWindowUxml);
// Add a controller for the UI to the window's game object
var myFirstWindowController = myFirstWindow.gameObject.AddComponent<MyFirstWindowController>();

// Register Flight AppBar button
Appbar.RegisterAppButton(
ModName,
ToolbarFlightButtonID,
AssetManager.GetAsset<Texture2D>($"{ModGuid}/images/icon.png"),
isOpen => myFirstWindowController.IsWindowOpen = isOpen
);

// Register OAB AppBar Button
Appbar.RegisterOABAppButton(
ModName,
ToolbarOabButtonID,
AssetManager.GetAsset<Texture2D>($"{ModGuid}/images/icon.png"),
isOpen => myFirstWindowController.IsWindowOpen = isOpen
);

// Register KSC AppBar Button
Appbar.RegisterKSCAppButton(
ModName,
ToolbarKscButtonID,
AssetManager.GetAsset<Texture2D>($"{ModGuid}/images/icon.png"),
() => myFirstWindowController.IsWindowOpen = !myFirstWindowController.IsWindowOpen
);
}

/// <summary>
/// Loads all the assemblies for the mod.
/// </summary>
private static void LoadAssemblies()
{
// Load the Unity project assembly
var currentFolder = new FileInfo(Assembly.GetExecutingAssembly().Location).Directory!.FullName;
var unityAssembly = Assembly.LoadFrom(Path.Combine(currentFolder, "SpaceWarpModUI.Unity.dll"));
// Register any custom UI controls from the loaded assembly
CustomControls.RegisterFromAssembly(unityAssembly);
}
}
</syntaxhighlight>After:<syntaxhighlight lang="c#">
using System.Reflection;
using JetBrains.Annotations;
using Redux.ExtraModTypes;
using SpaceWarp2.UI.API.Appbar;
using SpaceWarpModUI.UI;
using UitkForKsp2.API;
using UitkForKsp2.Controls;
using UnityEngine;
using UnityEngine.UIElements;

namespace SpaceWarpModUI;

public class SpaceWarpModUIPlugin : KerbalMod
{
// Not needed anymore.
[PublicAPI] public const string ModGuid = "SpaceWarpModUI"; // ModGuid here

[PublicAPI] public const string ModName = "SpaceWarpUIMod";
//[PublicAPI] public const string ModVer = MyPluginInfo.PLUGIN_VERSION;

/// Singleton instance of the plugin class
[PublicAPI] public static SpaceWarpModUIPlugin Instance { get; set; }

// AppBar button IDs
internal const string ToolbarFlightButtonID = "BTN-SpaceWarpModUIFlight";
internal const string ToolbarOabButtonID = "BTN-SpaceWarpModUIOAB";
internal const string ToolbarKscButtonID = "BTN-SpaceWarpModUIKSC";

public override void OnPreInitialized()
{
throw new NotImplementedException();
}
/// <summary>
/// Runs when the mod is first initialized.
/// </summary>

public override void OnInitialized()
{
Instance = this;

// Load all the other assemblies used by this mod
//LoadAssemblies();

// Load the UI from the asset bundle
var myFirstWindowUxml = Assets.LoadAssetAsync<VisualTreeAsset>(
// The case-insensitive path to the asset in the bundle is composed of:
// - The mod GUID:
$"{ModGuid}/" +
// - The name of the asset bundle:
"SpaceWarpModUI_ui/" +
// - The path to the asset in your Unity project (without the "Assets/" part)
"ui/myfirstwindow/myfirstwindow.uxml"
).Result;

// Create the window options object
var windowOptions = new WindowOptions
{
// The ID of the window. It should be unique to your mod.
WindowId = "SpaceWarpModUI_MyFirstWindow",
// The transform of parent game object of the window.
// If null, it will be created under the main canvas.
Parent = null,
// Whether the window can be hidden with F2.
IsHidingEnabled = true,
// Whether the UI will use the "Scale" option in the settings.
UseStockScale = true,
// Whether to disable game input when typing into text fields.
DisableGameInputForTextFields = true,
MoveOptions = new MoveOptions
{
// Whether the window can be moved by dragging.
IsMovingEnabled = true,
// Whether the window can only be moved within the screen bounds.
CheckScreenBounds = true
}
};

// Create the window
var myFirstWindow = Window.Create(windowOptions, myFirstWindowUxml);
// Add a controller for the UI to the window's game object
var myFirstWindowController = myFirstWindow.gameObject.AddComponent<MyFirstWindowController>();

// Register Flight AppBar button
Appbar.RegisterAppButton(
ModName,
ToolbarFlightButtonID,
Assets.LoadAssetAsync<Texture2D>($"{ModGuid}/images/icon.png").Result,
isOpen => myFirstWindowController.IsWindowOpen = isOpen
);

// Register OAB AppBar Button
Appbar.RegisterOABAppButton(
ModName,
ToolbarOabButtonID,
Assets.LoadAssetAsync<Texture2D>($"{ModGuid}/images/icon.png").Result,
isOpen => myFirstWindowController.IsWindowOpen = isOpen
);

// Register KSC AppBar Button
Appbar.RegisterKSCAppButton(
ModName,
ToolbarKscButtonID,
Assets.LoadAssetAsync<Texture2D>($"{ModGuid}/images/icon.png").Result,
() => myFirstWindowController.IsWindowOpen = !myFirstWindowController.IsWindowOpen
);
}

public override void OnPostInitialized()
{
throw new NotImplementedException();
}

//private static void LoadAssemblies()
//{
// // Load the Unity project assembly
// var currentFolder = new FileInfo(Assembly.GetExecutingAssembly().Location).Directory!.FullName;
// var unityAssembly = Assembly.LoadFrom(Path.Combine(currentFolder, "SpaceWarpModUI.Unity.dll"));
// // Register any custom UI controls from the loaded assembly
// CustomControls.RegisterFromAssembly(unityAssembly);
//}
}
</syntaxhighlight>For more examples you can look at some of the "Reduxed" mods we've made for Redux here: https://github.com/orgs/KSP2Community/repositories?type=all

Migrating from SpaceWarp 1.x

2025-11-20T20:16:13Z

Dandoesstuff: admittedly I don't know if this works 100% but there were no errors in the logs

Redux features a brand new version of SpaceWarp. While it's all shiny and cool, it breaks support with older versions. Now you're probably wondering: How do I migrate to SpaceWarp 2.x? This guide is for you.

'''<big>What's different?</big>'''

Since Redux has SpaceWarp built-in, there's no need to have BepInEx anymore. This means all mods get stored in a dedicated Mods folder in the main KSP2 directory called "mods"... and that you can't use BepInEx's stuff anymore.

The SpaceWarp namespace has been renamed to SpaceWarp2.

'''<big>API</big>'''

SpaceWarp2 now has following classes:

GeneralMod

MonoBehaviourMod

KerbalMod. (technically a Redux thing) It has access to useful game classes like Game, Assets, Messages, etc. Equivalent to BaseSpaceWarpPlugin. Found in Redux.ExtraModTypes

SpaceWarp2 also has a bunch of different members. Some of it has also been split up into ReduxLib and Redux.

SpaceWarp2.API.Configuration = ReduxLib.Configuration

SpaceWarp.API.UI.Appbar = SpaceWarp2.UI.API.Appbar

BepInExConfigFile = JsonConfigFile

'''<big>Example plugin before & after migration:</big>'''

Before:<syntaxhighlight lang="c#">
using System.Reflection;
using BepInEx;
using JetBrains.Annotations;
using SpaceWarp;
using SpaceWarp.API.Assets;
using SpaceWarp.API.Mods;
using SpaceWarp.API.UI.Appbar;
using SpaceWarpModUI.UI;
using UitkForKsp2.API;
using UnityEngine;
using UnityEngine.UIElements;

namespace SpaceWarpModUI;

[BepInPlugin(MyPluginInfo.PLUGIN_GUID, MyPluginInfo.PLUGIN_NAME, MyPluginInfo.PLUGIN_VERSION)]
[BepInDependency(SpaceWarpPlugin.ModGuid, SpaceWarpPlugin.ModVer)]
public class SpaceWarpModUIPlugin : BaseSpaceWarpPlugin
{
// Useful in case some other mod wants to use this mod a dependency
[PublicAPI] public const string ModGuid = MyPluginInfo.PLUGIN_GUID;
[PublicAPI] public const string ModName = MyPluginInfo.PLUGIN_NAME;
[PublicAPI] public const string ModVer = MyPluginInfo.PLUGIN_VERSION;

/// Singleton instance of the plugin class
[PublicAPI] public static SpaceWarpModUIPlugin Instance { get; set; }

// AppBar button IDs
internal const string ToolbarFlightButtonID = "BTN-SpaceWarpModUIFlight";
internal const string ToolbarOabButtonID = "BTN-SpaceWarpModUIOAB";
internal const string ToolbarKscButtonID = "BTN-SpaceWarpModUIKSC";

/// <summary>
/// Runs when the mod is first initialized.
/// </summary>
public override void OnInitialized()
{
base.OnInitialized();

Instance = this;

// Load all the other assemblies used by this mod
LoadAssemblies();

// Load the UI from the asset bundle
var myFirstWindowUxml = AssetManager.GetAsset<VisualTreeAsset>(
// The case-insensitive path to the asset in the bundle is composed of:
// - The mod GUID:
$"{ModGuid}/" +
// - The name of the asset bundle:
"SpaceWarpModUI_ui/" +
// - The path to the asset in your Unity project (without the "Assets/" part)
"ui/myfirstwindow/myfirstwindow.uxml"
);

// Create the window options object
var windowOptions = new WindowOptions
{
// The ID of the window. It should be unique to your mod.
WindowId = "SpaceWarpModUI_MyFirstWindow",
// The transform of parent game object of the window.
// If null, it will be created under the main canvas.
Parent = null,
// Whether or not the window can be hidden with F2.
IsHidingEnabled = true,
// Whether to disable game input when typing into text fields.
DisableGameInputForTextFields = true,
MoveOptions = new MoveOptions
{
// Whether or not the window can be moved by dragging.
IsMovingEnabled = true,
// Whether or not the window can only be moved within the screen bounds.
CheckScreenBounds = true
}
};

// Create the window
var myFirstWindow = Window.Create(windowOptions, myFirstWindowUxml);
// Add a controller for the UI to the window's game object
var myFirstWindowController = myFirstWindow.gameObject.AddComponent<MyFirstWindowController>();

// Register Flight AppBar button
Appbar.RegisterAppButton(
ModName,
ToolbarFlightButtonID,
AssetManager.GetAsset<Texture2D>($"{ModGuid}/images/icon.png"),
isOpen => myFirstWindowController.IsWindowOpen = isOpen
);

// Register OAB AppBar Button
Appbar.RegisterOABAppButton(
ModName,
ToolbarOabButtonID,
AssetManager.GetAsset<Texture2D>($"{ModGuid}/images/icon.png"),
isOpen => myFirstWindowController.IsWindowOpen = isOpen
);

// Register KSC AppBar Button
Appbar.RegisterKSCAppButton(
ModName,
ToolbarKscButtonID,
AssetManager.GetAsset<Texture2D>($"{ModGuid}/images/icon.png"),
() => myFirstWindowController.IsWindowOpen = !myFirstWindowController.IsWindowOpen
);
}

/// <summary>
/// Loads all the assemblies for the mod.
/// </summary>
private static void LoadAssemblies()
{
// Load the Unity project assembly
var currentFolder = new FileInfo(Assembly.GetExecutingAssembly().Location).Directory!.FullName;
var unityAssembly = Assembly.LoadFrom(Path.Combine(currentFolder, "SpaceWarpModUI.Unity.dll"));
// Register any custom UI controls from the loaded assembly
CustomControls.RegisterFromAssembly(unityAssembly);
}
}
</syntaxhighlight>After:<syntaxhighlight lang="c#">
using System.Reflection;
using JetBrains.Annotations;
using Redux.ExtraModTypes;
using SpaceWarp2.UI.API.Appbar;
using SpaceWarpModUI.UI;
using UitkForKsp2.API;
using UitkForKsp2.Controls;
using UnityEngine;
using UnityEngine.UIElements;

namespace SpaceWarpModUI;

public class SpaceWarpModUIPlugin : KerbalMod
{
// Not needed anymore.
[PublicAPI] public const string ModGuid = "SpaceWarpModUI"; // ModGuid here

[PublicAPI] public const string ModName = "SpaceWarpUIMod";
//[PublicAPI] public const string ModVer = MyPluginInfo.PLUGIN_VERSION;

/// Singleton instance of the plugin class
[PublicAPI] public static SpaceWarpModUIPlugin Instance { get; set; }

// AppBar button IDs
internal const string ToolbarFlightButtonID = "BTN-SpaceWarpModUIFlight";
internal const string ToolbarOabButtonID = "BTN-SpaceWarpModUIOAB";
internal const string ToolbarKscButtonID = "BTN-SpaceWarpModUIKSC";

public override void OnPreInitialized()
{
throw new NotImplementedException();
}
/// <summary>
/// Runs when the mod is first initialized.
/// </summary>

public override void OnInitialized()
{
Instance = this;

// Load all the other assemblies used by this mod
LoadAssemblies();

// Load the UI from the asset bundle
var myFirstWindowUxml = Assets.LoadAssetAsync<VisualTreeAsset>(
// The case-insensitive path to the asset in the bundle is composed of:
// - The mod GUID:
$"{ModGuid}/" +
// - The name of the asset bundle:
"SpaceWarpModUI_ui/" +
// - The path to the asset in your Unity project (without the "Assets/" part)
"ui/myfirstwindow/myfirstwindow.uxml"
).Result;

// Create the window options object
var windowOptions = new WindowOptions
{
// The ID of the window. It should be unique to your mod.
WindowId = "SpaceWarpModUI_MyFirstWindow",
// The transform of parent game object of the window.
// If null, it will be created under the main canvas.
Parent = null,
// Whether the window can be hidden with F2.
IsHidingEnabled = true,
// Whether the UI will use the "Scale" option in the settings.
UseStockScale = true,
// Whether to disable game input when typing into text fields.
DisableGameInputForTextFields = true,
MoveOptions = new MoveOptions
{
// Whether the window can be moved by dragging.
IsMovingEnabled = true,
// Whether the window can only be moved within the screen bounds.
CheckScreenBounds = true
}
};

// Create the window
var myFirstWindow = Window.Create(windowOptions, myFirstWindowUxml);
// Add a controller for the UI to the window's game object
var myFirstWindowController = myFirstWindow.gameObject.AddComponent<MyFirstWindowController>();

// Register Flight AppBar button
Appbar.RegisterAppButton(
ModName,
ToolbarFlightButtonID,
Assets.LoadAssetAsync<Texture2D>($"{ModGuid}/images/icon.png").Result,
isOpen => myFirstWindowController.IsWindowOpen = isOpen
);

// Register OAB AppBar Button
Appbar.RegisterOABAppButton(
ModName,
ToolbarOabButtonID,
Assets.LoadAssetAsync<Texture2D>($"{ModGuid}/images/icon.png").Result,
isOpen => myFirstWindowController.IsWindowOpen = isOpen
);

// Register KSC AppBar Button
Appbar.RegisterKSCAppButton(
ModName,
ToolbarKscButtonID,
Assets.LoadAssetAsync<Texture2D>($"{ModGuid}/images/icon.png").Result,
() => myFirstWindowController.IsWindowOpen = !myFirstWindowController.IsWindowOpen
);
}

public override void OnPostInitialized()
{
throw new NotImplementedException();
}

//private static void LoadAssemblies()
//{
// // Load the Unity project assembly
// var currentFolder = new FileInfo(Assembly.GetExecutingAssembly().Location).Directory!.FullName;
// var unityAssembly = Assembly.LoadFrom(Path.Combine(currentFolder, "SpaceWarpModUI.Unity.dll"));
// // Register any custom UI controls from the loaded assembly
// CustomControls.RegisterFromAssembly(unityAssembly);
//}
}
</syntaxhighlight>For more examples you can look at some of the "Reduxed" mods we've made for Redux here: https://github.com/orgs/KSP2Community/repositories?type=all

Migrating from SpaceWarp 1.x

2025-11-19T14:32:27Z

Dandoesstuff:

Migrating from SpaceWarp 1.x

2025-11-17T18:53:50Z

Dandoesstuff: add more examples

Migrating from SpaceWarp 1.x

2025-11-17T14:41:55Z

Dandoesstuff:

Main Page

2025-11-17T14:41:27Z

Dandoesstuff: add migration guide, wip

= KSP 2 Modding Wiki =
Welcome to the KSP 2 Modding Wiki, a collection of resources on how to mod the game and information on existing community mods.

'''We are currently under construction!'''

== Page Categories ==

* [[General Modding Guidelines and Resources]]
* [[Migrating from SpaceWarp 1.x]]
* [[Part Modding]]
* [[Part Modules]]
* [[Missions]]
* [[Planet Modding]]
* [[KSP2 Redux]]
* [[Other]]
* [[Duplicates, Deprecates and other miscreants|Pages that require attention/need to be deleted (for Kiwi)]]<br />
== Links ==

* [https://ksp2community.github.io/ KSP 2 Unofficial API Reference]
* [https://discord.gg/hHW5gpHxfE KSP 2 Modding Society Discord Server]
* [https://docs.spacewarp.org/ SpaceWarp Modding API Documentation]
* [https://github.com/KSP2Community KSP 2 Community GitHub]

Migrating from SpaceWarp 1.x

2025-11-16T18:28:41Z

Dandoesstuff:

Migrating from SpaceWarp 1.x

2025-11-16T17:47:47Z

Dandoesstuff: link

Migrating from SpaceWarp 1.x

2025-11-16T17:47:01Z

Dandoesstuff:

Migrating from SpaceWarp 1.x

2025-11-16T17:40:29Z

Dandoesstuff:

Migrating from SpaceWarp 1.x

2025-11-16T17:38:45Z

Dandoesstuff:

Migrating from SpaceWarp 1.x

2025-11-16T17:33:57Z

Dandoesstuff:

Setting up a Development Environment

2025-11-16T17:31:34Z

Dandoesstuff:

[[Category:Getting started]]
There are three main types of projects that you will be creating most of the time:

* '''Unity project''' - used to add objects such as parts or planets into the game.
* '''.NET project''' - mostly composed of C# code, useful for example for various small QoL and gameplay enhancements or fixes, etc.
* '''Mixed project''' - a combination of the previous two, used for example if you want to create parts with custom modules, or when making a gameplay tool with a UI.

To set up a standalone project, see [[Setting up Unity]].

Setting up Unity

2025-11-16T17:28:30Z

Dandoesstuff:

This page will help you install everything you need to use Unity for KSP2 modding.

== Installing Unity ==

# Download Unity Hub from https://unity.com/download.
# Download Unity 2022.3.5f1 by clicking on the '''Install this version with Unity Hub''' link on this page: https://unity.com/releases/editor/whats-new/2022.3.5.
# Download and install Git from https://git-scm.com/downloads.
# Download/Clone/Use the Redux.Template repo from https://github.com/KSP2Redux/Redux.Template

== Initializing the Unity project ==
# Open '''Unity Hub'''.
# Click on '''Add''' at the top right of the window.
# Click on '''Add project from disk.'''
# Select the Redux template you downloaded.

== Configuring the Unity project ==

=== Configuring ThunderKit ===
''ThunderKit'' is a package for Unity which we use to import the game's components into the Unity editor. This is included with the Redux Template

# The ''ThunderKit'' Settings window should open, if it doesn’t, just go to '''Tools>ThunderKit>Settings''' in the toolbar at the top of Unity.
# Go to '''ThunderKit Settings''' and in '''Locate and load game files for project,''' click on '''Browse''' and select your main Kerbal Space Program 2 executable found at <code><KSP2 root folder>/KSP2_x64.exe</code>. '''Note: This must be a Redux install of the game.'''
# Click '''Import''' and wait for KSP2 to be imported. If asked, click '''I made a backup, Go Ahead'''.
# If Unity asks you to restart your project, confirm it by clicking on '''Restart Project'''.
# After the process is finished, to check if the game was correctly imported, select or create any game object and in the inspector click '''Add Component''' and search for '''Core Part Data.'''
# Once you've confirmed that Core Part Data is there, you now have to browse to '''Assets -> and find ImportKsp2ToEditor.'''
# Once you've found ImportKsp2ToEditor, click on it and press '''Execute.'''

=== Creating a mod and setting up swinfo.json ===

# Go to '''Modding>KSP2 Unity Tools.'''
# Click Create Mod
# Give the mod a ModId and if you want a small code template in your mod, click '''Add Code to Mod.'''
# Click Create.
# You should now have a folder with your mod name with a swinfo asset, Pipelines folder and if you ticked Add Code to Mod, a Code folder.
# Setting up swinfo is simple. Select swinfo.asset and edit all the values to your liking.
# If you want to test your mod in the editor, navigate to KSP2 Unity Tools, select your mod and then click '''Test Selected Mods in Editor.'''
# Once you've finished your mod and are ready to distribute it, you will have to export it. Select the mod in KSP2 Unity Tools and then click '''Deploy Selected Mods To Zip File.'''
# The mod will then be stored in the Redux.Template in a folder called "Deploy". You will then have to share the zip on SpaceDock or whichever other websites you please.

[[Category:Getting started]]

Setting up Unity

2025-11-16T17:27:50Z

Dandoesstuff:

This page will help you install everything you need to use Unity for KSP2 modding.

== Installing Unity ==

# Download Unity Hub from https://unity.com/download.
# Download Unity 2022.3.5f1 by clicking on the '''Install this version with Unity Hub''' link on this page: https://unity.com/releases/editor/whats-new/2022.3.5.
# Download and install Git from https://git-scm.com/downloads.
# Download/Clone/Use the Redux.Template repo from https://github.com/KSP2Redux/Redux.Template

== Initializing the Unity project ==
# Open '''Unity Hub'''.
# Click on '''Add''' at the top right of the window.
# Click on '''Add project from disk.'''
# Select the Redux template you downloaded.

== Configuring the Unity project ==

=== Configuring ThunderKit ===
''ThunderKit'' is a package for Unity which we use to import the game's components into the Unity editor. This is included with the Redux Template

# The ''ThunderKit'' Settings window should open, if it doesn’t, just go to '''Tools>ThunderKit>Settings''' in the toolbar at the top of Unity.
# Go to '''ThunderKit Settings''' and in '''Locate and load game files for project,''' click on '''Browse''' and select your main Kerbal Space Program 2 executable found at <code><KSP2 root folder>/KSP2_x64.exe</code>. '''Note: This must be a Redux install of the game.'''
# Click '''Import''' and wait for KSP2 to be imported. If asked, click '''I made a backup, Go Ahead'''.
# If Unity asks you to restart your project, confirm it by clicking on '''Restart Project'''.
# After the process is finished, to check if the game was correctly imported, select or create any game object and in the inspector click '''Add Component''' and search for '''Core Part Data.'''
# Once you've confirmed that Core Part Data is there, you now have to browse to '''Assets -> and find ImportKsp2ToEditor.'''
# Copy ImportKsp2ToEditor to Assets, and then click on that copy and press '''Execute.'''

=== Creating a mod and setting up swinfo.json ===

# Go to '''Modding>KSP2 Unity Tools.'''
# Click Create Mod
# Give the mod a ModId and if you want a small code template in your mod, click '''Add Code to Mod.'''
# Click Create.
# You should now have a folder with your mod name with a swinfo asset, Pipelines folder and if you ticked Add Code to Mod, a Code folder.
# Setting up swinfo is simple. Select swinfo.asset and edit all the values to your liking.
# If you want to test your mod in the editor, navigate to KSP2 Unity Tools, select your mod and then click '''Test Selected Mods in Editor.'''
# Once you've finished your mod and are ready to distribute it, you will have to export it. Select the mod in KSP2 Unity Tools and then click '''Deploy Selected Mods To Zip File.'''
# The mod will then be stored in the Redux.Template in a folder called "Deploy". You will then have to share the zip on SpaceDock or whichever other websites you please.

[[Category:Getting started]]

Setting up Unity

2025-11-16T17:27:24Z

Dandoesstuff:

This page will help you install everything you need to use Unity for KSP2 modding.

== Installing Unity ==

# Download Unity Hub from https://unity.com/download.
# Download Unity 2022.3.5f1 by clicking on the '''Install this version with Unity Hub''' link on this page: https://unity.com/releases/editor/whats-new/2022.3.5.
# Download and install Git from https://git-scm.com/downloads.
# Download/Clone the Redux.Template repo from https://github.com/KSP2Redux/Redux.Template

== Initializing the Unity project ==
# Open '''Unity Hub'''.
# Click on '''Add''' at the top right of the window.
# Click on '''Add project from disk.'''
# Select the Redux template you downloaded.

== Configuring the Unity project ==

=== Configuring ThunderKit ===
''ThunderKit'' is a package for Unity which we use to import the game's components into the Unity editor. This is included with the Redux Template

# The ''ThunderKit'' Settings window should open, if it doesn’t, just go to '''Tools>ThunderKit>Settings''' in the toolbar at the top of Unity.
# Go to '''ThunderKit Settings''' and in '''Locate and load game files for project,''' click on '''Browse''' and select your main Kerbal Space Program 2 executable found at <code><KSP2 root folder>/KSP2_x64.exe</code>. '''Note: This must be a Redux install of the game.'''
# Click '''Import''' and wait for KSP2 to be imported. If asked, click '''I made a backup, Go Ahead'''.
# If Unity asks you to restart your project, confirm it by clicking on '''Restart Project'''.
# After the process is finished, to check if the game was correctly imported, select or create any game object and in the inspector click '''Add Component''' and search for '''Core Part Data.'''
# Once you've confirmed that Core Part Data is there, you now have to browse to '''Assets -> and find ImportKsp2ToEditor.'''
# Copy ImportKsp2ToEditor to Assets, and then click on that copy and press '''Execute.'''

=== Creating a mod and setting up swinfo.json ===

# Go to '''Modding>KSP2 Unity Tools.'''
# Click Create Mod
# Give the mod a ModId and if you want a small code template in your mod, click '''Add Code to Mod.'''
# Click Create.
# You should now have a folder with your mod name with a swinfo asset, Pipelines folder and if you ticked Add Code to Mod, a Code folder.
# Setting up swinfo is simple. Select swinfo.asset and edit all the values to your liking.
# If you want to test your mod in the editor, navigate to KSP2 Unity Tools, select your mod and then click '''Test Selected Mods in Editor.'''
# Once you've finished your mod and are ready to distribute it, you will have to export it. Select the mod in KSP2 Unity Tools and then click '''Deploy Selected Mods To Zip File.'''
# The mod will then be stored in the Redux.Template in a folder called "Deploy". You will then have to share the zip on SpaceDock or whichever other websites you please.

[[Category:Getting started]]

Setting up Unity

2025-11-16T17:15:56Z

Dandoesstuff:

This page will help you install everything you need to use Unity for KSP2 modding.

== Installing Unity ==

# Download Unity Hub from https://unity.com/download.
# Download Unity 2022.3.5f1 by clicking on the '''Install this version with Unity Hub''' link on this page: https://unity.com/releases/editor/whats-new/2022.3.5.
# Download and install Git from https://git-scm.com/downloads.
# Download/Clone the Redux.Template repo from https://github.com/KSP2Redux/Redux.Template

== Initializing the Unity project ==
# Open '''Unity Hub'''.
# Click on '''Add''' at the top right of the window.
# Click on '''Add project from disk.'''
# Select the Redux template you downloaded.

== Configuring the Unity project ==

=== Configuring ThunderKit ===
''ThunderKit'' is a package for Unity which we use to import the game's components into the Unity editor. This is included with the Redux Template

# The ''ThunderKit'' Settings window should open, if it doesn’t, just go to '''Tools>ThunderKit>Settings''' in the toolbar at the top of Unity.
# Go to '''ThunderKit Settings''' and in '''Locate and load game files for project,''' click on '''Browse''' and select your main Kerbal Space Program 2 executable found at <code><KSP2 root folder>/KSP2_x64.exe</code>. '''Note: This must be a Redux install of the game.'''
# Click '''Import''' and wait for KSP2 to be imported. If asked, click '''I made a backup, Go Ahead'''.
# If Unity asks you to restart your project, confirm it by clicking on '''Restart Project'''.
# After the process is finished, to check if the game was correctly imported, select or create any game object and in the inspector click '''Add Component''' and search for '''Core Part Data.'''
# Once you've confirmed that Core Part Data is there, you now have to browse to '''Packages -> KSP2 Unity Tools -> and find ImportKsp2ToEditor.'''
# Copy ImportKsp2ToEditor to Assets, and then click on that copy and press '''Execute.'''

=== Creating a mod and setting up swinfo.json ===

# Go to '''Modding>KSP2 Unity Tools.'''
# Click Create Mod
# Give the mod a ModId and if you want a small code template in your mod, click '''Add Code to Mod.'''
# Click Create.
# You should now have a folder with your mod name with a swinfo asset, Pipelines folder and if you ticked Add Code to Mod, a Code folder.
# Setting up swinfo is simple. Select swinfo.asset and edit all the values to your liking.
# Once you've finished your mod, you will have to export it. Select the mod in KSP2 Unity Tools and then click '''Deploy Selected Mods To Zip File.'''
# The mod will then be stored in the Redux.Template in a folder called "Deploy". Place this folder in the "mods" folder and test out your mod in game.

[[Category:Getting started]]

Setting up Unity

2025-11-16T17:13:02Z

Dandoesstuff: Update to instead use the Redux Template

This page will help you install everything you need to use Unity for KSP2 modding.

== Installing Unity ==

# Download Unity Hub from https://unity.com/download.
# Download Unity 2022.3.5f1 by clicking on the '''Install this version with Unity Hub''' link on this page: https://unity.com/releases/editor/whats-new/2022.3.5.
# Download and install Git from https://git-scm.com/downloads.
# Download/Clone the Redux.Template repo from https://github.com/KSP2Redux/Redux.Template

== Initializing the Unity project ==
# Open '''Unity Hub'''.
# Click on '''Add''' at the top right of the window.
# Click on '''Add project from disk.'''
# Select the Redux template you downloaded.

== Configuring the Unity project ==

=== Configuring ThunderKit ===
''ThunderKit'' is a package for Unity which we use to import the game's components into the Unity editor. This is included with the Redux Template

# The ''ThunderKit'' Settings window should open, if it doesn’t, just go to '''Tools>ThunderKit>Settings''' in the toolbar at the top of Unity.
# Go to '''ThunderKit Settings''' and in '''Locate and load game files for project,''' click on '''Browse''' and select your main Kerbal Space Program 2 executable found at <code><KSP2 root folder>/KSP2_x64.exe</code>.
# Click '''Import''' and wait for KSP2 to be imported. If asked, click '''I made a backup, Go Ahead'''.
# If Unity asks you to restart your project, confirm it by clicking on '''Restart Project'''.
# After the process is finished, to check if the game was correctly imported, select or create any game object and in the inspector click '''Add Component''' and search for '''Core Part Data.'''
# Once you've confirmed that Core Part Data is there, you now have to browse to '''Packages -> KSP2 Unity Tools -> and find ImportKsp2ToEditor.'''
# Copy ImportKsp2ToEditor to Assets, and then click on that copy and press '''Execute.'''

=== Creating a mod and setting up swinfo.json ===

# Go to '''Modding>KSP2 Unity Tools.'''
# Click Create Mod
# Give the mod a ModId and if you want a small code template in your mod, click '''Add Code to Mod.'''
# Click Create.
# You should now have a folder with your mod name with a swinfo asset, Pipelines folder and if you ticked Add Code to Mod, a Code folder.
# Setting up swinfo is simple. Select swinfo.asset and edit all the values to your liking.
# Once you've finished your mod, you will have to export it. Select the mod in KSP2 Unity Tools and then click '''Deploy Selected Mods To Zip File.'''
# The mod will then be stored in the Redux.Template in a folder called "Deploy". Place this folder in the "mods" folder and test out your mod in game.

[[Category:Getting started]]

Migrating from SpaceWarp 1.x

2025-11-16T10:45:04Z

Dandoesstuff:

KSP2 Redux

2025-11-16T10:31:00Z

Dandoesstuff: migration guide added

== Introduction ==
Our plan for Redux is to try and achieve what we interpret as the core vision of the original developers of KSP2. This means both fixing existing bugs in the game, improving performance and most importantly bring to life promised features like colonies, interstellar travel or multiplayer. We also want to make the game as moddable as possible by providing tools to help the development of mods. Regarding features such as colonies, the current plan is to include all core functionality, with some parts to fill the necessary gameplay roles. Fancier parts will be left to modders to add to the game, for example: Redux might include a simple ISRU for colonies but mods could add many more of varying size, style, etc.

=== What form will Redux take? ===
Redux will most likely be distributed as an installer which will apply some patches to the relevant files in an existing KSP2 installation. Redux will not take the form of either a standalone executable or a simple Spacewarp mod, it's gonna be something in-between. We hope to be able to integrate Redux's installer into CKAN to make installation as simple as possible.

=== Disclaimer ===
Redux is a fan project entirely developed by '''a team of (passionate) volunteers''', we do not have access to the resources of a full game studio so temper your expectations with this in mind. Redux might (and probably will) introduce new bugs to the game, we cannot check every possible scenario otherwise we'd never release anything. We also do not have any affiliation with the former KSP2 developers, please do not interpret this project as an official continuation of KSP2's development.

== Documentation ==
[[ISRU]]

[[Migrating from SpaceWarp 1.x]]

General Modding Guidelines and Resources

2025-11-16T10:30:22Z

Dandoesstuff:

Overview of pages that offer general modding guidelines and useful resources and information for modders

* [[Setting up a Development Environment]]
* [[UnityExplorer]]
* [[How to use Unity Explorer and Object Browser]]
* [[Subscribe to game Messages]]
* [[Transform System Guide]]
* [[Orbits and PatchedConicsOrbit methods and info]]
* [[PatchedConicSolver]]
* [[PartsProvider]]
* [[Scenery - Standard (Opaque) shader]]
* [[Staging Icon Asset Address]]
* [[Stage Type|Stage Types]]
* [[Missions]]
* [[Category|Part Category]]
* [[Resources]]
* [[UniverseModel]]
* [[VesselComponent]]
* [[Custom Launch Locations]]
* [[Colors|UI Colors]]

Migrating from SpaceWarp 1.x

2025-11-15T22:07:11Z

Dandoesstuff:

Migrating from SpaceWarp 1.x

2025-11-15T13:56:44Z

Dandoesstuff: WIP migration guide

Main Page

2025-11-15T11:41:33Z

Dandoesstuff: add missions

= KSP 2 Modding Wiki =
Welcome to the KSP 2 Modding Wiki, a collection of resources on how to mod the game and information on existing community mods.

'''We are currently under construction!'''

== Page Categories ==

* [[General Modding Guidelines and Resources]]
* [[Part Modding]]
* [[Part Modules]]
* [[Missions]]
* [[Planet Modding]]
* [[KSP2 Redux]]
* [[Other]]
* [[Duplicates, Deprecates and other miscreants|Pages that require attention/need to be deleted (for Kiwi)]]<br />
== Links ==

* [https://ksp2community.github.io/ KSP 2 Unofficial API Reference]
* [https://discord.gg/hHW5gpHxfE KSP 2 Modding Society Discord Server]
* [https://docs.spacewarp.org/ SpaceWarp Modding API Documentation]
* [https://github.com/KSP2Community KSP 2 Community GitHub]

Missions

2025-11-15T11:40:57Z

Dandoesstuff: Documentation for missions

Exploration Mode has multiple in-game missions that you're supposed to finish in the campaign. Have you ever wondered *how* to make missions, though? Simple!

Missions in the game are JSON files, but we can also use PatchManager to create new missions.

'''<big>The Mission Editor</big>'''

The Mission Editor is a handy resource made by modders that makes mission creation much faster and more intuitive. You can use it here: https://ksp2community.github.io/editors/

This will eventually be replaced by a full Unity version.

<big>'''Mission Data'''</big>

MissionID: The ID your mission will have.

name: The name your mission will have. It's best to have this as a localization key, but if you don't plan on localizing your mod you can just set it to whatever your mission name is.

description: The description your mission will have. Note, this is the description shown in the UI that appears when you click on a mission. Not the brief. It's also recommended to have this as a localization key.

type: There are multiple types of missions. Primary, Secondary, Tutorial and FTUE. The first 2 are for the missions you see in Mission Control. Tutorial missions are the ones seen in the Training Center and FTUE are the pop-ups that appear when you have Cadet Orientation on.

Owner: There are multiple owners that you can choose from. None, Agency, Owner and Player. Player means only the player will have it. Agency means the agency the player is in will own it. (Which means in multiplayer everyone in that agency can complete it.) Global and None are self explanatory.

state: There are multiple states of missions. Inactive, Active, Complete, Failed and Invalid. You should only focus on the first 2 when creating missions. Inactive means that it'll be invisible until a mission activates your mission. Active means it'll be enabled from the start.

MissionGranterKey. There are multiple mission granters to choose from. It's best to choose the one that suits your mission the best.

TriumphLoopVideoKey: Videos that play once you've submitted the mission. Best example of this are the first few primary missions.

uiDisplayType: Default, Video, Flight, VAB, VAB_Flight. Usually use Default.

missionStages: Here we get to the fun part of missions. The actual mission. They are set up in various "stages". So if you wanted to have the player leave Kerbin and return, you'd have 2 stages for leaving Kerbin and then landing back on Kerbin. Let's see how this is set up.

stages:

StageID: 0,1,2 (just counts up depending on what stage it is)

name: This doesn't get displayed, so you can name it whatever you want.

description: This also doesn't get displayed.

Objective: This does get displayed, so preferably link it to a localization key or just state the objective here.

DisplayObjective: Self-explanatory.

RevealObjectiveOnActivate: This shows the objective once the stage is activated.

MissionRewardType: You can only choose Science Points.

RewardAmount: How much of whatever you chose is going to be rewarded.

ConditionMode: AND, OR, XOR, NOT.

Condition children: These are the things you need to do to actually finish a mission stage.

There are event conditions and property conditions. Event conditions listen to messages like GameStateChangedMessage or FlagPlantedMessage. Property conditions look at what your current active vessel has, for example where it's located, its deltaV, etc.

Note that you can create conditionsets inside of conditionsets. If you wanted to make something where a player can plant a flag on the Mun or Minmus, you can do so by just creating a ConditionSet with its mode set to AND, listening to FlagPlantedMessage, then creating

a condition set inside of that with its mode set to OR, and checking the active vessel SOI.

ContentBranches: Here's the stuff that gets done inside of the Mission Control building. They're similarly set up to the missionStages.

ID: What type of content branch it is. There are 3 to choose from, which are: Brief, Debrief, OnSubmit. Brief and Debrief are the short little dialogues you get when you finish/start a mission. OnSubmit is mostly used to activate missions.

Action: There are multiple actions that you can make your branches do:

Activate Mission, Fullscreen Video, Message Box (note that this is different from CharacterDialog), Audio, OAB Settings, Character Dialog, Create Snapshot, Destination Position, Disable Input, Highlight, Indicator, Pause, Reload Snapshot Resolution, Set View State, Lua Script

'''<big>Saving your Mission</big>'''

So you've finally completed your mission! Great! Putting it into the game is simple. Click the floppy disk icon and save it as a .patch file. You will then have to place it into your mod and run the game.
[[Category:Mods]]

How to name your part

2025-11-15T11:02:10Z

Dandoesstuff: typos again

Stock part names somewhat follow the following pattern : <code><type>_<size>_<feature>_<resource>_<cardinal>_<name></code>

You should always prepend the mod name/mod ID to the part name : <code><modId>_<type>_<size>_<feature>_<resource>_<cardinal>_<name></code>

== Type ==
Mandatory.

Possible values: adapter, antenna, booster, cabin, cargobay, dockingport, engine, probe, etc.

== Size ==
Mandatory.

From 0v (XS) to 5v (2X) but could go higher if need be.

See [[Sizes]] for a full list.

Possible values: 0v, 1v, 2v, etc.

== Feature ==
Optional.

The feature can be anything needed to distinguish this part from a similar part. It usually has to do with the form factor.

Possible values: radial, inline, conical, dish, triangle, etc.

== Resource ==
Optional.

This is meant for part that can contain a resource, like engines and fuel tanks.

Possible values: methalox, hydrogen, solid, crew, electricity, xenon

== Cardinal ==
Optional.

Useful for distinguishing same-size parts that exists in different heights, like fuel tanks.

Possible values: 1x1, 1x2, 1x3, 2x3, 3x2, etc.

== Name ==
Optional.

You can add the part localized name at the end if it helps identifying it more easily.

Example: engine_1v_methalox_terrier

== Examples of stock part names ==

* adapter_2v_conical_methalox_1v-2v
* antenna_1v_dish_hg55
* booster_1v_solid_kickback
* cabin_2v_crew_hitchhiker
* cargobay_3v_m3_1x2
* collector_0v_science_radiation
* decoupler_2v_inline
* dockingport_1v_inline_sideport
* engine_1v_methalox_terrier
* fairing_1v_procedural
* fueltank_1v_inline_methalox_1x4
* heatshield_1v
* panel_1v_triangle_right
* probe_1v_hexagonal_electricity
* solararray_1v_1x6

Main Page

2025-11-15T09:35:46Z

Dandoesstuff: Adjust order of categories

= KSP 2 Modding Wiki =
Welcome to the KSP 2 Modding Wiki, a collection of resources on how to mod the game and information on existing community mods.

'''We are currently under construction!'''

== Page Categories ==

* [[General Modding Guidelines and Resources]]
* [[Part Modding]]
* [[Part Modules]]
* [[Planet Modding]]
* [[KSP2 Redux]]
* [[Other]]
* [[Duplicates, Deprecates and other miscreants|Pages that require attention/need to be deleted (for Kiwi)]]<br />
== Links ==

* [https://ksp2community.github.io/ KSP 2 Unofficial API Reference]
* [https://discord.gg/hHW5gpHxfE KSP 2 Modding Society Discord Server]
* [https://docs.spacewarp.org/ SpaceWarp Modding API Documentation]
* [https://github.com/KSP2Community KSP 2 Community GitHub]

General Modding Guidelines and Resources

2025-11-15T09:34:10Z

Dandoesstuff: typo

Overview of pages that offer general modding guidelines and useful resources and information for modders

* [[Setting up a Development Environment]]
* [[UnityExplorer]]
* [[How to use Unity Explorer and Object Browser]]
* [[Subscribe to game Messages]]
* [[Transform System Guide]]
* [[Orbits and PatchedConicsOrbit methods and info]]
* [[PatchedConicSolver]]
* [[PartsProvider]]
* [[Scenery - Standard (Opaque) shader]]
* [[Staging Icon Asset Address]]
* [[Stage Type|Stage Types]]
* [[Category|Part Category]]
* [[Resources]]
* [[UniverseModel]]
* [[VesselComponent]]
* [[Custom Launch Locations]]
* [[Colors|UI Colors]]

Class descriptions for custom modules

2025-11-15T09:30:56Z

Dandoesstuff: With the release of Redux, PartComponentModules need to be registered for updates. I made sure to document this here.

[[Category:Custom Modules]]

{{DEFAULTSORT:2_Class_descriptions_for_custom_modules}}

While you're mostly free to define how your classes would be set up, there are some guidelines that need to be followed, restrictions to be aware of and inner workings to understand.

== Data class ==

=== Defining your class ===
[Serializable]
public class Data_MyCustomModule : ModuleData
{ .. }

=== Set your PartBehaviourModule type reference ===
public override Type ModuleType => typeof(Module_MyCustomModule);

=== Defining module properties ===

* these are entries shown in the PAM

// Toggle (true/false) property
[KSPState] // KSPState attribute tells the game to save the state of this property in the save game file
[LocalizedField("Path/To/Your/Localization/String1")] // localization string for this attribute (see 'localization' paragraph)
[PAMDisplayControl(SortIndex = 2)] // sets the sorting index for this property. Lower values are placed first
public ModuleProperty<bool> SomeToggleProperty = new(false); // value in the parentheses defines the initial value

// String property
[LocalizedField("Path/To/Your/Localization/String2")]
[PAMDisplayControl(SortIndex = 4)]
[KSPDefinition] // KSPDefinition tells this property that its value is set from the part definition json (set by Patch Manager)
public ModuleProperty<string> SomeStringProperty = new ("");

// Float property - readonly
[LocalizedField("Path/To/Your/Localization/String3")]
[PAMDisplayControl(SortIndex = 7)]
[JsonIgnore] // either [KSPState] or [JsonIgnore] is needed if you want this property to be readonly
public ModuleProperty<float> SomeReadOnlyFloat = new (0, true, val => $"{val:N0} m");

// Float property – editable by players, will be built as a slider
[LocalizedField("Path/To/Your/Localization/String4")]
[PAMDisplayControl(SortIndex = 1)]
[SteppedRange(1f, 45f, 1f)] // minimum, maximum and step values
public ModuleProperty<float> SomeEditableProperty = new (1f, false, val => $"{val:N0}°"); // initial value, isReadOnly, ToStringDelegate

=== Defining a dropdown list property ===

* dropdown list properties are string properties for which you define dropdown values in OnPartBehaviourModuleInit()

// Dropdown property
[LocalizedField("Path/To/Your/Localization/String5")]
public ModuleProperty<string> DropdownProperty = new ModuleProperty<string>("Some value");

public override void OnPartBehaviourModuleInit()
{
var dropdownList = new DropdownItemList();
dropdownList.Add("some key", new DropdownItem() { key = "some key", text = "Some value" });
dropdownList.Add("another key", new DropdownItem() { key = "another key", text = "Another value" });
SetDropdownData(DropdownProperty, dropdownList);
}

=== OnPartBehaviourModuleInit() ===

* runs when this module is initialized when entering Flight/OAB state

public override void OnPartBehaviourModuleInit()
{ /* use this to initialize some values for your module, if needed */ }

=== OAB module description ===

* set the description of your module for all parts it’s being attached to
* description is shown in OAB and R&D while hovering over the part after pressing SHIFT

public override List<OABPartData.PartInfoModuleEntry> GetPartInfoEntries(Type partBehaviourModuleType, List<OABPartData.PartInfoModuleEntry> delegateList)
{
if (partBehaviourModuleType == ModuleType)
{
// add module description
delegateList.Add(new OABPartData.PartInfoModuleEntry("", (_) => „Path/To/Your/Localization/String5“));

// entry header
var entry = new OABPartData.PartInfoModuleEntry(„Path/To/Your/Localization/String6“,
_ =>
{
// subentries
var subEntries = new List<OABPartData.PartInfoModuleSubEntry>();

// first subentry
subEntries.Add(new OABPartData.PartInfoModuleSubEntry(
"Path/To/Your/Localization/String7", // subentry NAME
"subentry value"
));

// second subentry
subEntries.Add(new OABPartData.PartInfoModuleSubEntry(
"Path/To/Your/Localization/String8", // subentry NAME
"subentry value"
));

// if your module is using resources, you can add them to the description
// this doesn't set the value, it's just used to display it to the player
if (UseResources)
{
subEntries.Add(new OABPartData.PartInfoModuleSubEntry(
"Path/To/Your/Localization/String/ResourceName",
$"{RequiredResource.Rate.ToString("N3")} /s"
));
}

return subEntries;
});
delegateList.Add(entry);
}
return delegateList;
}

=== Setting up resource consumptions ===

* Note: trigger this from OnStart() in the Part Component class

public override void SetupResourceRequest(ResourceFlowRequestBroker resourceFlowRequestBroker)
{
if (UseResources)
{
ResourceDefinitionID resourceIDFromName =
GameManager.Instance.Game.ResourceDefinitionDatabase.GetResourceIDFromName(this.RequiredResource.ResourceName);
if (resourceIDFromName == ResourceDefinitionID.InvalidID)
{
_LOGGER.LogError($"There are no resources with name {this.RequiredResource.ResourceName}");
return;
}
RequestConfig = new ResourceFlowRequestCommandConfig();
RequestConfig.FlowResource = resourceIDFromName;
RequestConfig.FlowDirection = FlowDirection.FLOW_OUTBOUND;
RequestConfig.FlowUnits = 0.0;
RequestHandle = resourceFlowRequestBroker.AllocateOrGetRequest("MyCustomModule", default(ResourceFlowRequestHandle));
resourceFlowRequestBroker.SetCommands(this.RequestHandle, 1.0, new ResourceFlowRequestCommandConfig[] { this.RequestConfig });
}
}

[KSPDefinition]
[Tooltip("Whether the module consumes resources")]
public bool UseResources = true;

public bool HasResourcesToOperate = true;

[KSPDefinition]
[Tooltip("Resource required to operate this module if it consumes resources")]
public PartModuleResourceSetting RequiredResource;

public ResourceFlowRequestCommandConfig RequestConfig;

== Part Behaviour class ==

=== Defining your class ===
[DisallowMultipleComponent]
public class Module_OrbitalSurvey : PartBehaviourModule
{ .. }

=== Set your PartComponentModule type reference ===
public override Type PartComponentModuleType => typeof(PartComponentModule_MyCustomModule);

=== Create Data module instance ===
[SerializeField]
protected Data_MyCustomModule _dataMyCustomModule;

public override void AddDataModules()
{
base.AddDataModules();
_dataMyCustomModule ??= new Data_MyCustomModule();
DataModules.TryAddUnique(_dataMyCustomModule, out _dataMyCustomModule);
}

=== Initialize the module behaviour ===
private ModuleAction _myCustomAction;

public override void OnInitialize()
{
base.OnInitialize();

// module actions are triggered when players press a button on the PAM property
_myCustomAction = new ModuleAction(MethodThatWillHandleTheAction);
_dataMyCustomModule.AddAction("Path/To/Your/Localization/String/X", _myCustomAction, 1);

if (PartBackingMode == PartBackingModes.Flight)
{
/* do stuff that's only needed in Flight view */

// example1: hide or show PAM properties depending on the Flight/OAB view
UpdateFlightPAMVisibility();

// example2: subscribe to the enabled toggle
_dataMyCustomModule.EnabledToggleProperty.OnChangedValue += MethodThatWillHandleThis;
}

if (PartBackingMode == PartBackingModes.OAB)
{ /* do stuff that's only needed in the OAB*/ }
}

private void MethodThatWillHandleTheAction()
{ /* do stuff here */}

=== FixedUpdate loop - Flight/Map ===

* define stuff that needs to be executed continuously on every FixedUpdate loop. Be careful not to do expensive stuff here
* this triggers when the vessel is loaded, in Flight/Map view only

// This triggers in flight
public override void OnModuleFixedUpdate(float fixedDeltaTime)
{
// example1: do stuff only if the module is enabled
if (_dataMyCustomModule.EnabledToggleProperty.GetValue())
{ .. }

// example2: update PAM items
if (someConditionMet)
{
UpdateFlightPAMVisibility();
}
}

=== Update loop ===

* similar to FixedUpdate, but this is a regular Update loop independent of game time
* this triggers in Flight/Map when the vessel is loaded and in OAB when the part is attached to the assembly

public override void OnUpdate(float deltaTime)
{ .. }

=== FixedUpdate loop - OAB ===

* same as OnModuleFixedUpdate but it triggers only in OAB

public override void OnModuleOABFixedUpdate(float deltaTime)
{ .. }

=== Define behaviour when the behaviour module instance will be destroyed ===

* cases: exiting Flight view, part has been destroyed, exiting the game

public override void OnShutdown()
{
// example: unsubscribe from events
_dataMyCustomModule.EnabledToggleProperty.OnChangedValue -= OnToggleChangedValue;
}

=== Setting visibility for PAM properties ===
private void UpdateFlightPAMVisibility(bool state)
{
_dataMyCustomModule.SetVisible(_dataMyCustomModule.SomeProperty, state);
_dataMyCustomModule.SetVisible(_dataMyCustomModule.SomeOtherProperty, true);
_dataMyCustomModule.SetVisible(_dataMyCustomModule.YetAnotherProperty, false);
}

=== OnEnable ===

* triggers when Flight view is loaded (only for the loaded vessel) and in OAB when part is added to the assembly

protected void OnEnable()
{ .. }

== Part Component class ==

=== Defining your class ===
public class PartComponentModule_MyCustomModule : PartBehaviourModule
{ .. }

=== Set your PartBehaviourModule type reference ===
public override Type PartComponentModuleType => typeof(PartComponentModule_MyCustomModule);

=== OnStart(double universalTime) ===

* for new vessels this will run when the Flight view is loaded
* also runs on load for every vessel currently in Flight (don't need to be loaded).
* best used for any kind of initialization of backend tasks this vessel/module needs to go through

private Data_MyCustomModule _dataMyCustomModule;

public override void OnStart(double universalTime)
{

// set a reference to the Data class
if (!DataModules.TryGetByType<Data_MyCustomModule>(out _dataMyCustomModule))
{
_LOGGER.LogError("Unable to find a Data_MyCustomModule in the PartComponentModule for " + base.Part.PartName);
return;
}
Part.RegisterModuleForUpdates(this) // Register module for updates. Make sure to unregister when the part is being shut down!
// initialize resource requests
_dataMyCustomModule.SetupResourceRequest(base.resourceFlowRequestBroker);
}

=== OnUpdate ===

* this starts triggering when the vessel is first placed in Flight. Doesn't trigger in the OAB before that
* once the vessel is in Flight, it will always trigger, in any view, until the part is destroyed/recovered
* use this for tasks that need to continually run, even when vessel is unloaded. Be careful not to put expensive tasks here.
* NOTE: With the release of Redux you must *register the part module for updates*. This is to improve performance. Register it on OnStart() and unregister it on OnShutdown(), or when appropriate for your part module.

public override void OnUpdate(double universalTime, double deltaUniversalTime)
{
ResourceConsumptionUpdate(deltaUniversalTime); // example1: trigger resources consumption
UpdateStatusAndState(); // example2: do general status updates if needed
}

=== Resource consumption ===
private void ResourceConsumptionUpdate(double deltaTime)
{
if (_dataMyCustomModule.UseResources)
{
if (GameManager.Instance.Game.SessionManager.IsDifficultyOptionEnabled("InfinitePower"))
{
_dataMyCustomModule.HasResourcesToOperate = true;
if (base.resourceFlowRequestBroker.IsRequestActive(_dataMyCustomModule.RequestHandle))
{
base.resourceFlowRequestBroker.SetRequestInactive(_dataMyCustomModule.RequestHandle);
return;
}
}
else
{
if (this._hasOutstandingRequest)
{
this._returnedRequestResolutionState =
base.resourceFlowRequestBroker.GetRequestState(_dataMyCustomModule.RequestHandle);
_dataMyCustomModule.HasResourcesToOperate = this._returnedRequestResolutionState.WasLastTickDeliveryAccepted;
}
this._hasOutstandingRequest = false;
if (!_dataMyCustomModule.EnabledToggleProperty.GetValue() &&
base.resourceFlowRequestBroker.IsRequestActive(_dataMyCustomModule.RequestHandle))
{
base.resourceFlowRequestBroker.SetRequestInactive(_dataMyCustomModule.RequestHandle);
_dataMyCustomModule.HasResourcesToOperate = false;
}
else if (_dataMyCustomModule.EnabledToggle.GetValue() &&
base.resourceFlowRequestBroker.IsRequestInactive(_dataMyCustomModule.RequestHandle))
{
base.resourceFlowRequestBroker.SetRequestActive(_dataMyCustomModule.RequestHandle);
}
if (_dataMyCustomModule.EnabledToggleProperty.GetValue())
{
_dataMyCustomModule.RequestConfig.FlowUnits = (double)_dataMyCustomModule.RequiredResource.Rate;
base.resourceFlowRequestBroker.SetCommands(_dataMyCustomModule.RequestHandle, 1.0,
new ResourceFlowRequestCommandConfig[] { _dataMyCustomModule.RequestConfig });
this._hasOutstandingRequest = true;
return;
}
}
}
else
{
_dataMyCustomModule.HasResourcesToOperate = true;
}
}

=== OnShutdown ===

* define behaviour when the Part Component instance will be destroyed
* cases: part has been destroyed, exiting the game

public override void OnShutdown()
{ .. }