-
Notifications
You must be signed in to change notification settings - Fork 557
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'cmss13-devs:master' into Hybrisa
- Loading branch information
Showing
60 changed files
with
972 additions
and
1,012 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes.
Large diffs are not rendered by default.
Oops, something went wrong.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,37 +1,85 @@ | ||
## CM-SS13 codebase | ||
|
||
<a href="https://www.monkeyuser.com/assets/images/2019/131-bug-free.png"><img src="https://img.shields.io/badge/Built_with-Resentment-orange?style=for-the-badge&labelColor=%23D47439&color=%23C36436" width=260px></a> <a href="https://user-images.githubusercontent.com/8171642/50290880-ffef5500-043a-11e9-8270-a2e5b697c86c.png"><img src="https://img.shields.io/badge/Contains-Technical_Debt-blue?style=for-the-badge&color=5598D0&labelColor=62C1EE" width=280px></a> [![forinfinityandbyond](https://user-images.githubusercontent.com/5211576/29499758-4efff304-85e6-11e7-8267-62919c3688a9.gif)](https://www.reddit.com/r/SS13/comments/5oplxp/what_is_the_main_problem_with_byond_as_an_engine/dclbu1a) | ||
|
||
[![Build Status](https://github.com/cmss13-devs/cmss13/workflows/CI%20Suite/badge.svg)](https://github.com/cmss13-devs/cmss13/actions?query=workflow%3A%22CI+Suite%22) | ||
* **Website:** https://forum.cm-ss13.com/ | ||
* **Code:** https://github.com/cmss13-devs/cmss13 | ||
* **Wiki:** https://cm-ss13.com/wiki/Main_Page | ||
|
||
This is the codebase for the CM-SS13 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! CM-SS13 has wildly adapted this idea into a strategic roleplay-based team deathmatch game. | ||
|
||
## :exclamation: How to compile :exclamation: | ||
|
||
On **2022-04-06** we have changed the way to compile the codebase. | ||
|
||
**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 set up the server normally by opening `colonialmarines.dmb` in DreamDaemon. | ||
|
||
**Building colonialmarines in DreamMaker directly is now 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).** | ||
|
||
## Contributors | ||
[Guides for Contributors](.github/CONTRIBUTING.md) | ||
|
||
[Setting up a Development Environment](https://cm-ss13.com/wiki/Guide_to_Git) | ||
|
||
## LICENSE | ||
|
||
The code for CM-SS13 is licensed under the [GNU Affero General Public License v3](http://www.gnu.org/licenses/agpl.html), which can be found in full in [/LICENSE-AGPL3](/LICENSE-AGPL3). | ||
|
||
Assets including icons and sound are under the [Creative Commons 3.0 BY-SA license](https://creativecommons.org/licenses/by-sa/3.0/) unless otherwise indicated. Authorship for assets including art and sound under the CC BY-SA license is defined as the active development team of CM-SS13 unless stated otherwise (by author of the commit). | ||
|
||
All code is assumed to be licensed under AGPL v3 unless stated otherwise by file header. Commits before 9a001bf520f889b434acd295253a1052420860af are assumed to be licensed under GPLv3 and can be used in closed source repo. | ||
<p align="center"> | ||
<a href="#"><img src=".github/assets/logo.png" alt="CM-SS13" align="center"></a> | ||
</p> | ||
<hr /> | ||
|
||
<p align="center"> | ||
<a href="https://github.com/cmss13-devs/cmss13/actions?query=workflow%3A%22CI+Suite%22"><img src="https://github.com/cmss13-devs/cmss13/workflows/CI%20Suite/badge.svg"></a> | ||
<a href="https://github.com/cmss13-devs/cmss13/actions/workflows/generate_documentation.yml"><img src="https://github.com/cmss13-devs/cmss13/actions/workflows/generate_documentation.yml/badge.svg"></a> | ||
</p> | ||
|
||
<p align="center"> | ||
<a href="https://www.monkeyuser.com/assets/images/2019/131-bug-free.png"><img src="https://img.shields.io/badge/Built_with-Resentment-orange?style=for-the-badge&labelColor=%23D47439&color=%23C36436" width=260px></a> | ||
<a href="https://user-images.githubusercontent.com/8171642/50290880-ffef5500-043a-11e9-8270-a2e5b697c86c.png"><img src="https://img.shields.io/badge/Contains-Technical_Debt-blue?style=for-the-badge&color=5598D0&labelColor=62C1EE" width=280px></a> | ||
<a href="https://www.reddit.com/r/SS13/comments/5oplxp/what_is_the_main_problem_with_byond_as_an_engine/dclbu1a"><img src="https://user-images.githubusercontent.com/5211576/29499758-4efff304-85e6-11e7-8267-62919c3688a9.gif"></a> | ||
</p> | ||
|
||
<p align="center"> | ||
<a href="https://discord.gg/cmss13"> | ||
<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://docs.cm-ss13.com"> | ||
<picture> | ||
<source media="(prefers-color-scheme: dark)" srcset=".github/assets/docs-light.png"> | ||
<source media="(prefers-color-scheme: light)" srcset=".github/assets/docs-dark.png"> | ||
<img alt="Code docs" width="15%" hspace="3%" src=".github/assets/docs-dark.png"> | ||
</picture> | ||
</a> | ||
<a href="https://cm-ss13.com"> | ||
<picture> | ||
<source media="(prefers-color-scheme: dark)" srcset=".github/assets/website-light.png"> | ||
<source media="(prefers-color-scheme: light)" srcset=".github/assets/website-dark.png"> | ||
<img width="15%" alt="Website" hspace="3%" src=".github/assets/website-dark.png"> | ||
</picture> | ||
</a> | ||
<a href="https://cm-ss13.com/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> | ||
<hr /> | ||
|
||
> [!IMPORTANT] | ||
> CM-SS13 cannot be compiled exclusively using BYOND - **you must use our build tool**. | ||
> Firstly, you need to install [BYOND](https://www.byond.com/download/), and run the `bin/server.cmd` file to start the server. | ||
> You can learn more in our [Installation Guide](tools/build/README.md). **Building colonialmarines in DreamMaker directly is now deprecated and will cause errors.** | ||
CM-SS13 is a game based on [Space Station 13](https://spacestation13.com), made in [BYOND](https://www.byond.com). CM-SS13 has wildly adapted the SS13 model into a strategic roleplay-based team deathmatch game. | ||
|
||
# Useful Links | ||
|
||
- ## [Setting up a Development Environment](https://cm-ss13.com/wiki/Guide_to_Git) | ||
> [!TIP] | ||
> Want to contribute for the first time but unsure where to start? Take a look at our community maintained [Guide to Contributing](https://cm-ss13.com/wiki/Contributing_to_the_Game)! | ||
This guide will get you set up with a Visual Studio Code development environment, complete with BYOND debugger, which will allow you to contribute back to this repository. | ||
|
||
- ## [Contributing Rules](.github/CONTRIBUTING.md) | ||
This is our canonical, maintainer-maintained contributing guide, which contains information on our maintainer team structure and pull request rules. | ||
|
||
- ## [Code Standards](github/guides/STANDARDS.md) | ||
Our standards documents details how to structure your code to comply with CM-SS13 code standards, and provides some information on DreamMaker quirks. | ||
|
||
- ## [Code Style](github/guides/STYLES.md) | ||
The styles document tells you how to style your code to match the rest of the code in our codebase. | ||
|
||
- ## [tgui README](tgui/README.md) | ||
All new interfaces in CM must be created using tgui - this document will help get you set up for tgui development. | ||
|
||
# Licenses | ||
|
||
### <a href="LICENSE-AGPLv3.txt"><img src="https://img.shields.io/badge/licence-AGPL_3-red?style=for-the-badge" alt="AGPLv3 license"></a> | ||
> The code for CM-SS13 is licensed under the [GNU Affero General Public License v3](http://www.gnu.org/licenses/agpl.html). All code is assumed to be licensed under AGPL v3 unless stated otherwise by file header, or this document. | ||
### <a href="LICENSE-CC-BY-NC-SA-3.0.txt"><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> | ||
> Assets including icons and sound are under the [Creative Commons 3.0 BY-SA license](https://creativecommons.org/licenses/by-sa/3.0/) unless otherwise indicated. Authorship for assets including art and sound under the CC BY-SA license is defined as the active development team of CM-SS13 unless stated otherwise (by author of the commit). | ||
### <a href="LICENSE-GPLv3.txt"><img src="https://img.shields.io/badge/licence-GPL_3-orange?style=for-the-badge" alt="GPLv3 license"></a> | ||
> Commits before [9a001bf520f889b434acd295253a1052420860af on Mon, 14 Sep 2020 09:13:32 +0000](https://github.com/cmss13-devs/cmss13/commit/9a001bf520f889b434acd295253a1052420860af) are assumed to be licensed under [GNU General Public License v3](https://www.gnu.org/licenses/gpl-3.0.html) and can be used in closed source repositories. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.