mirror of
https://github.com/Bubberstation/Bubberstation.git
synced 2026-01-28 18:11:16 +00:00
2e199c708b
## About The Pull Request This is a `README.md` update to more efficiently point potential contributors to the appropriate documentation for configuring their dev environment. ## Why It's Good For The Game It is typically best practice to make it easy for developers to quickly contribute a change to a project by making things as clear as possible.
66 lines
4.7 KiB
Markdown
66 lines
4.7 KiB
Markdown
## /tg/station codebase
|
|
|
|
[](https://github.com/tgstation/tgstation/actions?query=workflow%3A%22CI+Suite%22)
|
|
[](https://isitmaintained.com/project/tgstation/tgstation "Percentage of issues still open")
|
|
[](https://isitmaintained.com/project/tgstation/tgstation "Average time to resolve an issue")
|
|
|
|
|
|
[](.github/images/comics/131-bug-free.png) [](.github/images/comics/106-tech-debt-modified.png) [](https://www.reddit.com/r/SS13/comments/5oplxp/what_is_the_main_problem_with_byond_as_an_engine/dclbu1a)
|
|
|
|
| Website | Link |
|
|
|---------------------------|------------------------------------------------|
|
|
| Website | [https://www.tgstation13.org](https://www.tgstation13.org) |
|
|
| Code | [https://github.com/tgstation/tgstation](https://github.com/tgstation/tgstation) |
|
|
| Wiki | [https://tgstation13.org/wiki/Main_Page](https://tgstation13.org/wiki/Main_Page) |
|
|
| Codedocs | [https://codedocs.tgstation13.org/](https://codedocs.tgstation13.org/) |
|
|
| /tg/station Discord | [https://tgstation13.org/phpBB/viewforum.php?f=60](https://tgstation13.org/phpBB/viewforum.php?f=60) |
|
|
| Coderbus Discord | [https://discord.gg/Vh8TJp9](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](https://discord.com/channels/326822144233439242/326831214667235328). Simply ping the `@Maintainer` role, following the guide on asking questions located in the channel description, with your issue!*
|
|
|
|
## DOWNLOADING
|
|
[Downloading](.github/guides/DOWNLOADING.md)
|
|
|
|
[Running a server](.github/guides/RUNNING_A_SERVER.md)
|
|
|
|
[Maps and Away Missions](.github/guides/MAPS_AND_AWAY_MISSIONS.md)
|
|
|
|
## Compilation
|
|
|
|
**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](.github/guides/RUNNING_A_SERVER.md) 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](tools/build/README.md).**
|
|
|
|
## Getting started
|
|
|
|
For contribution guidelines refer to the [Guides for Contributors](.github/CONTRIBUTING.md).
|
|
|
|
For getting started (dev env, compilation) see the HackMD document [here](https://hackmd.io/@tgstation/HJ8OdjNBc#tgstation-Development-Guide).
|
|
|
|
For overall design documentation see [HackMD](https://hackmd.io/@tgstation).
|
|
|
|
For lore, [see Common Core](https://github.com/tgstation/common_core).
|
|
|
|
## LICENSE
|
|
|
|
All code after [commit 333c566b88108de218d882840e61928a9b759d8f on 2014/31/12 at 4:38 PM PST](https://github.com/tgstation/tgstation/commit/333c566b88108de218d882840e61928a9b759d8f) is licensed under [GNU AGPL v3](https://www.gnu.org/licenses/agpl-3.0.html).
|
|
|
|
All code before [commit 333c566b88108de218d882840e61928a9b759d8f on 2014/31/12 at 4:38 PM PST](https://github.com/tgstation/tgstation/commit/333c566b88108de218d882840e61928a9b759d8f) is licensed under [GNU GPL v3](https://www.gnu.org/licenses/gpl-3.0.html).
|
|
(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](./code/__DEFINES/tgs.dm) and [code/modules/tgs/LICENSE](./code/modules/tgs/LICENSE) for the MIT license.
|
|
|
|
All assets including icons and sound are under a [Creative Commons 3.0 BY-SA license](https://creativecommons.org/licenses/by-sa/3.0/) unless otherwise indicated.
|