This is the codebase for the Orbstation fork of the tgstation build of SpaceStation 13.
Orbstation is focused around removing the more unpleasant/bigoted flavor of tgstation, improving support/balancing for small servers, and adding fun mechanics and additions that would likely not be approved upstream.
Orbstation is primarily run on a single, private BYOND server. Instructions for joining and announcements of upcoming sessions are posted on the Orbstation Discord server, which is currently invite-only.
-
Make a fork of the
orbstation/orbstationbranch under your own github account to keep your changes in.- If you plan on working on multiple discrete changes at once (say, adding a new item, rebalancing a weapon, and modifying some flavor text), make a separate branch on your fork for each separate change — this makes it easier to make separate pull requests later on.
-
Download your fork to your computer using your Git manager of choice. For those new to Git, Github Desktop is free and easy to use.
-
Make your changes using an IDE of your choice.
-
VSCode with the BYOND support extension is highly recommended, as it features code completion and a shortcut (f5) to compile, run, and connect to a server. No more messing around with DreamDaemon!
-
If possible (usually when adding new features instead of removing or modifying existing ones), place modifications in the Orbstation folder. This keeps features unique to Orbstation organized and helps to prevent future merge conflicts.
-
-
Submit a pull request from your local fork or branch to the
orbstation/orbstationbranch.
Please note that orbstation/master is a copy of the tgstation/master branch from upstream, and is used primarily to help with merging things from upstream to Orbstation. If you want to submit a change to the upstream Tgstation repo, send a pull request to tgstation/master, not orbstation/master.
| Website | Link |
|---|---|
| Website | https://www.tgstation13.org |
| Code | https://github.com/tgstation/tgstation |
| Wiki | https://tgstation13.org/wiki/Main_Page |
| Codedocs | https://codedocs.tgstation13.org/ |
| /tg/station Discord | https://tgstation13.org/phpBB/viewforum.php?f=60 |
| Coderbus Discord | https://discord.gg/Vh8TJp9 |
This is the codebase for the /tg/station flavoured fork of SpaceStation 13.
Space Station 13 is a paranoia-laden round-based roleplaying game set against the backdrop of a nonsensical, metal death trap masquerading as a space station, with charming spritework designed to represent the sci-fi setting and its dangerous undertones. Have fun, and survive!
All github inquiries (such as moderation actions) may be handled via the /tg/station discord #coding-general. Simply ping the @Maintainer role, following the guide on asking questions located in the channel description, with your issue!
The quick way. Find bin/server.cmd in this folder and double click it to automatically build and host the server on port 1337.
The long way. Find bin/build.cmd in this folder, and double click it to initiate the build. It consists of multiple steps and might take around 1-5 minutes to compile. If it closes, it means it has finished its job. You can then setup the server normally by opening tgstation.dmb in DreamDaemon.
Building tgstation in DreamMaker directly is deprecated and might produce errors, such as 'tgui.bundle.js': cannot find file.
How to compile in VSCode and other build options.
For contribution guidelines refer to the Guides for Contributors.
For getting started (dev env, compilation) see the HackMD document here.
For overall design documentation see HackMD.
For lore, see Common Core.
All code after commit 333c566b88108de218d882840e61928a9b759d8f on 2014/31/12 at 4:38 PM PST is licensed under GNU AGPL v3.
All code before commit 333c566b88108de218d882840e61928a9b759d8f on 2014/31/12 at 4:38 PM PST is licensed under GNU GPL v3. (Including tools unless their readme specifies otherwise.)
See LICENSE and GPLv3.txt for more details.
The TGS DMAPI is licensed as a subproject under the MIT license.
See the footer of code/__DEFINES/tgs.dm and code/modules/tgs/LICENSE for the MIT license.
All assets including icons and sound are under a Creative Commons 3.0 BY-SA license unless otherwise indicated.