Files
tbd-station-14/README.md
hereelabs fef76dbe3c
Some checks failed
Build & Test Map Renderer / build (ubuntu-latest) (push) Has been cancelled
Build & Test Map Renderer / Build & Test Debug (push) Has been cancelled
Build & Test Debug / Build & Test Debug (push) Has been cancelled
Build & Test Debug / build (ubuntu-latest) (push) Has been cancelled
RGA schema validator / YAML RGA schema validator (push) Has been cancelled
RSI Validator / Validate RSIs (push) Has been cancelled
Map file schema validator / YAML map schema validator (push) Has been cancelled
YAML Linter / YAML Linter (push) Has been cancelled
Update README.md
2025-11-24 02:52:48 +01:00

66 lines
3.5 KiB
Markdown

<div class="header" align="center">
<img alt="TBD Station 14" width="650" height="300" src="https://git.tbdpowered.net/tommy/tbd-station-14/raw/commit/e5693a19d772797fcc13c625d4a354d8b5b49016/Resources/Textures/Logo/logo-large.png">
</div>
Space Station 14 is a remake of SS13 that runs on [Robust Toolbox](https://github.com/space-wizards/RobustToolbox), a homegrown engine written in C#.
This is the primary repo for TBD Station 14, a fork of Space Station 14 just for TBD. To prevent people forking RobustToolbox, a "content" pack is loaded by the client and server. This content pack contains everything needed to play the game on one specific server.
If you want to host or create content for TBD Station 14, this is the repo you need. It contains both RobustToolbox and the code that TBD Station runs on.
## Links
<div class="header" align="center">
[Website](https://spacestation14.com/) | [Discord](https://discord.ss14.io/) | [Steam](https://store.steampowered.com/app/1255460/Space_Station_14/) | [Standalone Download](https://spacestation14.com/about/nightlies/)
</div>
## Documentation/Wiki
The Space Wizards [docs site](https://docs.spacestation14.com/) has documentation on SS14's content, engine, game design, and more.
Additionally, see these resources for license and attribution information:
- [Robust Generic Attribution](https://docs.spacestation14.com/en/specifications/robust-generic-attribution.html)
- [Robust Station Image](https://docs.spacestation14.com/en/specifications/robust-station-image.html)
## Contributing
We are happy to accept contributions from anybody from TBD. Our only guideline is that your code works. Please test it before opening a pull request!
We are not currently accepting translations of the game on our main repository. If you would like to translate the game into another language, consider creating a fork or contributing to a fork.
## AI-generated contributions disclaimer
This project does not accept low-effort or wholesale AI-generated contributions. Examples include, but are not limited to:
- Any code (including yaml) generated by tools like GitHub Copilot, ChatGPT, or similar.
- AI-created artwork, sound files, or other assets.
- Auto-generated documentation, issue reports or pull request descriptions.
Exceptions to this are simple tools like Rider's single-line completion feature.
## Building
1. Clone this repo:
```shell
git clone https://git.tbdpowered.net/tommy/tbd-station-14.git
```
2. Go to the project folder and run `RUN_THIS.py` to initialize the submodules and load the engine:
```shell
cd tbd-station-14
python RUN_THIS.py
```
3. Compile the solution:
Build the server using `dotnet build`.
[More detailed instructions on building the project.](https://docs.spacestation14.com/en/general-development/setup.html)
## License
All code for the content repository is licensed under the [MIT license](https://git.tbdpowered.net/tommy/tbd-station-14/src/branch/master/LICENSE.TXT).
Most assets are licensed under [CC-BY-SA 3.0](https://creativecommons.org/licenses/by-sa/3.0/) unless stated otherwise. Assets have their license and copyright specified in the metadata file. For example, see the [metadata for a crowbar](https://git.tbdpowered.net/tommy/tbd-station-14/src/branch/master/Resources/Textures/Objects/Tools/crowbar.rsi/meta.json).
> [!NOTE]
> Some assets are licensed under the non-commercial [CC-BY-NC-SA 3.0](https://creativecommons.org/licenses/by-nc-sa/3.0/) or similar non-commercial licenses and will need to be removed if you wish to use this project commercially.