Welcome to the main repository for the Goonstation branch of Space Station 13.

SETUP

<img src=".github/assets/setup.png" alt="Setup" width="150" align="left">

Want to get the code up and running to test changes or play around? This guide is the place to go. <br>Be sure to follow it exactly! If you need help, visit the #imcoder channel on our Discord.

COMMUNITY

<img src=".github/assets/discord.png" alt="Discord" width="150" align="left"> Discord is the place to talk to fellow players, admins, and devs in realtime - it's our main community hub.<br> There's plenty of friendly people there, capable of answering most of your questions.

<img src=".github/assets/forums.png" alt="Forums" width="150" align="left"> The forums are where we get most of our player feedback/suggestions and talk about things in a more longform format. This is also the place to appeal any bans or give admin feedback.

<img src=".github/assets/wiki.png" alt="Goonhub" width="150" align="left"> Our wiki is the place to go for any info you seek on the various constructions, items, game modes, and really just anything in-game. Check out guides on game mechanics and jobs!

<img src=".github/assets/goonhub.png" alt="Goonhub" width="150" align="left"> Goonhub is the premier place for locating statistics, data about rounds (like funny last words), detailed game maps, medals, players, and all other links pertaining to Goonstation!

CONTRIBUTING

<img src=".github/assets/readme.png" alt="Contributing Guidelines" width="150" align="left"> Before opening a PR to this codebase, please read our contributor guidelines. It details the requirements of our PR format, and explains our changelog methodology.

<img src=".github/assets/code.png" alt="Code Documentation" width="150" align="left"> To contribute code to the game, please read our code guide. It details specific DM syntax we encourage, useful things, and some performance-oriented technical discussion.

<img src=".github/assets/sprites.png" alt="Spriting Guidelines" width="150" align="left"> To contribute sprites to the game, please follow our spriting guidelines! It details the various things we try to keep consistent in our sprites, such as perspective and outlining.

<img src=".github/assets/audio.png" alt="Audio Guidelines" width="150" align="left"> To contribute audio to the game, please follow our audio guidelines! It details what types of sounds we want to include, things to keep in mind, and the sound cache.

<img src=".github/assets/maps.png" alt="Mapping Guidelines" width="150" align="left"> To contribute maps to the game, please follow our mapping guidelines! It details the required pieces for a map submission. There's also guides on how to create a map.

<img src=".github/assets/docs.png" alt="Code Documentation" width="150" align="left"> For auto-generated code documentation, visit our code docs! There's some good guides for portions of our codebase, and you can familiarize yourself with our various helpers.

LICENSE

All Goonstation contributions are licensed under Creative Commons BY-NC-SA. See LICENSE for more details.

Contributions made under the tgui folder are licensed under MIT unless otherwise specified.

Important: This means that code from Goonstation cannot be ported to codebases such as /tg/station. If you wish to port a specific feature, you must get the developer(s) to sublicense it to you under a license like AGPLv3. This also applies in the opposite direction for features ported from other codebases.