Skip to content

Commit

Permalink
Merge pull request #1361 from impstation/hivehum-patch-1
Browse files Browse the repository at this point in the history 
huge readme edit
  • Loading branch information
@formlessnameless
formlessnameless authored Jan 14, 2025
2 parents ebf420b + 2cf01a4 commit 0884ab1
Showing 1 changed file with 16 additions and 10 deletions.
26 changes: 16 additions & 10 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
<p align="center"> <img alt="Space Station 14" width="880" height="300" src="https://raw.githubusercontent.com/space-wizards/asset-dump/de329a7898bb716b9d5ba9a0cd07f38e61f1ed05/github-logo.svg" /></p>
<p align="center"> <img alt="Impstation" src="https://github.com/impstation/imp-station-14/blob/master/Resources/Textures/Logo/logo.png" /></p>

Space Station 14 is a remake of SS13 that runs on [Robust Toolbox](https://github.com/space-wizards/RobustToolbox), our homegrown engine written in C#.
Impstation is a fork of Space Station 14, a remake of SS13 that runs on [Robust Toolbox](https://github.com/space-wizards/RobustToolbox), its homegrown engine written in C#.

This is the primary repo for Space Station 14. To prevent people forking RobustToolbox, a "content" pack is loaded by the client and server. This content pack contains everything needed to play the game on one specific server.

If you want to host or create content for SS14, this is the repo you need. It contains both RobustToolbox and the content pack for development of new content packs.
While we are not a server that allows sexual content, <b>we do not allow people under the age of 20 to play on Impstation.</b>

## Links

[Website](https://spacestation14.io/) | [Discord](https://discord.ss14.io/) | [Forum](https://forum.spacestation14.io/) | [Steam](https://store.steampowered.com/app/1255460/Space_Station_14/) | [Standalone Download](https://spacestation14.io/about/nightlies/)
[Website](https://impstation.gay/) | [Discord](https://discord.gg/TGNz3cEkag) | [Steam](https://store.steampowered.com/app/1255460/Space_Station_14/) | [Standalone Download](https://spacestation14.io/about/nightlies/)

## Documentation/Wiki

Expand All @@ -20,7 +18,11 @@ We are happy to accept contributions from anybody. Get in Discord if you want to

As a baseline make sure your changes and pull requests are in accordance with the upstream [contribution guidelines](https://docs.spacestation14.com/en/general-development/codebase-info/pull-request-guidelines.html). We're generally not as strict, but it's good practice to follow these examples.

If you are adding completely custom content that would go into the normal SS14 file structure in a certain spot, add that content to the _Impstation folder with that same file path instead. For example, when adding the GBsay chat command for ghost bar stuff, it would have gone in Content.Server/Chat/Commands. Instead, the GBsay.cs file is in Content.Server/_Impstation/Chat/Commands. The Impstation folders are located at Content.Client/_Impstation, Content.Server/_Impstation, and Content.Shared/_Impstation. The Resources folder is kind of its own beast, and has a lot of depth. For that reason it makes sense to have the _Impstation folder inside of the subfolder it is modifying. As another example, the main prototypes folder for our custom content is located in Resources/Prototypes/_Impstation. The custom SvS gamemode is defined in Resources/Prototypes/_Impstation/GameRules/roundstart.yml.This applies for recipies, clothing, everything. Keeping things defined like this makes the lives of the people maintaining the server much, much easier.
If you are adding completely custom content that would go into the normal SS14 file structure in a certain spot, add that content to the `_Impstation` folder with that same file path instead. For example, when adding the GBsay chat command for ghost bar stuff, it would have gone in `Content.Server/Chat/Commands`. Instead, the `GBsay.cs` file is in `Content.Server/_Impstation/Chat/Commands`.

The Impstation folders are located at `Content.Client/_Impstation`, `Content.Server/_Impstation`, and `Content.Shared/_Impstation`. The Resources folder is kind of its own beast, and has a lot of depth. For that reason it makes sense to have the _Impstation folder inside of the subfolder it is modifying. As another example, the main prototypes folder for our custom content is located in `Resources/Prototypes/_Impstation`. The custom Spy vs Spy gamemode is defined in `Resources/Prototypes/_Impstation/GameRules/roundstart.yml`. This applies for recipies, clothing, everything.

Keeping things defined like this makes the lives of the people maintaining the server much, much easier.


## Building
Expand All @@ -37,6 +39,8 @@ Content contributed to this repository after and including commit 7210960b2b30e1

Content contributed to this repository before commit 7210960b2b30e17aa001f4e35a5d0f80ca548e53 (`15 August 2024 17:02:49 UTC`) is licensed under the MIT license unless otherwise stated. See [LICENSE-MIT](./LICENSE-MIT.TXT).

To be more specific, code in Content./Impstation, Resources//Impstation and any Impstation specific scripts in Tools are licensed under AGPLv3. Other files are originally from other codebases and are not owned by Impstation, though any code must be relicensable to AGPLv3. SS14 is MIT licensed so this forking is possible.

Most assets are licensed under [CC-BY-SA 3.0](https://creativecommons.org/licenses/by-sa/3.0/) unless stated otherwise. Assets have their license and the copyright in the metadata file. [Example](https://github.com/space-wizards/space-station-14/blob/master/Resources/Textures/Objects/Tools/crowbar.rsi/meta.json).

Note that some assets are licensed under the non-commercial [CC-BY-NC-SA 3.0](https://creativecommons.org/licenses/by-nc-sa/3.0/) or similar non-commercial licenses and will need to be removed if you wish to use this project commercially.
Expand All @@ -49,9 +53,11 @@ Content under these subdirectories either originate from their respective fork,

| Subdirectory | Fork Name | Fork Repository | License |
|--------------|-----------|-----------------|---------|
| `_Impstation` | Imp Station 14 | https://github.com/impstation/imp-station-14/ | AGPL 3.0 |
| `_Goobstation` | Goob Station | https://github.com/Goob-Station/Goob-Station/ | AGPL 3.0 |
| `_DV` | Delta-V | https://github.com/DV-Station/Delta-v/ | AGPL 3.0 |
| `_Impstation` | Impstation | https://github.com/impstation/imp-station-14/ | AGPL 3.0 |
| `_CD` | Cosmatic Drift | https://github.com/cosmatic-drift-14/cosmatic-drift | MIT |
| `_DV` | Delta-V | https://github.com/DeltaV-Station/Delta-v/ | AGPL 3.0 |
| `_EinsteinEngine` | Einstein Engines | https://github.com/Simple-Station/Einstein-Engines/ | AGPL 3.0 |
| `_EstacaoPirata` | Estacao Pirata | https://github.com/Day-OS/estacao-pirata-14/ | AGPL 3.0 |
| `_Goobstation` | Goob Station | https://github.com/Goob-Station/Goob-Station/ | AGPL 3.0 |
| `_Harmony` | Harmony | https://github.com/ss14-harmony/ss14-harmony | AGPL 3.0 |
| `_White` | White Dream | https://github.com/WWhiteDreamProject/wwdpublic/ | AGPL 3.0 |

0 comments on commit 0884ab1

Please sign in to comment.