nevimer
aa0dc869bc
fixing master issues after upstream merge --------- Co-authored-by: MrMelbert <51863163+MrMelbert@users.noreply.github.com> Co-authored-by: mcbalaam <104003807+mcbalaam@users.noreply.github.com>
Bubberstation (TG Downstream)
| Website | Link |
|---|---|
| Git / GitHub cheatsheet | https://www.notion.so/Git-GitHub-61bc81766b2e4c7d9a346db3078ce833 |
| Guide to Modularization | ./modular_zubbers/readme.md |
| Website | https://wiki.bubberstation.org/index.php?title=Main_Page |
| Code | https://github.com/Bubberstation/Bubberstation |
| Wiki | https://tgstation13.org/wiki/Main_Page |
| Codedocs | https://bubberstation.github.io/Bubberstation |
| Bubberstation Discord | https://discord.gg/AvjrTqnqEx |
| Coderbus Discord | https://discord.gg/Vh8TJp9 |
This is Bubberstation's fork of TG. Originally forked from Skyrat.
Please note that this repository contains sexually explicit content and is not suitable for those under the age of 18.
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!
As of our recent split from Skyrat, a lot of codedocs/modularization guides need to be rewritten. Until it is done expect some wait time with larger refactors. You are also free to edit any Skyrat files
Contribution Rules and Guidelines
1. Do Not Be A Dick
- The Bubberstation main repository is maintained by and contributed to by volunteers and hobbiests. You are not entitled to our time and energy. We reserve the right to permanently remove anyone who does not show both our contributor's and maintainer's common decency.
- Bubberstation does not operate a strict "goodboy" points system or have defined goals, and anyone is welcome to contribute to this project. That being said, the maintainers of this project are free to curate comments as seen fit to uphold a respectful environment.
2. Seek maintainer approval for major code changes
- Do not expect every change to be added to the game or approved by others
- Changes should not be done for the sake of making changes, and should instead seek to improve the game for more than just one's self
- Changes should try to feel cohesive with the rest of the game
- Seek maintainer approval if you would like to modify any of the following:
- Adding/Removing/Modifying a Map for regular map rotations
- Adding/Removing/Modifying a role or antagonist
- Adding/Removing/Modifying a species
- Reworking of a commonly used mechanic
- Working on a bounty item
- Any signficant balance changes
- Seeking approval beforehand saves a lot of time and headache if an idea doesn't align with the game's theme and direction
3. The Licensing is Non-negotiable
- You are free to take, redistribute, modify, and readapt any code or commit found on this repository.
- All code files are under GNU AGPL V3
- All asset files (images and sound) are CC-BY-SA 3.0 unless otherwise stated
- The license information, including the MIT license and its exceptions, can be found at the bottom of this readme.
- What does this mean to our contributors? The GNU AGPL V3 licensing on this codebase is non-negotiable and irrevocable the moment you open a PR. We are incapable of privatizing this codebase and you are incapable of restricting your code contributions even if you close the PR. Do not open a contribution if you do not feel comfortable with your code being permanent across the entirety of the community. All contributions are preserved in commit history
- What does this mean to our spriters and sound designers? CC-BY-SA 3.0 or CY-BY-NC-SA 3.0 (must be declared appropriately) are the only licenses that this project will accept.
- It is prohibited to use the attribution requirement to suggest that you endorse or support a particular use of your assets.
- You are entitled to credit yourself with comments and you are entitled to waive the attribution requirement choosing not to be identified as the creator if you wish.
- If you do not like how your assets were modified or used, it is required that the other person remove the attribution information upon request.
- Modifications or adaptions must disclose the source, the author, and any changes you've made.
- Goonstation code is incompatible with this codebase and will not be accepted.
Credit: Goonstation contribution guidelines
To forward any licensing concerns, please open an issue report or pull request. Alternatively, you can join our Discord and contact the project leaders.
Modularization and codedocs note
Modularization
New modularized code should be put in the modular_zubbers folder. This is to keep our unique code seperate, easier to maintain, and helps future contributors find things. It is expected that you call into the override functions to reduce the amount of code we overwrite and edit from our upstream source.
Configuration
Most of our config files are open source, and therefore can be edited (though you should have good reason to do so)
Important note - TEST YOUR PULL REQUESTS
You are responsible for the testing of your content. You should not mark a pull request ready for review until you have actually tested it. If you require a separate client for testing, you can use a guest account by logging out of BYOND and connecting to your test server.
Testing your changes is super critical for multiple reasons.
- It makes sure your features/changes actually work.
- It helps reduce the chance that something else has broken
- Provides a first peek at the changes before its actually in the game
This is why we require notes on testing, and in most instances, videos or screenshots to help support that.
Test notes can be a step-by-step set of instructions. But for visual content, we require either screenshots of how something renders, a video of the content being interacted with/used, or a video with sound to show audio changes.
Ideally, test notes are you providing people with confidence that your change works and has not interfered with other bits of code.
DOWNLOADING
Maps and Away Missions Maps and Away Missions
Compilation
Find BUILD.bat here in the root folder of tgstation, and double click it to initiate the build. It consists of multiple steps and might take around 1-5 minutes to compile.
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 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.
Getting started
For getting started (dev env, compilation) see the HackMD document here.
For overall design documentation see HackMD.
Code Reviews
We do not expect everyone to be an amazing coder or get something to work on the first try. PR's that are not in draft and are marked ready for review are open for comment and feedback.
PR's should not attempt to fix or modify multiple unrelated concepts at the same time. If you are unsure, ask a maintainer if your PR should be split up.
With each PR, please include a relevant, clear and descriptive title that within one line describes what the PR is about.
Please also fill out the auto-generated fields with relevant information such as why something is good for the game. ("Because" is not a valid reason)
Include test notes and other testing related details as mentioned previously.
Also for any player facing changes, please include a changelog with any relevant changelog types and items that were modified in the PR.
LICENSE
All code after commit 333c566b88108de218d882840e61928a9b759d8f on 2014/12/31 at 4:38 PM PST is licensed under GNU AGPL v3.
All code before commit 333c566b88108de218d882840e61928a9b759d8f on 2014/12/31 at 4:38 PM PST is licensed under GNU GPL v3. (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. The TGS DMAPI is licensed as a subproject under the MIT license.
See the footer of code/__DEFINES/tgs.dm and code/modules/tgs/LICENSE for the MIT license.
All assets including icons and sound are under a Creative Commons 3.0 BY-SA license unless otherwise indicated.