A retained-mode GUI framework for creating fully mod-defined UI in C# Space Engineers workshop mods. It enables the creation of scalable, resolution-independent, and fully interactive user interfaces using the game’s billboard system, in lieu of support in the mod API.
See the API reference for detailed overview, targeted examples and supplementary materials.
- Persistent node-based UI tree with automatic depth sorting, input routing, and parent-child hierarchy
- Full support for both screen-space (2D HUD) and world-space (3D) rendering
- Custom bitmap text renderer supporting rich-text formatting, automatic wrapping, and runtime-loadable custom fonts
- Centralized, serializable key-bind system with conflict groups, multiple aliases per bind, and automatic suppression of default game inputs
- Shared, standardized mod settings terminal with ready-made pages, categories, and controls (sliders, checkboxes, dropdowns, key-rebind panels, rich-text help/changelog pages, etc.)
- Library of pre-built, composable controls
The framework is split into three modules: Master, Client, and Shared because Space Engineers mods are compiled to independent assemblies. Data must be shared at runtime using common types and primitives.
- Master Module: The core logic (UI tree, text renderer, settings menu). This is the dependency that must be used on the Steam Workshop when publishing your mod.
- Client Module: The developer-facing API. This is the module you directly integrate into your scripted C# mod.
- Shared Module: Internal module. Common types and libraries duplicated in the other two modules.
To start, download a copy of the Client module from the releases page and include it in your mod. Detailed installation instructions are availale here.
A well-documented example Text Editor Mod is available here.
Rich HUD Master includes a demo built into the terminal. You can enable it using the chat command "/rhd toggledebug". This demo allows you to spawn most of the UI elements in the library in their default state while also allowing you to manipulate their HUD Space in real time.
