From 21f9a626551e38c219a8ddd185cbad73dcda2f02 Mon Sep 17 00:00:00 2001
From: Moony <moonheart08@users.noreply.github.com>
Date: Wed, 1 Dec 2021 04:43:44 -0600
Subject: [PATCH] adds a debug map config, debugstation. (#5633)

Co-authored-by: metalgearsloth <31366439+metalgearsloth@users.noreply.github.com>
Co-authored-by: Paul <ritter.paul1@googlemail.com>
---
 Content.Shared/CCVar/CCVars.cs     | 37 ++++++++++++++++++++++++++++++
 Resources/Prototypes/Maps/test.yml | 34 +++++++++++++++++++++++++++
 2 files changed, 71 insertions(+)

diff --git a/Content.Shared/CCVar/CCVars.cs b/Content.Shared/CCVar/CCVars.cs
index a74b664112..74d69a3451 100644
--- a/Content.Shared/CCVar/CCVars.cs
+++ b/Content.Shared/CCVar/CCVars.cs
@@ -44,38 +44,72 @@ namespace Content.Shared.CCVar
          * Game
          */
 
+        /// <summary>
+        ///     Controls if the game should run station events
+        /// </summary>
         public static readonly CVarDef<bool>
             EventsEnabled = CVarDef.Create("events.enabled", true, CVar.ARCHIVE | CVar.SERVERONLY);
 
         public static readonly CVarDef<bool>
             GameDummyTicker = CVarDef.Create("game.dummyticker", false, CVar.ARCHIVE | CVar.SERVERONLY);
 
+        /// <summary>
+        ///     Controls if the lobby is enabled. If it is not, and there are no available jobs, you may get stuck on a black screen.
+        /// </summary>
         public static readonly CVarDef<bool>
             GameLobbyEnabled = CVarDef.Create("game.lobbyenabled", false, CVar.ARCHIVE);
 
+        /// <summary>
+        ///     Controls the duration of the lobby timer in seconds. Defaults to 2 minutes and 30 seconds.
+        /// </summary>
         public static readonly CVarDef<int>
             GameLobbyDuration = CVarDef.Create("game.lobbyduration", 150, CVar.ARCHIVE);
 
+        /// <summary>
+        ///     Controls if players can latejoin at all.
+        /// </summary>
         public static readonly CVarDef<bool>
             GameDisallowLateJoins = CVarDef.Create("game.disallowlatejoins", false, CVar.ARCHIVE | CVar.SERVERONLY);
 
+        /// <summary>
+        ///     Controls the default game preset.
+        /// </summary>
         public static readonly CVarDef<string>
             GameLobbyDefaultPreset = CVarDef.Create("game.defaultpreset", "Suspicion", CVar.ARCHIVE);
 
+        /// <summary>
+        ///     Controls if the game can force a different preset if the current preset's criteria are not met.
+        /// </summary>
         public static readonly CVarDef<bool>
             GameLobbyFallbackEnabled = CVarDef.Create("game.fallbackenabled", true, CVar.ARCHIVE);
 
+        /// <summary>
+        ///     The preset for the game to fall back to if the selected preset could not be used, and fallback is enabled.
+        /// </summary>
         public static readonly CVarDef<string>
             GameLobbyFallbackPreset = CVarDef.Create("game.fallbackpreset", "Sandbox", CVar.ARCHIVE);
 
+        /// <summary>
+        ///     Controls if people can win the game in Suspicion or Deathmatch.
+        /// </summary>
         public static readonly CVarDef<bool>
             GameLobbyEnableWin = CVarDef.Create("game.enablewin", true, CVar.ARCHIVE);
 
+        /// <summary>
+        ///     Controls the maximum number of character slots a player is allowed to have.
+        /// </summary>
         public static readonly CVarDef<int>
             GameMaxCharacterSlots = CVarDef.Create("game.maxcharacterslots", 10, CVar.ARCHIVE | CVar.SERVERONLY);
 
+        /// <summary>
+        ///     Controls the game map prototype to load. SS14 stores these prototypes in Prototypes/Maps.
+        /// </summary>
         public static readonly CVarDef<string>
             GameMap = CVarDef.Create("game.map", "saltern", CVar.SERVERONLY);
+
+        /// <summary>
+        ///     Controls if the game should obey map criteria or not. Overriden if a map vote or similar occurs.
+        /// </summary>
         public static readonly CVarDef<bool>
             GameMapForced = CVarDef.Create("game.mapforced", false, CVar.SERVERONLY);
 
@@ -300,6 +334,9 @@ namespace Content.Shared.CCVar
          * Admin logs
          */
 
+        /// <summary>
+        ///     Controls if admin logs are enabled. Highly recommended to shut this off for development.
+        /// </summary>
         public static readonly CVarDef<bool> AdminLogsEnabled =
             CVarDef.Create("adminlogs.enabled", true, CVar.SERVERONLY);
 
diff --git a/Resources/Prototypes/Maps/test.yml b/Resources/Prototypes/Maps/test.yml
index 30b9b99e02..54e73b089e 100644
--- a/Resources/Prototypes/Maps/test.yml
+++ b/Resources/Prototypes/Maps/test.yml
@@ -8,3 +8,37 @@
     - Assistant
   availableJobs:
     Assistant: [ -1, -1 ]
+
+- type: gameMap
+  id: debugstation
+  mapName: 'funny knightship'
+  mapNameTemplate: '{0} funny knight {1}'
+  nameGenerator:
+    !type:NanotrasenNameGenerator
+    prefixCreator: '14'
+  mapPath: Maps/knightship.yml
+  minPlayers: 0
+  votable: false
+  overflowJobs:
+    - Assistant
+  availableJobs:
+    CargoTechnician: [ -1, -1 ]
+    Assistant: [ -1, -1 ]
+    Bartender: [ -1, -1 ]
+    Botanist: [ -1, -1 ]
+    Chef: [ -1, -1 ]
+    Clown: [ -1, -1 ]
+    Janitor: [ -1, -1 ]
+    Mime: [ -1, -1 ]
+    Captain: [ -1, -1 ]
+    HeadOfPersonnel: [ -1, -1 ]
+    ChiefEngineer: [ -1, -1 ]
+    StationEngineer: [ -1, -1 ]
+    ChiefMedicalOfficer: [ -1, -1 ]
+    MedicalDoctor: [ -1, -1 ]
+    Chemist: [ -1, -1 ]
+    ResearchDirector: [ -1, -1 ]
+    Scientist: [ -1, -1 ]
+    HeadOfSecurity: [ -1, -1 ]
+    SecurityOfficer: [ -1, -1 ]
+    Chaplain: [ -1, -1 ]