diff --git a/LEGAL.md b/LEGAL.md new file mode 100644 index 0000000000..37dc5e7053 --- /dev/null +++ b/LEGAL.md @@ -0,0 +1,22 @@ +# Legal Info + +## Copyright + +The Authors retain all copyright to their respective work here submitted. + +## Code license + +Content contributed to this repository after commit 87c70a89a67d0521a56388e6b1c3f2cb947943e4 is licensed under the GNU Affero General Public License version 3.0 unless otherwise stated. See [LICENSE-AGPLv3](https://github.com/Simple-Station/Parkstation-Friendly-Chainsaw/blob/master/LICENSE-AGPLv3.txt). + +Content contributed to this repository before commit 87c70a89a67d0521a56388e6b1c3f2cb947943e4 is licensed under the MIT license unless otherwise stated. See [LICENSE-MIT](https://github.com/Simple-Station/Parkstation-Friendly-Chainsaw/blob/master/LICENSE-MIT.txt). + +[87c70a89a67d0521a56388e6b1c3f2cb947943e4](https://github.com/Simple-Station/Parkstation-Friendly-Chainsaw/commit/87c70a89a67d0521a56388e6b1c3f2cb947943e4) was pushed on February 17th 2024 at 21:48 UTC + +## Warranty + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/MARKERS.md b/MARKERS.md new file mode 100644 index 0000000000..05210afc7a --- /dev/null +++ b/MARKERS.md @@ -0,0 +1,72 @@ +# Guide to Codebase Change Markers + +Whenever you change a file not owned by this codebase you need to clarify which portions have been changed. If the markers described below don't have a description for the file type you're working with, don't add a marker yet and ask a reviewer if you need one and how it should be done. + +The following is the formatting for annotations per language type: + + +### C# + +Single line changes: + +```csharp + +[Your code here. This can be entirely original or modified from the original file] // Parkstation-[TitleOfFeature] - Optional clarification of why this change was done + +``` + +Multiple line changes: + +```csharp + +// Parkstation-[TitleOfFeature]-Start - Optional clarification of why this change was done +[Your code here. This can be entirely original or modified from the original file] +// Parkstation-[TitleOfFeature]-End + +``` + + +### XAML + +Any amount of lines changed: + +```xaml + + +[Your code here. This can be entirely original, or modified from the original file] + + +``` + + + +### YML + +Single line changes: + +```yml + +[Your code here. This can be entirely original, or modified from the original file] # Parkstation-[TitleOfFeature] - Optional clarification of why this change was done + +``` + +Multiple line changes: + +```yml + +# Parkstation-[TitleOfFeature]-Start - Optional clarification of why this change was done +[Your code here. This can be entirely original, or modified from the original file] +# Parkstation-[TitleOfFeature]-End + +``` + + +### Never Needed + +- MD +- TXT +- XML +- JSON +- RGA (Robust Generic Attribution, specifies asset licenses) +- PNG (Licensed differently) +- OGG (Licensed differently) diff --git a/README.md b/README.md index c5fcfb493e..7a9825a20e 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,58 @@ # Parkstation +

+ ## Links [Discord](https://discord.gg/49KeKwXc8g) | [Steam](https://store.steampowered.com/app/2585480/Space_Station_Multiverse/) | [Standalone](https://spacestationmultiverse.com/downloads/) ## Contributing -We are happy to accept contributions from anybody. Get in Discord if you want to help. We've got a [list of issues](https://github.com/orgs/Park-Station/projects/1/views/1) that need to be done and anybody can pick them up. Don't be afraid to ask for help either! +We are happy to accept contributions from anybody. Get in Discord if you want to help. We've got a [list of issues](https://github.com/Simple-Station/Parkstation-Friendly-Chainsaw/issues) that need to be done and anybody can pick them up. Don't be afraid to ask for help in Discord either! + +We are currently accepting translations of the game on our main repository. If you would like to translate the game into another language check the #contribution-help channel in our Discord. + +If you make any contributions, please make sure to read the markers section in [MARKERS](https://github.com/Simple-Station/Parkstation-Friendly-Chainsaw/blob/master/MARKERS.md) +Any changes made to files belonging to our upstream should be properly marked in accordance to what is specified there. ## Building -Refer to [the Space Wizards' guide](https://docs.spacestation14.com/en/general-development/setup/setting-up-a-development-environment.html) on setting up a development environment for general information, but keep in mind that Parkstation is a distant fork of Space Wizards' SS14 and not everything applies. We provide some scripts for making the job easier. +Refer to [the Space Wizards' guide](https://docs.spacestation14.com/en/general-development/setup/setting-up-a-development-environment.html) on setting up a development environment for general information, but keep in mind that Parkstation is a distant fork of Space Wizards' SS14 and not everything applies. We provide some scripts to make the job easier. ### Build dependencies > - Git -> - .NET SDK 7.0 or higher +> - DOTNET SDK 7.0 or higher > - python 3.7 or higher ### Windows -> 1. Clone this repository. -> 2. Run `RUN_THIS.py` to init submodules and download the engine, or run `git submodule update --init --recursive` in a terminal. +> 1. Clone this repository +> 2. Run `RUN_THIS.py` to init submodules and download the engine, or run `git submodule update --init --recursive` in a terminal > 3. Run the `Scripts/bat/run1buildDebug.bat` -> 4. Run the `Scripts/bat/run2configDev.bat` if you need other configurations run other config scripts. +> 4. Run the `Scripts/bat/run2configDev.bat` if you need other configurations run other config scripts > 5. Run both the `Scripts/bat/run3server.bat` and `Scripts/bat/run4client.bat` -> 6. Connect to localhost and play. +> 6. Connect to localhost and play ### Linux -> 1. Clone this repository. -> 2. Run `RUN_THIS.py` to init submodules and download the engine, or run `git submodule update --init --recursive` in a terminal. +> 1. Clone this repository +> 2. Run `RUN_THIS.py` to init submodules and download the engine, or run `git submodule update --init --recursive` in a terminal > 3. Run the `Scripts/sh/run1buildDebug.sh` -> 4. Run the `Scripts/sh/run2configDev.sh` if you need other configurations run other config scripts. +> 4. Run the `Scripts/sh/run2configDev.sh` if you need other configurations run other config scripts > 5. Run both the `Scripts/sh/run3server.bat` and `scripts/sh/run4client.sh` -> 6. Connect to localhost and play. +> 6. Connect to localhost and play + +### MacOS + +> I don't know anybody using MacOS to test this, but it's probably roughly the same steps as Linux. ## License -All code for the content repository is licensed under [MIT](https://github.com/Simple-Station/Parkstation-Friendly-Chainsaw/blob/master/LICENSE.TXT). +Content contributed to this repository after commit 87c70a89a67d0521a56388e6b1c3f2cb947943e4 (`17 February 2024 23:00:00 UTC`) is licensed under the GNU Affero General Public License version 3.0 unless otherwise stated. See [LICENSE-AGPLv3](https://github.com/Simple-Station/Parkstation-Friendly-Chainsaw/blob/master/LICENSE-AGPLv3.txt). + +Content contributed to this repository before commit 87c70a89a67d0521a56388e6b1c3f2cb947943e4 (`17 February 2024 23:00:00 UTC`) is licensed under the MIT license unless otherwise stated. See [LICENSE-MIT](https://github.com/Simple-Station/Parkstation-Friendly-Chainsaw/blob/master/LICENSE-MIT.txt). 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/Simple-Station/Parkstation-Friendly-Chainsaw/blob/master/Resources/Textures/Objects/Tools/crowbar.rsi/meta.json).