initial commit

Vault-Overseers · Nov 3, 2024 · 26d9fc9 · 26d9fc9
1 parent 18f4084
commit 26d9fc9
Show file tree

Hide file tree

Showing 43 changed files with 73 additions and 247 deletions.
diff --git a/.github/labeler.yml b/.github/labeler.yml
@@ -14,8 +14,8 @@
 # Welcome to the mega labeler.
 "Design":
 # General design
-- 'src/en/site-14/core-design/**'
+- 'src/en/n14/core-design/**'
 
 # Department design
-- 'src/en/site-14/departments/atmos/*'
+- 'src/en/n14/departments/atmos/*'
 
diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
-# Site 14 Development Wiki
+# Nuclear 14 Development Wiki
 
 This is the `mdbook`-based developer documentation for Site 14.
 
-The site is currently hosted at [https://foundation-site-14.github.io/Site-14-docs](https://foundation-site-14.github.io/Site-14-docs))
+The site is currently hosted at [https://vault-overseers.github.io/](https://vault-overseers.github.io/))
 
 Benefits of the current docs site infrastructure include:
 - First-class git support, open source and actually editable by everyone
@@ -31,4 +31,4 @@ The following `mdbook` features & plugins are available and in use:
 
 ## License
 
-The Site-14 Development Wiki is released under the Mozilla Public License v2.0.
+The Nuclear 14 Development Wiki is released under the Mozilla Public License v2.0.
diff --git a/book.toml b/book.toml
@@ -1,10 +1,10 @@
 [book]
-authors = ["Site 14 Contributors"]
+authors = ["Nuclear 14 Contributors"]
 language = "en"
 multilingual = false
 src = "src"
-title = "Site-14 Development Wiki"
-description = "Tutorial & reference for all Site 14 projects."
+title = "Nuclear 14 Development Wiki"
+description = "Tutorial & reference for all Nuclear 14 projects."
 
 [preprocessor.mermaid]
 
@@ -23,8 +23,8 @@ additional-css = ['theme/compiled/ss14.css']
 default-theme = "navy"
 preferred-dark-theme = "navy"
 
-git-repository-url = "https://github.com/Foundation-Site-14/Site-14"
-edit-url-template = "https://github.com/Foundation-Site-14/Site-14-docs/blob/master/{path}"
+git-repository-url = "https://github.com/Vault-Overseers/nuclear-14"
+edit-url-template = "https://github.com/Vault-Overseers/Vault-Overseers.github.io/blob/master/{path}"
 
 mathjax-support = true
 smart-punctuation = true

diff --git a/src/SUMMARY.md b/src/SUMMARY.md
@@ -1,71 +1,32 @@
-Site 14 Development Wiki
+Nuclear 14 Development Wiki
 =====================
 
-[Site 14 Index](index.md)
+[Nuclear 14 Index](index.md)
 
-Site 14 Game Design
+Nuclear 14 Game Design
 ================
 
 ----------------------
 
-- [Core Design](en/site-14/core-design.md)
-  - [Design Principles](en/site-14/core-design/design-principles.md)
-  - [Gamemodes](en/site-14/core-design/gamemodes.md)
-  - [Events](en/site-14/core-design/events.md)
+- [Core Design](en/n14/core-design.md)
+  - [Design Principles](en/n14/core-design/design-principles.md)
+  - [Gamemodes](en/n14/core-design/gamemodes.md)
+  - [Events](en/n14/core-design/events.md)
 
-
-- [Combat](en/site-14/combat.md)
-	- [PR Guidelines](en/site-14/combat/guidelines.md)
-
-	- [Proposals]()
-
-- [Mapping](en/site-14/mapping.md)
-	- [PR Guidelines](en/site-14/mapping/guidelines.md)
+- [Mapping](en/n14/mapping.md)
+	- [PR Guidelines](en/n14/mapping/guidelines.md)
 
-	- [Dungeons](en/site-14/mapping/dungeons.md)
+	- [Dungeons](en/n14/mapping/dungeons.md)
 
 	- [Guides]()
-		- [General Guide](en/site-14/mapping/guides/general-guide.md)
+		- [General Guide](en/n14/mapping/guides/general-guide.md)
 
 	- [Proposals]()
 
-- [Departments](en/site-14/departments.md)
-	- [Logistics](en/site-14/departments/logistics.md)
-		- [PR Guidelines](en/site-14/departments/logistics/guidelines.md)
-
-    - [Proposals]()
-
-	- [Site Administration](en/site-14/departments/command.md)
-		- [PR Guidelines](en/site-14/departments/command/guidelines.md)
-		- [Proposals]()
-
-	- [Maintenance](en/site-14/departments/maintenance.md)
-		- [PR Guidelines](en/site-14/departments/maintenance/guidelines.md)
-		
-
-		- [Proposals]()
-			
-	- [Medical](en/site-14/departments/medical.md)
-		- [PR Guidelines](en/site-14/departments/medical/guidelines.md)
-
-		- [Proposals]()
-
-	- [Research](en/site-14/departments/research.md)
-		- [PR Guidelines](en/site-14/departments/research/guidelines.md)
-		- [SCPs](en/site-14/departments/research/scps.md)
-
-		- [Proposals]()
-
-
-	- [Security](en/site-14/departments/security.md)
-		- [PR Guidelines](en/site-14/departments/security/guidelines.md)
-
-		- [Proposals]()
-
-	- [Class D](en/site-14/departments/classd.md)
-		- [PR Guidelines](en/site-14/departments/classd/guidelines.md)
-		- [Proposals]()
+- [Dev Setup](en/n14/dev-setup.md)
+	- [IDEs](en/n14/dev-setup/ides.md)
+	- [Github](en/n14/dev-setup/github.md)
 
-	- [Mobile Task Force](en/site-14/departments/mtf.md)
-		- [PR Guidelines](en/site-14/departments/mtf/guidelines.md)
-		- [Proposals]()
+- [YAML Contributing](en/n14/yaml-contributing.md)
+	- [YAML Basics](en/n14/yaml-contributing/yaml-basics.md)
+	- [Adding a Weapon](en/n14/yaml-contributing/adding-a-weapon.md)
diff --git a/src/en/site-14/core-design.md → src/en/n14/core-design.md b/src/en/site-14/core-design.md → src/en/n14/core-design.md
diff --git a/.../site-14/core-design/design-principles.md → src/en/n14/core-design/design-principles.md b/.../site-14/core-design/design-principles.md → src/en/n14/core-design/design-principles.md
diff --git a/src/en/n14/core-design/events.md b/src/en/n14/core-design/events.md
@@ -0,0 +1 @@
+# Events
diff --git a/src/en/n14/core-design/gamemodes.md b/src/en/n14/core-design/gamemodes.md
@@ -0,0 +1,2 @@
+# Gamemodes
+
diff --git a/src/en/n14/core-design/round-flow.md b/src/en/n14/core-design/round-flow.md
@@ -0,0 +1,11 @@
+# Round Flow
+
+## Early Game
+Analogy: starting up the bus.
+
+## Mid Game
+Analogy: the wheels on the bus go round and round, round and round (but on a bumpy road)
+
+
+## Late Game
+Analogy: the bus is on fire, blown up, hurtling down a mountain side, with a nuclear bomb in the back, covered in bullet holes and cognitohazards (or its an agenda completion, and everything is fine and it gets to its destination)
diff --git a/src/en/n14/dev-setup.md b/src/en/n14/dev-setup.md
@@ -0,0 +1 @@
+# Dev Setup
diff --git a/src/en/n14/dev-setup/github.md b/src/en/n14/dev-setup/github.md
@@ -0,0 +1,13 @@
+# Github
+
+## GitHub Website / Basics
+GitHub is the platform we use for hosting our code in a repository (repo for short) and is used by nearly all servers / codebases in SS13 and 14. It allows new contributors to clone or fork our repository to make their own changes and modifications, then they can submit a pull request (or PR for short) to our repo to have their changes merged into the game. You'll want to create a GitHub account then head to [the nuclear-14 repository here](https://github.com/Vault-Overseers/nuclear-14) and hit the "Fork" button near the top right, below the search bar. This will ask you a few things but you can ignore that and just hit the Create Fork button in green. This will add a fork of the repo to "Your repositories" which you can find by clicking on your avatar or username in the top right.
+
+With GitHub we work on branches, this lets you work on multiple things at once without affecting each other and with better control. Your main branch is usually called "Master" and we keep this clean, that means we don't do any actual work on Master branch. Instead we create branches from it and work on those instead. On the website you can do this by clicking on Master under the repository name and a bar for "Find or Create branch" will appear. Ideally we don't work on the GitHub website as its clunky and not feature rich, so skip to the GitHub clients bit below for more information on branches.
+
+The final thing to know about the GitHub website is once you've done some work on a branch and are ready to submit a pull request (PR) to have it merged with the game. For this you head to the [upstream repository here](https://github.com/Vault-Overseers/nuclear-14) (upstream meaning the main nuclear-14 repo). If you've recently pushed changes to from your local branch to your origin branch on the GitHub website then you'll see an orange banner across the top asking if you'd like to open a pull request. Hit this and fill out the template and submit it to be reviewed by the Nuclear 14 Maintainers. If you're reading this guide in order then head down to the GitHub Clients section to learn more about commits, origin, working trees and more.
+
+## GitHub Clients
+GitHub can be accessed through command line interface (CLI) by downloading Gitbash or through some questionable clients like GitHub Desktop which is more problematic than not usually. We recommend [SmartGit](https://www.syntevo.com/smartgit/) as a user friendly yet powerful and free option for open source development like ours. It might look like a lot at first glance but we'll run through installation and what everything is, and it'll quickly become just like any other software you use.
+
+## SmartGit
diff --git a/src/en/n14/dev-setup/ides.md b/src/en/n14/dev-setup/ides.md
@@ -0,0 +1,8 @@
+# IDEs
+
+## Intro
+An IDE is an Integrated Development Environment and is used for coding. In SS14 this allows you to edit code and then build and run your newly edited code with ease all in one program. There's a variety of free options but popular ones include Visual Studio Community, [Visual Studio Code (VSC)](https://code.visualstudio.com/) and JetBrains Rider. We encourage all new contributors to use VSC as it has a [Robust YAML plugin](https://marketplace.visualstudio.com/items?itemName=slava0135.robust-yaml) to make editing YAML much easier on top of its [YAML language support here](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml).
+
+## VSC Setup
+1. Head to the Visual Studio Code Website here and run through the installation process. https://code.visualstudio.com/
+2. Install / Enable YAML language support and the Robust YAML plugin linked above.
diff --git a/src/en/site-14/mapping.md → src/en/n14/mapping.md b/src/en/site-14/mapping.md → src/en/n14/mapping.md
diff --git a/src/en/site-14/mapping/dungeons.md → src/en/n14/mapping/dungeons.md b/src/en/site-14/mapping/dungeons.md → src/en/n14/mapping/dungeons.md
diff --git a/src/en/site-14/combat/guidelines.md → src/en/n14/mapping/guidelines.md b/src/en/site-14/combat/guidelines.md → src/en/n14/mapping/guidelines.md
diff --git a/...n/site-14/mapping/guides/general-guide.md → src/en/n14/mapping/guides/general-guide.md b/...n/site-14/mapping/guides/general-guide.md → src/en/n14/mapping/guides/general-guide.md
diff --git a/src/en/n14/yaml-contributing.md b/src/en/n14/yaml-contributing.md
@@ -0,0 +1 @@
+# Yaml Contributing
diff --git a/src/en/n14/yaml-contributing/adding-a-weapon.md b/src/en/n14/yaml-contributing/adding-a-weapon.md
@@ -0,0 +1,3 @@
+# Gamemodes
+
+## Greenshift
diff --git a/src/en/n14/yaml-contributing/yaml-basics.md b/src/en/n14/yaml-contributing/yaml-basics.md
@@ -0,0 +1,3 @@
+# Gamemodes
+
+## Greenshift
diff --git a/src/en/site-14/combat.md b/src/en/site-14/combat.md
diff --git a/src/en/site-14/core-design/events.md b/src/en/site-14/core-design/events.md
diff --git a/src/en/site-14/core-design/gamemodes.md b/src/en/site-14/core-design/gamemodes.md
diff --git a/src/en/site-14/core-design/round-flow.md b/src/en/site-14/core-design/round-flow.md
diff --git a/src/en/site-14/departments.md b/src/en/site-14/departments.md
diff --git a/src/en/site-14/departments/classd.md b/src/en/site-14/departments/classd.md
diff --git a/src/en/site-14/departments/classd/guidelines.md b/src/en/site-14/departments/classd/guidelines.md
diff --git a/src/en/site-14/departments/command/guidelines.md b/src/en/site-14/departments/command/guidelines.md
diff --git a/src/en/site-14/departments/engineering/guidelines.md b/src/en/site-14/departments/engineering/guidelines.md
diff --git a/src/en/site-14/departments/logistics.md b/src/en/site-14/departments/logistics.md
diff --git a/src/en/site-14/departments/logistics/guidelines.md b/src/en/site-14/departments/logistics/guidelines.md
diff --git a/src/en/site-14/departments/maintenance.md b/src/en/site-14/departments/maintenance.md
diff --git a/src/en/site-14/departments/maintenance/guidelines.md b/src/en/site-14/departments/maintenance/guidelines.md
diff --git a/src/en/site-14/departments/medical.md b/src/en/site-14/departments/medical.md
diff --git a/src/en/site-14/departments/medical/guidelines.md b/src/en/site-14/departments/medical/guidelines.md
diff --git a/src/en/site-14/departments/mtf.md b/src/en/site-14/departments/mtf.md
diff --git a/src/en/site-14/departments/mtf/guidelines.md b/src/en/site-14/departments/mtf/guidelines.md
diff --git a/src/en/site-14/departments/research.md b/src/en/site-14/departments/research.md
diff --git a/src/en/site-14/departments/research/guidelines.md b/src/en/site-14/departments/research/guidelines.md
diff --git a/src/en/site-14/departments/research/scps.md b/src/en/site-14/departments/research/scps.md
diff --git a/src/en/site-14/departments/security.md b/src/en/site-14/departments/security.md