Home

Awesome

<a href="#"><img src=".github/assets/paradise.png" alt="Paradise Station"></a>

<p align="center">Welcome to the main repository for the Paradise Station version of Space Station 13.</p>

<p align="center"> <a href="https://github.com/ParadiseSS13/Paradise/actions?query=workflow%3ACI"><img src="https://github.com/ParadiseSS13/Paradise/workflows/CI/badge.svg" alt="CI"></a> <a href="https://github.com/ParadiseSS13/Paradise/actions?query=workflow%3A%22Render+Nanomaps%22"><img src="https://github.com/ParadiseSS13/Paradise/workflows/Render%20Nanomaps/badge.svg" alt="Render Nanomaps"></a> <a href="http://isitmaintained.com/project/paradisess13/paradise"><img src="http://isitmaintained.com/badge/resolution/paradisess13/paradise.svg" alt="Average time to resolve an issue"></a> <a href="http://isitmaintained.com/project/paradisess13/paradise"><img src="http://isitmaintained.com/badge/open/paradisess13/paradise.svg" alt="Percentage of issues still open"></a> </p> <p align="center"> <a href="https://xkcd.com/371/"><img src=".github/assets/compiles-sometimes.svg" alt="Compiles sometimes"></a> <a href="https://www.reddit.com/r/SS13/comments/5oplxp/what_is_the_main_problem_with_byond_as_an_engine/dclbu1a/"><img src=".github/assets/made-in-byond.gif" alt="Made in BYOND"></a> <a href="https://xkcd.com/1811/"><img src=".github/assets/made-with-crayons.svg" alt="Made with crayons"></a> </p> <p align="center"> <a href="https://discord.gg/paradisess13"> <picture> <source media="(prefers-color-scheme: dark)" srcset=".github/assets/discord-light.png"> <source media="(prefers-color-scheme: light)" srcset=".github/assets/discord-dark.png"> <img width="15%" alt="Discord" hspace="3%" src=".github/assets/discord-dark.png"> </picture> </a> <a href="https://devdocs.paradisestation.org"> <picture> <source media="(prefers-color-scheme: dark)" srcset=".github/assets/book-light.png"> <source media="(prefers-color-scheme: light)" srcset=".github/assets/book-dark.png"> <img alt="Code docs" width="15%" hspace="3%" src=".github/assets/book-dark.png"> </picture> </a> <a href="https://www.paradisestation.org/"> <picture> <source media="(prefers-color-scheme: dark)" srcset=".github/assets/web-light.png"> <source media="(prefers-color-scheme: light)" srcset=".github/assets/web-dark.png"> <img width="15%" alt="Website" hspace="3%" src=".github/assets/web-dark.png"> </picture> </a> <a href="https://paradisestation.org/wiki"> <picture> <source media="(prefers-color-scheme: dark)" srcset=".github/assets/wiki-light.png"> <source media="(prefers-color-scheme: light)" srcset=".github/assets/wiki-dark.png"> <img width="15%" alt="Game Wiki" hspace="3%" src=".github/assets/wiki-dark.png"> </picture> </a> </p>

[!TIP] Want to contribute for the first time but unsure where to start?<br> Join our Discord and check out the #coding_chat channel for helpful links and advice!<br> Alternatively, have a look at our community maintained Getting Started Guide

Useful Documents and Links

This reference site by the creators of BYOND details information on the DM language, the syntax used, functionality of native procs, and a lot more. This is always useful to have on hand when contributing.

This guide shows you how to leave code comments that comply with "autodocumentation", a system designed to make everyone's lives easier when reading or reviewing code!

All contributors are expected to read our Code of Conduct before they take part in our community.

Not sure how to take part and contribute? This guide gives an overview of how to make comments, pull requests, and open issues.

This guide also sets out our code standards that we expect all submitted code to adhere to.

This community maintained guide covers how to set yourself up for success when attempting to contribute to Paracode.

[!IMPORTANT] Paradise does not provide precompiled binaries, requiring you to build from source to host a local server.<br> Building Paradise is quick and simple, all you need to install is BYOND.<br>

A detailed policy document that governs how the Paradise Station Development Team functions, from the various roles that help keep things running to the process each PR goes through depending on the content.

TGUI is a user interface framework, built on InfernoJS, for all new player-facing UIs.

TGUI is very different to most other BYOND user interfaces as it is written entirely in JavaScript with some data passed to and from DreamMaker. If you are looking to get to grips with TGUI, this tutorial is a good starting point. Additional information can also be found here.

Mapping for Paradise station can be daunting to new contributors. Here's a comprehensive quick-start put together by a community member that takes you from A-Z.


LICENSES

[!CAUTION] If you wish to use our code in a closed source manner (i.e. not make it available to the public and/or those who connect to services you offer using this code) you must only use code prior to commit 1af3ddef2af85937251e24384c2173c4b6c3222b on 2015/01/05 22:04 GMT, which is licenced under GPLv3.

Click each banner for further information


<details> <summary><a href="#"><img src="https://img.shields.io/badge/licence-AGPL_3-red?style=for-the-badge" alt="AGPLv3 license"></a></summary>

All code after and including commit 1af3ddef2af85937251e24384c2173c4b6c3222b on 2015/01/05 22:04 GMT is licensed under the GNU Affero General Public License version 3 unless otherwise specified within the folder or file.

</details> <details> <summary><a href="#"><img src="https://img.shields.io/badge/licence-GPL_3-orange?style=for-the-badge" alt="GPLv3 license"></a></summary>

All code prior to commit 1af3ddef2af85937251e24384c2173c4b6c3222b on 2015/01/05 22:04 GMT is licensed under the GPL General Public License version 3

</details> <details> <summary><a href="#"><img src="https://img.shields.io/badge/licence-MIT-green?style=for-the-badge" alt="MIT license"></a></summary>

Some files are licenced under the MIT license, these files will clearly specify this licence at the head of each file.

</details> <details> <summary><a href="#"><img src="https://img.shields.io/badge/licence-CC_3.0_BY--NC--SA-blue?style=for-the-badge" alt="Creative Commons 3.0 BY-NC-SA" align="centre"></a></summary>

Any files with the ancestor directories Paradise/icons/goonstation or Paradise/sound/goonstation are licensed under the Creative Commons 3.0 BY-NC-SA license.

Further files or folders may also fall under this licence, and any such instances will be specified within the folder or file.

</details> <details> <summary><a href="#"><img src="https://img.shields.io/badge/licence-CC_3.0_BY--SA-lightblue?style=for-the-badge" alt="Creative Commons 3.0 BY-SA"></a></summary>

All other non-code assets, including icons and sound files, are licensed under the Creative Commons 3.0 BY-SA license, unless otherwise specified within the folder or file.

</details>