Space Station 14 Documentation

repository·master·Indexed 25 days ago

https://github.com/space-wizards/space-station-14

A remake of SS13 built on the Robust Toolbox engine and written in C#. This repository contains both the engine and the content pack required to host or develop game content. Documentation covers building from source, licensing for code and assets, and a comprehensive list of client and server console commands for debugging, mapping, and administration.

Tokens
38.2K
Snippets
149
Records
490
Agent score
86%

What's inside Space Station 14

  1. Understand Space Station 14 licensing

    master

    The project uses different licenses for code and assets:

    • Code: Licensed under the MIT license.
    • Assets: Most assets are licensed under CC-BY-SA 3.0. Individual asset licenses and copyright information are specified in their respective metadata files (e.g., meta.json within an .rsi folder).

    Warning: Some assets may be licensed under non-commercial licenses (like CC-BY-NC-SA 3.0). These must be removed if you intend to use the project commercially.

  2. Build Space Station 14 from source

    master

    To build Space Station 14, you must first clone the repository, initialize submodules and the engine using the provided Python script, and then compile the solution using the .NET CLI.

    Note: This repository contains both the RobustToolbox engine and the content pack used for development.

  3. Configure CCVar configuration presets

    master

    Use the config.presets CVar to specify one or more configuration presets to load during server startup.

    • Format: A comma-separated list of preset names.
    • Requirements: Presets must be located in the ConfigPresets/ resource directory and must have a .toml extension.
    • Usage: Provide only the file name without the extension.
    • Scope: This is a SERVERONLY variable.
  4. Troubleshoot addaction command errors

    master

    If the addaction command fails, check for the following error conditions:

    • Invalid arguments: Ensure you have provided exactly two arguments.
    • Invalid entity UID: The first argument must be a valid numeric entity UID.
    • Missing ActionsComponent: The target entity must already possess an ActionsComponent to receive new actions.
    • Action prototype not found: The second argument must correspond to an existing EntityPrototype ID that includes an ActionComponent.
    • Adding failed: The system was unable to successfully attach the action to the entity.
  5. Troubleshoot ghost command errors

    master

    If the ghost command fails, check the following error messages to identify the cause:

    • You have no session, you can't ghost.: You are not currently in an active session.
    • You cannot ghost right now.: The action is currently denied by the server or game state.
    • You can't ghost right now. You are not in the game!: You are attempting to ghost while not actively participating in a game instance.