mirror of
https://github.com/yogstation13/Yogstation.git
synced 2025-02-26 09:04:50 +00:00
cbd5a4a959
* Create STYLE.md * Create STANDARDS.md * Move AUTODOC.md * rip walk manager * Update CONTRIBUTING.md * Add link to porting section * A few changes * Move some README stuff to the guides folder * Feature freeze over * Typo * Modern maps * Add a few more guides * !!!
70 lines
3.7 KiB
Markdown
70 lines
3.7 KiB
Markdown
## Yogstation codebase
|
|
|
|
[](https://github.com/yogstation13/Yogstation/actions?query=workflow%3ATurdis+branch%3Amaster)
|
|
[](https://www.reddit.com/r/SS13/comments/5oplxp/what_is_the_main_problem_with_byond_as_an_engine/dclbu1a)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[**Website**](https://yogstation.net)
|
|
|
|
[**Code**](https://github.com/yogstation13/yogstation)
|
|
|
|
[**Wiki**](https://wiki.yogstation.net)
|
|
|
|
[**Discord**](https://discord.gg/0keg6hQH05Ha8OfO)
|
|
|
|
[**Yogstation GitHub Guidelines**](https://github.com/yogstation13/Yogstation/blob/master/.github/CONTRIBUTING.md#yogstation-github-guidelines)
|
|
|
|
|
|
|
|
## 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)
|
|
|
|
## :exclamation: How to compile :exclamation:
|
|
|
|
Recently we have changed the way to compile the codebase.
|
|
|
|
Find `BUILD.bat` here in the root folder of yogstation, and double click it to initiate the build. It consists of multiple steps and might take around 1-5 minutes to compile.
|
|
|
|
After it finishes, you can then setup the server normally by opening `yogstation.dmb` in DreamDaemon. See further down for instructions
|
|
|
|
**Building yogstation in DreamMaker directly is now deprecated and might produce errors**, such as `'tgui.bundle.js': cannot find file`.
|
|
|
|
## CONTRIBUTING
|
|
|
|
Please see [CONTRIBUTING.md](.github/CONTRIBUTING.md)
|
|
|
|
## 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.
|
|
|
|
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](https://creativecommons.org/licenses/by-sa/4.0/).
|
|
The TGS3 API is licensed as a subproject under the MIT license.
|
|
|
|
See tgui/LICENSE.md for the MIT license.
|
|
See tgui/assets/fonts/SIL-OFL-1.1-LICENSE.md for the SIL Open Font License.
|
|
See the footers of code/\_\_DEFINES/server\_tools.dm, code/modules/server\_tools/st\_commands.dm, and code/modules/server\_tools/st\_inteface.dm 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.
|