Files
wiki/se-launcher/development.md
2025-07-09 08:19:50 +00:00

3.7 KiB
Raw Permalink Blame History

title, description, published, date, tags, editor, dateCreated
title description published date tags editor dateCreated
Plugin Development Information about creating and maintaining plugin for SE Launcher (CringeLauncher) true 2025-07-07T13:40:59.987Z markdown 2025-07-07T12:39:12.054Z

Plugin Development

Client plugins in SE Launcher (CringeLauncher) are designed to be significantly more powerful than regular Steam Workshop mods. They have the ability to modify game behavior at runtime, access internal APIs, and even patch the game code, including sensitive components like the DirectX 11 renderer of the game engine. This allows for extensive customization and feature development well beyond the capabilities of the vanilla modding system.

Note

: Prior experience with C# programming is required to start developing plugins.

You can start learning C# here:


Getting Started

To begin developing plugins for SE Launcher, follow the steps below:

1. Choose and Install an IDE

You will need a C#-capable integrated development environment. Below are some popular free options:

2. Install Plugin Templates

To create a plugin project, you need to install the official templates. Open a terminal or command prompt and execute:

dotnet new install CringePlugins.Templates --nuget-source https://ng.zznty.ru/v3/index.json

After installation, the SpaceEngineers Plugin Template will be available in your IDEs "Create New Project" menu.

3. Create and Launch the Plugin

Create a new project using the installed template. Once the project is created, you can start debugging the game directly from your IDE.

Here are typical hotkeys to start a debug session:

  • Visual Studio: F5 to start debugging, Shift + F5 to stop
  • Rider: Shift + F9 to debug, Shift + F10 to run
  • VS Code: F5 to start debugging

What Next?

Once youve created your initial plugin project, here are the next steps to explore and extend your plugin:

  1. Navigating Game Code
    Learn how to decompile the game to understand its internal structure.

  2. How to Create Configs
    Learn how to use the launcher's built-in config system to make your plugin configurable.

  3. Creating UIs
    Explore different built-in UI frameworks supported by the launcher for developing user interfaces.

  4. Patching Game Code
    Understand how to use the Harmony library to write runtime patches for the game.

  5. Publishing
    Instructions on preparing and publishing your plugin.

    5.1 Publishing to Official PluginHub
    Follow the guidelines to submit your plugin to the official PluginHub.

    5.2 Distributing via Your Own Source
    Learn how to host and distribute your plugin independently.