se-dev

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

SE Dev — Space Engineers Development Overview

SE 开发 — Space Engineers 开发概览

Applies only to Space Engineers version 1.
Entry point and table of contents for
se-dev-*
skills. Read this first to get big picture, then open specific skill the task needs. Does not perform searches or builds itself — routes you to the skill that does.
仅适用于Space Engineers版本1。
这是
se-dev-*
系列技能的入口与目录。先阅读本文以了解整体概况,再根据任务需求打开对应的具体技能。本文本身不执行搜索或构建操作——仅引导你前往具备对应功能的技能。

The three ways to extend the game

扩展游戏的三种方式

LayerWhat it isRuns asLanguage limitSkill
In-game scriptCode in Programmable Block (PB)Sandboxed, compiled by gameC# 6.0, PB API whitelist
se-dev-script
ModWorld/server content & scripts, Steam WorkshopSandboxed, compiled by gameC# 7.3, Mod API whitelist
se-dev-mod
PluginNative DLL patching game with HarmonyUnsandboxed, full .NETNo limit (
latestMinor
)
se-dev-plugin
Scripts and mods constrained by API whitelists and run inside game's sandbox. Plugins run native code with no sandbox — can do anything, which is why they are open source and reviewed before release.
层级定义运行方式语言限制技能
游戏内脚本可编程方块(PB)中的代码沙箱环境,由游戏编译C# 6.0,PB API白名单
se-dev-script
Mod世界/服务器内容与脚本,Steam创意工坊沙箱环境,由游戏编译C# 7.3,Mod API白名单
se-dev-mod
插件使用Harmony对游戏进行原生DLL补丁无沙箱限制,完整.NET环境无限制(
latestMinor
se-dev-plugin
脚本和Mod受API白名单限制,运行在游戏的沙箱环境中。插件运行原生代码且无沙箱限制——可以执行任意操作,因此它们都是开源的,并且在发布前会经过审核。

Where plugins run: client vs server

插件的运行环境:客户端 vs 服务器

A plugin targets the game client, the dedicated server, or both (sharing code).
Game clientDedicated serverTorch (legacy)
LoaderPulsarMagnetarTorch
RegistryPluginHubMagnetarHubtorchapi.net
Admin UIin-game config dialogQuasar (remote control plane)Torch WPF UI
Skill
se-dev-plugin
(
ClientPlugin
)
se-dev-plugin
(
ServerPlugin
) +
se-dev-plugin-sdk
se-dev-torch
  • Pulsar — plugin & mod loader for game client. Lists and loads plugins from PluginHub. Compiles client plugins from source on player's machine.
  • Magnetar — plugin loader for dedicated server (hard fork of Pulsar). Lists and loads server plugins from MagnetarHub. Server plugins declare their configuration through Magnetar's PluginSdk.
  • Quasar — control plane with Web UI to manage Magnetar instances. Lists Magnetar-compatible server plugins from MagnetarHub and lets admins configure them remotely; configuration UI is the layout each plugin declares via PluginSdk.
  • Torch — older, separate dedicated-server host with its own plugin model. Torch plugins not compatible with Magnetar and vice versa. Covered only by
    se-dev-torch
    /
    se-dev-torch-book
    skills, kept for maintaining existing Torch plugins.
插件可以面向游戏客户端专用服务器,或同时面向两者(共享代码)。
游戏客户端专用服务器Torch(旧版)
加载器PulsarMagnetarTorch
注册表PluginHubMagnetarHubtorchapi.net
管理UI游戏内配置对话框Quasar(远程控制平面)Torch WPF UI
技能
se-dev-plugin
ClientPlugin
se-dev-plugin
ServerPlugin
) +
se-dev-plugin-sdk
se-dev-torch
  • Pulsar — 游戏客户端的插件与Mod加载器。从**PluginHub**获取并加载插件,在玩家机器上从源码编译客户端插件。
  • Magnetar — 专用服务器的插件加载器(基于Pulsar的硬分叉)。从**MagnetarHub获取并加载服务器插件。服务器插件通过Magnetar的PluginSdk**声明其配置。
  • Quasar — 带有Web UI的控制平面,用于管理Magnetar实例。从MagnetarHub获取兼容Magnetar的服务器插件,允许管理员远程配置;配置UI由每个插件通过PluginSdk声明的布局生成。
  • Torch — 较早的独立专用服务器宿主,拥有自己的插件模型。**Torch插件与Magnetar不兼容,反之亦然。**仅由
    se-dev-torch
    /
    se-dev-torch-book
    技能覆盖,用于维护现有Torch插件。

Skill map

技能图谱

Authoring skills (write scripts, mods, plugins)

创作类技能(编写脚本、Mod、插件)

  • se-dev-script — In-game (Programmable Block) script development. Search example PB scripts.
  • se-dev-mod — Mod development. Search example mod code; Mod API whitelist.
  • se-dev-plugin — Client and server plugin development (Harmony patching, transpilers, preloader). Search plugin source from PluginHub.
  • se-dev-plugin-sdk — Handbook for Magnetar's PluginSdk: declaring server config variables, UI layout Quasar renders, server-side chat commands, server lifecycle (save/reload/quit/restart), path resolution and environment-agnostic logging. Use together with
    se-dev-plugin
    for server plugins. (Lives in Magnetar repo.)
  • se-dev-torch — Torch plugin development (legacy server host). Torch-only; not Magnetar-compatible.
  • se-dev-script — 游戏内(可编程方块)脚本开发。搜索PB脚本示例。
  • se-dev-mod — Mod开发。搜索Mod代码示例;查看Mod API白名单。
  • se-dev-plugin — 客户端与服务器插件开发(Harmony补丁、转译器、预加载器)。从PluginHub搜索插件源码。
  • se-dev-plugin-sdk — Magnetar PluginSdk手册:声明服务器配置变量、Quasar渲染的UI布局、服务器端聊天命令、服务器生命周期(保存/重载/退出/重启)、路径解析与环境无关的日志记录。开发服务器插件时需与
    se-dev-plugin
    配合使用。(位于Magnetar仓库中。)
  • se-dev-torch — Torch插件开发(旧版服务器宿主)。仅适用于Torch;与Magnetar不兼容。

Graphify graphs (read on demand)

Graphify 图谱(按需查阅)

  • GraphifyPrepare.md — how each subskill builds its own per-subskill
    graphify-out/
    . Prepare installs Graphify on Python 3.12 with the fast native Rust Leiden clustering backend and, when that backend is available (Linux/Windows with
    uv
    ), builds the graph automatically — clustering then takes ~1-2 minutes even for the game/server corpora. Where the fast backend cannot be provisioned, Graphify stays optional and only builds on opt-in with
    SE_DEV_GRAPHIFY=1
    (the slow single-core fallback adds ~10-30 minutes; prepare reports this).
    SE_DEV_GRAPHIFY=0
    disables it entirely. Also covers the health check that detects an unusable (unclustered) graph and the clean-and-rebuild flow.
  • GraphifyUsage.md — how to query an existing graph (
    query
    /
    explain
    /
    path
    /
    affected
    ), the large-graph load cap, and the query test scripts.
These two docs are fetched on demand: skip them entirely unless the user specifically wants the Graphify graph, so the extra tooling never pollutes context during normal work.
  • GraphifyPrepare.md — 各子技能如何构建各自的
    graphify-out/
    目录。准备步骤会在Python 3.12 + 快速原生Rust Leiden聚类后端环境下安装Graphify,当该后端可用时(Linux/Windows系统搭配
    uv
    ),会自动构建图谱——即使是游戏/服务器语料库,聚类也仅需约1-2分钟。若无法部署快速后端,Graphify则为可选工具,仅当设置
    SE_DEV_GRAPHIFY=1
    时才会构建(慢单核心回退方案需额外约10-30分钟;准备步骤会告知此情况)。
    SE_DEV_GRAPHIFY=0
    会完全禁用该功能。本文还涵盖了检测不可用(未聚类)图谱的健康检查,以及清理重建流程。
  • GraphifyUsage.md — 如何查询现有图谱(
    query
    /
    explain
    /
    path
    /
    affected
    )、大图加载上限,以及查询测试脚本。
这两份文档为按需获取:除非用户明确需要Graphify图谱,否则可完全跳过,避免额外工具在日常工作中占用上下文资源。

Reference skills (read/search the game internals)

参考类技能(查阅/搜索游戏内部实现)

  • se-dev-game-code — Search decompiled C# of game client. Recommended companion for client mod/plugin work.
  • se-dev-server-code — Search decompiled C# of dedicated server. Companion for server-side mod/plugin work.
The
*-book
skills mentioned below (
se-dev-game-book
,
se-dev-server-book
,
se-dev-torch-book
) are private/internal handbooks distributed separately, not part of this public repository. Use them if they are installed; otherwise fall back to the corresponding
*-code
search skill.
  • se-dev-game-code — 搜索游戏客户端的反编译C#代码。推荐作为客户端Mod/插件开发的配套工具。
  • se-dev-server-code — 搜索专用服务器的反编译C#代码。作为服务器端Mod/插件开发的配套工具。
下文提及的
*-book
技能(
se-dev-game-book
se-dev-server-book
se-dev-torch-book
)为私有/内部手册,单独分发,不属于此公开仓库。若已安装则可使用;否则请回退至对应的
*-code
搜索技能。

How to pick

技能选择指南

  • Programmable Block script?
    se-dev-script
    (+
    se-dev-game-code
    /
    se-dev-game-book
    for API details).
  • Steam Workshop mod?
    se-dev-mod
    (+
    se-dev-game-code
    /
    se-dev-server-code
    as needed).
  • Client plugin?
    se-dev-plugin
    +
    se-dev-game-code
    (and
    se-dev-game-book
    for orientation).
  • Server plugin (Magnetar)?
    se-dev-plugin
    +
    se-dev-plugin-sdk
    +
    se-dev-server-code
    (and
    se-dev-server-book
    ).
  • Maintaining a Torch plugin?
    se-dev-torch
    +
    se-dev-torch-book
    (and
    se-dev-server-code
    ).
  • Need to understand how the game does X?
    *-code
    skills to search source,
    *-book
    skills for orientation.
Most non-trivial tasks pair an authoring skill with a reference skill: write with one, look up game's internals with the other.
  • 开发可编程方块脚本?
    se-dev-script
    (+
    se-dev-game-code
    /
    se-dev-game-book
    以获取API细节)。
  • 开发Steam创意工坊Mod?
    se-dev-mod
    (+ 按需使用
    se-dev-game-code
    /
    se-dev-server-code
    )。
  • 开发客户端插件?
    se-dev-plugin
    +
    se-dev-game-code
    (+
    se-dev-game-book
    以获取入门指引)。
  • 开发服务器插件(Magnetar)?
    se-dev-plugin
    +
    se-dev-plugin-sdk
    +
    se-dev-server-code
    (+
    se-dev-server-book
    )。
  • 维护Torch插件?
    se-dev-torch
    +
    se-dev-torch-book
    (+
    se-dev-server-code
    )。
  • 想了解游戏如何实现功能X? → 使用
    *-code
    技能搜索源码,使用
    *-book
    技能获取入门指引。
大多数非简单任务会将创作类技能与参考类技能搭配使用:用前者编写代码,用后者查阅游戏内部实现。

Plugin templates

插件模板

  • se-client-plugin-template — 仅客户端插件模板。
  • se-server-plugin-template — 客户端 + Magnetar服务器插件模板(
    ClientPlugin
    ServerPlugin
    Shared
    )。若开发Torch插件,请基于模板的
    last-torch-compatible
    标签,而非
    main
    分支。

Remarks

备注

Original source of these skills: https://github.com/CometWorks/skills
这些技能的原始来源:https://github.com/CometWorks/skills