Skip to content
DM HTML JavaScript Python CSS PHP Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github make me code owner of atmos Jan 21, 2020
.vscode Add vscode extension to use the .editorconfig (#42606) Jan 31, 2019
SQL Adds the cargoking and ducatduke achievements (#7305) Dec 24, 2019
_maps Merge pull request #7701 from Ktlwjec1/7481200325 Jan 26, 2020
code Merge pull request #7717 from Hopekz/Stephoscope_Craft Jan 28, 2020
config Add config option for making everyone a donator (#7357) Dec 19, 2019
goon adds the actual scream Jul 6, 2019
html Automatic changelog generation #7717 [ci skip] Jan 28, 2020
icons Merge pull request #7720 from Idinuum/syringe Jan 28, 2020
interface buttons colors (#7429) Dec 31, 2019
sound Merge pull request #7269 from monster860/monstermos Dec 17, 2019
strings remove outdated wizard tips (#7531) Jan 7, 2020
tgui-next More tgui-next (#7383) Jan 2, 2020
tgui Ports guardian rework from hippie (#7201) Dec 28, 2019
tools Adds script to automatically compress replays (#7448) Dec 30, 2019
yogstation Merge pull request #7685 from SomeguyManperson/not_a_jojo_reference Jan 28, 2020
.dockerignore fix some tg stuff Jul 22, 2018
.editorconfig Update (#2) Dec 14, 2019
.gitattributes Enforces line endings Aug 12, 2019
.gitignore quit bugging me (#7345) Dec 17, 2019
.travis.yml [MIRROR] Split Travis shell scripts by job (#6213) Jul 23, 2019
BSQL.dll Merge pull request #39336 from Cyberboss/BSQLUpdate Jul 29, 2018
Dockerfile Update (#2) Dec 14, 2019
GPLv3.txt Cyberboss vs LICENSE round 27 (#33174) Dec 1, 2017
LICENSE Attempt 2 at getting licensing detection to work Nov 20, 2017 fix travis button (#6682) Sep 8, 2019
TGS3.json Remove rusty from tgs3.json (#37404) Apr 24, 2018
appveyor.yml Add more TGS ignore branches (#40353) Sep 19, 2018
compile.cmd Created compile batch script (#7004) Nov 5, 2019 Update (#2) Dec 14, 2019
libmariadb.dll Adds BSQL (#38323) Jul 16, 2018
libvg.dll Ports LibVG Mar 15, 2018 test Mar 6, 2018
quickwrite.dll E (#11) Nov 26, 2019
rust_g.dll ok Jan 12, 2019
yogstation.dme Merge pull request #7685 from SomeguyManperson/not_a_jojo_reference Jan 28, 2020

Yogstation codebase

Build Status






There are a number of ways to download the source code. Some are described here, an alternative all-inclusive guide is also located at

Option 1: Follow this:

Option 2: Download the source code as a zip by clicking the ZIP button in the code tab of (note: this will use a lot of bandwidth if you wish to update and is a lot of hassle if you want to make any changes at all, so it's not recommended.)


First-time installation should be fairly straightforward. First, you'll need BYOND installed. You can get it from Once you've done that, extract the game files to wherever you want to keep them. This is a sourcecode-only release, so the next step is to compile the server files. Open yogstation.dme by double-clicking it, open the Build menu, and click compile. This'll take a little while, and if everything's done right you'll get a message like this:

saving yogstation.dmb (DEBUG mode)
yogstation.dmb - 0 errors, 0 warnings

If you see any errors or warnings, something has gone wrong - possibly a corrupt download or the files extracted wrong. If problems persist, ask for assistance in irc:// or in #development-public on discord.

Once that's done, open up the config folder. You'll want to edit config.txt to set the probabilities for different gamemodes in Secret and to set your server location so that all your players don't get disconnected at the end of each round. It's recommended you don't turn on the gamemodes with probability 0, except Extended, as they have various issues and aren't currently being tested, so they may have unknown and bizarre bugs. Extended is essentially no mode, and isn't in the Secret rotation by default as it's just not very fun.

You'll also want to edit config/admins.txt to remove the default admins and add your own. "Game Master" is the highest level of access, and probably the one you'll want to use for now. You can set up your own ranks and find out more in config/admin_ranks.txt

The format is

byondkey = Rank

where the admin rank must be properly capitalised.

This codebase also depends on a native library called rust-g. A precompiled Windows DLL is included in this repository, but Linux users will need to build and install it themselves. Directions can be found at the rust-g repo.

Finally, to start the server, run Dream Daemon and enter the path to your compiled yogstation.dmb file. Make sure to set the port to the one you specified in the config.txt, and set the Security box to 'Safe'. Then press GO and the server should start up and be ready to join. It is also recommended that you set up the SQL backend (see below).


To update an existing installation, first back up your /config and /data folders as these store your server configuration, player preferences and banlist.

Then, extract the new files (preferably into a clean directory, but updating in place should work fine), copy your /config and /data folders back into the new install, overwriting when prompted except if we've specified otherwise, and recompile the game. Once you start the server up again, you should be running the new version.


If you'd like a more robust server hosting option for tgstation and its derivatives. Check out /tg/station's server tools suite at


Yogstation currently comes equipped with five maps.

All maps have their own code file that is in the base of the _maps directory. Maps are loaded dynamically when the game starts. Follow this guideline when adding your own map, to your fork, for easy compatibility.

The map that will be loaded for the upcoming round is determined by reading data/next_map.json, which is a copy of the json files found in the _maps tree. If this file does not exist, the default map from config/maps.txt will be loaded. Failing that, BoxStation will be loaded. If you want to set a specific map to load next round you can use the Change Map verb in game before restarting the server or copy a json from _maps to data/next_map.json before starting the server. Also, for debugging purposes, ticking a corresponding map's code file in Dream Maker will force that map to load every round.

If you are hosting a server, and want randomly picked maps to be played each round, you can enable map rotation in config.txt and then set the maps to be picked in the maps.txt file.

Anytime you want to make changes to a map it's imperative you use the Map Merging tools


Yogstation supports loading away missions however they are disabled by default.

Map files for away missions are located in the _maps/RandomZLevels directory. Each away mission includes it's own code definitions located in /code/modules/awaymissions/mission_code. These files must be included and compiled with the server beforehand otherwise the server will crash upon trying to load away missions that lack their code.

To enable an away mission open config/awaymissionconfig.txt and uncomment one of the .dmm lines by removing the #. If more than one away mission is uncommented then the away mission loader will randomly select one the enabled ones to load.


The SQL backend requires a Mariadb server running 10.2 or later. Mysql is not supported but Mariadb is a drop in replacement for mysql. SQL is required for the library, stats tracking, admin notes, and job-only bans, among other features, mostly related to server administration. Your server details go in /config/dbconfig.txt, and the SQL schema is in /SQL/tgstation_schema.sql and /SQL/tgstation_schema_prefix.sql depending on if you want table prefixes. More detailed setup instructions are located here:

If you are hosting a testing server on windows you can use a standalone version of MariaDB pre load with a blank (but initialized) tgdb database. Find them here: Just unzip and run for a working (but insecure) database server. Includes a zipped copy of the data folder for easy resetting back to square one.


Web delivery of game resources makes it quicker for players to join and reduces some of the stress on the game server.

  1. Edit to set the PRELOAD_RSC define to 0
  2. Add a url to config/external_rsc_urls pointing to a .zip file containing the .rsc.
    • If you keep up to date with /tg/ you could reuse /tg/'s rsc cdn at Otherwise you can use cdn services like CDN77 or cloudflare (requires adding a page rule to enable caching of the zip), or roll your own cdn using route 53 and vps providers.
    • Regardless even offloading the rsc to a website without a CDN will be a massive improvement over the in game system for transferring files.


Included in the repository is a python3 compatible IRC bot capable of relaying adminhelps to a specified IRC channel/server, see the /tools/minibot folder for more


Please see


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.

tgui clientside is licensed as a subproject under the MIT license. Font Awesome font files, used by tgui, are licensed under the SIL Open Font License v1.1 tgui assets are licensed under a Creative Commons Attribution-ShareAlike 4.0 International License. The TGS3 API is licensed as a subproject under the MIT license.

See tgui/ for the MIT license. See tgui/assets/fonts/ for the SIL Open Font License. See the footers of code/__DEFINES/, code/modules/server_tools/, and code/modules/server_tools/ for the MIT license.

All assets including icons and sound are under a Creative Commons 3.0 BY-SA license unless otherwise indicated.

You can’t perform that action at this time.