From 1f8e48baa0caede37969f715832026a24ff156c1 Mon Sep 17 00:00:00 2001 From: DEATHB4DEFEAT <77995199+DEATHB4DEFEAT@users.noreply.github.com> Date: Mon, 18 Mar 2024 10:08:37 -0700 Subject: [PATCH] Improve Several Project Markdown Files (#10) # Description Replaced the [issue](https://github.com/DEATHB4DEFEAT/Einstein-Engines/tree/markdown/.github/ISSUE_TEMPLATE) and [pull request](https://github.com/DEATHB4DEFEAT/Einstein-Engines/blob/markdown/.github/PULL_REQUEST_TEMPLATE.md) templates with some better ones. Temporarily empty the [CODEOWNERS](https://github.com/DEATHB4DEFEAT/Einstein-Engines/blob/markdown/.github/CODEOWNERS) file until people actually own anything significant. Improve the [LEGAL](https://github.com/DEATHB4DEFEAT/Einstein-Engines/blob/markdown/LEGAL.md) and [README](https://github.com/DEATHB4DEFEAT/Einstein-Engines/blob/markdown/README.md) files. --- .github/CODEOWNERS | 15 +--- .github/ISSUE_TEMPLATE/config.yml | 5 +- .github/ISSUE_TEMPLATE/feature_request.md | 27 +++++++ .github/ISSUE_TEMPLATE/issue_report.md | 53 +++++++++--- .../toolshed-feature-request.md | 18 ----- .github/PULL_REQUEST_TEMPLATE.md | 71 ++++++++++------ LEGAL.md | 8 +- README.md | 81 +++++++++++++------ 8 files changed, 179 insertions(+), 99 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md delete mode 100644 .github/ISSUE_TEMPLATE/toolshed-feature-request.md diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 5ba87815bb..a30829a5de 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,16 +1,3 @@ # Last match in file takes precedence. -/Content.*/ @DebugOk -/Content.*/SimpleStation14/ @DEATHB4DEFEAT - -/Resources/ @DebugOk -/Resources/ConfigPresets/ @DebugOk -/Resources/*.yml @DebugOk @Colin-Tel -/Resources/*/SimpleStation14/ @DEATHB4DEFEAT -/Resources/Maps/ @IamVelcroboy -/Resources/Prototypes/Maps/ @IamVelcroboy - -/Tools/ @DebugOk - -/* @DebugOk # Standalone files in root, shouldn't apply to subdirectories -/.github/ @DebugOk # Workflows, codeowners, templates, etc +# TODO diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 09c9e76b19..7ff9017cb0 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,7 +1,4 @@ contact_links: - name: Report a Security Vulnerability url: https://github.com/space-wizards/space-station-14/blob/master/SECURITY.md - about: Please report security vulnerabilities privately so we can fix them before they are publicly disclosed. - - name: Request a Feature - url: https://discord.gg/rGvu9hKffJ - about: Submit feature requests on our Discord server (https://discord.gg/rGvu9hKffJ). + about: Please report security vulnerabilities to the Space Wizards privately so they can fix them before they are publicly disclosed. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000000..aba549332f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,27 @@ +--- +name: Request a Feature +about: "Template for noting future planned features. Please ask for approval in the Discord if you aren't an organization Member before posting a feature request" +title: '' +labels: '' +assignees: '' + +--- + + + +# Description + + +I want Goldfish crackers + +# Media + + +![Example Screenshot](https://example.com/thisimageisntreal.png) diff --git a/.github/ISSUE_TEMPLATE/issue_report.md b/.github/ISSUE_TEMPLATE/issue_report.md index 9bc805b74e..ab82181197 100644 --- a/.github/ISSUE_TEMPLATE/issue_report.md +++ b/.github/ISSUE_TEMPLATE/issue_report.md @@ -1,20 +1,55 @@ --- name: Report an Issue -about: "..." +about: "Any general issues you have during play or with the codebase" title: '' labels: '' assignees: '' --- -## Description - + -**Reproduction** - +# Description + -**Screenshots** - +Description -**Additional context** - +# Reproduction + + +1. Open game +2. Game doesn't open + +# Expected behavior + + +1. Open game +2. Game opens + +# Media + + +![Example Screenshot](https://example.com/thisimageisntreal.png) + +# Additional context + + +There's a ghost in my computer diff --git a/.github/ISSUE_TEMPLATE/toolshed-feature-request.md b/.github/ISSUE_TEMPLATE/toolshed-feature-request.md deleted file mode 100644 index dae84c3e25..0000000000 --- a/.github/ISSUE_TEMPLATE/toolshed-feature-request.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -name: Toolshed feature request -about: Suggest a feature for Toolshed (for game admins/developers) -title: "[TOOLSHED REQUEST]" -labels: Toolshed -assignees: moonheart08 - ---- - -**Is your feature request related to a problem/bug? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the command you'd like** -A clear and concise description of what you want and what it should do. -If you're a technical user (i.e. programmer) including type signatures is helpful. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index a397604185..5d3ce070bc 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,43 +1,62 @@ - - + -## About the PR - +# Description -## Why / Balance - + +Some example prompts to consider: +How might this affect the game? The codebase? +What might be some alternatives to this? +How/Who does this benefit/hurt [the game/codebase]? +--> -## Media - -- [ ] I have added screenshots/videos to this PR showcasing its changes ingame, **or** this PR does not require an ingame showcase +- [ ] Task +- [x] Completed Task + +--- -## Breaking changes -**Changelog** +

Media

 +

+ +![Example Media Embed](https://example.com/thisimageisntreal.png) + +

+
+ +--- + +# Changelog + - +- remove: Removed fun :( diff --git a/LEGAL.md b/LEGAL.md index 2e6c6e9df3..2df3c39add 100644 --- a/LEGAL.md +++ b/LEGAL.md @@ -2,15 +2,15 @@ ## Copyright -The Authors retain all copyright to their respective work here submitted. +The Authors retain all copyright to their respective work submitted here. ## 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.txt`. +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/Einstein-Engines/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.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/Einstein-Engines/blob/master/LICENSE-MIT.txt). -[87c70a89a67d0521a56388e6b1c3f2cb947943e4](https://github.com/DeltaV-Station/Delta-v/commit/87c70a89a67d0521a56388e6b1c3f2cb947943e4) was pushed on February 17th 2024 at 21:48 UTC +[87c70a89a67d0521a56388e6b1c3f2cb947943e4](https://github.com/Simple-Station/Einstein-Engines/commit/87c70a89a67d0521a56388e6b1c3f2cb947943e4) was pushed on February 17th 2024 at 21:48 UTC ## Warranty diff --git a/README.md b/README.md index 9b58cc0a1e..13b07015f7 100644 --- a/README.md +++ b/README.md @@ -1,48 +1,81 @@ -## Einstein Engines +# Einstein Engines -Einstein Engines is a hard fork of [Space Station 14](https://github.com/space-wizards/space-station-14), built around the ideals and design inspirations of the Baystation family of servers, with a focus on having modular code that anyone can use to make the RP server of their dreams. Our founding organization is based on a democratic system whereby our mutual contributors and downstreams have a say in what code goes into their own upstream. If you are a representative of a former downstream of DeltaV, I would like to invite you to contact us for an opportunity to represent your fork in this new upstream. +

-Space Station 14 is a remake of SS13 that runs on [Robust Toolbox](https://github.com/space-wizards/RobustToolbox), a homegrown engine written in C#. +--- -As a Hard Fork, any code sourced from a different upstream cannot ever be merged directly here, and must instead be ported. All code present in this repository is subject to change as desired by the council of maintainers. +Einstein Engines is a hard fork of [Space Station 14](https://github.com/space-wizards/space-station-14) built around the ideals and design inspirations of the Baystation family of servers from Space Station 13 with a focus on having modular code that anyone can use to make the RP server of their dreams. +Our founding organization is based on a democratic system whereby our mutual contributors and downstreams have a say in what code goes into their own upstream. +If you are a representative of a former downstream of Delta-V, we would like to invite you to contact us for an opportunity to represent your fork in this new upstream. -## "Official Server Policy" -#### No Official Servers will ever be made for Einstein-Engines. +Space Station 14 is inspired heavily by Space Station 13 and runs on [Robust Toolbox](https://github.com/space-wizards/Robust-Toolbox), a homegrown engine written in C#. -In order to prevent a potential conflict of interest, we will never open any server directly using the Einstein-Engines upstream itself. Any server claiming to be an official representation of this fork is not endorsed in any way by this organization. We however would like to invite anyone wishing to create a server to make a fork of Einstein-Engines. +As a hard fork, any code sourced from a different upstream cannot ever be merged directly here, and must instead be ported. +All code present in this repository is subject to change as desired by the council of maintainers. -## Links - -#### Einstein Engines & Simplestation 14 -[Website](https://simplestation.org/) | [Wiki](Pending) | [Discord](https://discord.gg/49KeKwXc8g) +## Official Server Policy -#### Space Station 14 +**No official servers will ever be made for Einstein-Engines**. -[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/) +In order to prevent a potential conflict of interest, we will never open any server directly using the Einstein Engines codebase itself. +Any server claiming to be an official representation of this fork is not endorsed in any way by this organization. +We however would like to invite anyone wishing to create a server to make a fork of Einstein Engines. -## Documentation/Wiki +## Links -The [docs site](https://docs.spacestation14.io/) has documentation on SS14s content, engine, game design and more. It has lots of resources for new contributors to the project. +[Website](https://simplestation.org) | [Discord](https://discord.gg/X4QEXxUrsJ) | [Steam](https://store.steampowered.com/app/2585480/Space_Station_Multiverse/) | [Standalone](https://spacestationmultiverse.com/downloads/) ## Contributing -We are happy to accept contributions from anybody. Since this repository is its own upstream, there is no code in this repository that is restricted from modification, and no markers are required to indicate where changes are made. +We are happy to accept contributions from anybody, come join our Discord if you want to help. +We've got a [list of issues](https://github.com/Simple-Station/Einstein-Engines/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 #contributor-general channel in our Discord. ## Building -1. Clone this repo. -2. Run `RUN_THIS.py` to init submodules and download the engine. -3. Compile the solution. +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 Einstein Engines is not the same and many things may not apply. +We provide some scripts shown below to make the job easier. + +### Build dependencies + +> - Git +> - 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 +> 3. Run the `Scripts/bat/run1buildDebug.bat` +> 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 + +### 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 +> 3. Run the `Scripts/sh/run1buildDebug.sh` +> 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 + +### MacOS -[More detailed instructions on building the project.](https://docs.spacestation14.com/en/general-development/setup.html) +> I don't know anybody using MacOS to test this, but it's probably roughly the same steps as Linux ## 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.txt`. -Content contributed to this repository before commit 87c70a89a67d0521a56388e6b1c3f2cb947943e4 is licensed under the MIT license, unless otherwise stated. See `LICENSE-MIT.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/Einstein-Engines/blob/master/LICENSE-AGPLv3.txt). -[87c70a89a67d0521a56388e6b1c3f2cb947943e4](https://github.com/DeltaV-Station/Delta-v/commit/87c70a89a67d0521a56388e6b1c3f2cb947943e4) was pushed on February 17th 2024 at 21:48 UTC +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/Einstein-Engines/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/DeltaV-Station/Delta-v/blob/master/Resources/Textures/Objects/Tools/crowbar.rsi/meta.json). +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/Einstein-Engines/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.