Documentation Rework (#127)

Co-authored-by: Evan <[email protected]>

.gitignore

@@ -330,3 +330,5 @@ Builds/
 obj/
 AdminToolbox/Checklist.txt
 AdminToolbox/Checklist.txt
+
+!Documentation/**

Documentation/Commands.md

@@ -0,0 +1,180 @@
+
+<a name = 'Top'></a>
+
+# Commands
+
+*How to use **AdminToolbox** commands* <br>
+*both in the server & remote console.*
+
+<br>
+
+## Requirements
+
+**AdminToolbox** uses **[SMod]** which requires the <br>
+following to allow for the use of commands:
+
+- Enable  `enable_ra_server_commands`  in  `config_gameplay.txt`
+
+- Whitelist your **SteamId** / **Server Role**
+
+<br>
+<br>
+
+## ![Label Plugin]
+
+[<kbd> <br>     Help     <br> </kbd>][Plugin Help]   
+Open the documentation in the browser.
+
+[<kbd> <br>  Version  <br> </kbd>][Plugin Version]   
+Plugin version related operations.
+
+<br>
+<br>
+
+## ![Label Server]
+
+[<kbd> <br>  Information  <br> </kbd>][Server Info]   
+Display information about the server.
+
+[<kbd> <br>      Disable      <br> </kbd>][Server Disable]   
+Disable the **AdminToolbox** plugin.
+
+[<kbd> <br>        Color        <br> </kbd>][Server Color]   
+Colorize the server console.
+
+<br>
+<br>
+
+## ![Label Game]
+
+[<kbd> <br>        Warping        <br> </kbd>][Game Warp]   
+Establish warp points and teleport to them.
+
+[<kbd> <br>      Victories      <br> </kbd>][Game Victory]   
+Display the victories for each team.
+
+[<kbd> <br>  Keep Settings  <br> </kbd>][Game Remember]   
+Should players keep their settings?
+
+[<kbd> <br>        Players        <br> </kbd>][Game Players]   
+List players and related info.
+
+[<kbd> <br>      Round End      <br> </kbd>][Game End]   
+Should the round never end?
+
+<br>
+<br>
+
+## ![Label Player]
+
+[<kbd> <br>    Harmless    <br> </kbd>][Player Harmless]   
+Prevent the player from doing any damage.
+
+[<kbd> <br>        Jail        <br> </kbd>][Player Jail]   
+Jail a player for a certain amount of time.
+
+[<kbd> <br>   Breakable   <br> </kbd>][Player Break]   
+Make a player be able to break doors.
+
+[<kbd> <br>    Lockable    <br> </kbd>][Player Keys]   
+Give a player the ability to lock doors.
+
+[<kbd> <br>     Lockout     <br> </kbd>][Player Locked]   
+Prevent a player from opening doors.
+
+[<kbd> <br>    Narrator    <br> </kbd>][Player Narrator]   
+Set a player as the intercom speaker.
+
+[<kbd> <br>    Position    <br> </kbd>][Player Position]   
+Teleport a player to a certain position.
+
+[<kbd> <br>        Heal        <br> </kbd>][Player Heal]   
+Heals a player by a certain amount.
+
+[<kbd> <br>   Instakill   <br> </kbd>][Player Instakill]   
+Give a player the instakill ability.
+
+[<kbd> <br>      Summon      <br> </kbd>][Player Summon]   
+Summon one player to another.
+
+[<kbd> <br>    Tutorial    <br> </kbd>][Player Tutorial]   
+Give a player the Tutorial role.
+
+[<kbd> <br>  Information  <br> </kbd>][Player Info]   
+Display a players information.
+
+[<kbd> <br>   Ghost Mode   <br> </kbd>][Player Ghost]   
+Put a player into GhostMode.
+
+[<kbd> <br>     God Mode     <br> </kbd>][Player God]   
+Put a player into GodMode.
+
+[<kbd> <br>        Role        <br> </kbd>][Player Role]   
+Give a player a certain role.
+
+[<kbd> <br>    Spectator    <br> </kbd>][Player Spectator]   
+Make a player a spectator.
+
+[<kbd> <br>  Strip Items  <br> </kbd>][Player Strip]   
+Strip the items of a player.
+
+[<kbd> <br>    HitPoints    <br> </kbd>][Player HitPoints]   
+Set a players health.
+
+[<kbd> <br>          Ban          <br> </kbd>][Player Ban]   
+Ban an offline player.
+
+[<kbd> <br>         Kill         <br> </kbd>][Player Kill]   
+Kill a player.
+
+<br>
+
+
+<!----------------------------------------------------------------------------->
+
+[SMod]: https://github.com/ServerMod/Smod2
+
+
+<!-------------------------------[ Commands ]---------------------------------->
+
+[Plugin Version]: Commands/Plugin/Version.md
+[Plugin Help]: Commands/Plugin/Help.md
+
+[Server Disable]: Commands/Server/Disable.md
+[Server Color]: Commands/Server/Color.md
+[Server Info]: Commands/Server/Info.md
+
+[Game Remember]: Commands/Game/Remember.md
+[Game Players]: Commands/Game/Players.md
+[Game Victory]: Commands/Game/Victory.md
+[Game Warp]: Commands/Game/Warp.md
+[Game End]: Commands/Game/End.md
+
+[Player Spectator]: Commands/Player/Spectator.md
+[Player Instakill]: Commands/Player/Instakill.md
+[Player HitPoints]: Commands/Player/HitPoints.md
+[Player Harmless]: Commands/Player/Harmless.md
+[Player Tutorial]: Commands/Player/Tutorial.md
+[Player Position]: Commands/Player/Position.md
+[Player Narrator]: Commands/Player/Narrator.md
+[Player Locked]: Commands/Player/Locked.md
+[Player Summon]: Commands/Player/Summon.md
+[Player Ghost]: Commands/Player/Ghost.md
+[Player Strip]: Commands/Player/Strip.md
+[Player Break]: Commands/Player/Break.md
+[Player Heal]: Commands/Player/Heal.md
+[Player Keys]: Commands/Player/Keys.md
+[Player Info]: Commands/Player/Info.md
+[Player Jail]: Commands/Player/Jail.md
+[Player Role]: Commands/Player/Role.md
+[Player Kill]: Commands/Player/Kill.md
+[Player God]: Commands/Player/God.md
+[Player Ban]: Commands/Player/Ban.md
+
+
+<!--------------------------------[ Labels ]----------------------------------->
+
+[Label Player]: https://img.shields.io/badge/Player-A9225C?style=for-the-badge&logoColor=white&logo=ActiGraph
+[Label Server]: https://img.shields.io/badge/Server-0D597F?style=for-the-badge&logoColor=white&logo=GoogleSearchConsole
+[Label Plugin]: https://img.shields.io/badge/Plugin-02303A?style=for-the-badge&logoColor=white&logo=Buffer
+[Label Game]: https://img.shields.io/badge/Game-569A31?style=for-the-badge&logoColor=white&logo=SCPFoundation

Documentation/Commands/Game/End.md

@@ -0,0 +1,24 @@
+
+# Round End
+
+<kbd>  RLOCK  </kbd>   or   <kbd>  ROUNDLOCK  </kbd>
+
+<br>
+<br>
+
+## Description
+
+*Should rounds go on forever.*
+
+<br>
+<br>
+
+## Example
+
+*Round will not end.*
+
+```shell
+ROUNDLOCK true
+```
+
+<br>

Documentation/Commands/Game/Players.md

@@ -0,0 +1,13 @@
+
+# List Players
+
+<kbd>  PLAYERS  </kbd>
+
+<br>
+<br>
+
+## Description
+
+*Lists all **Player**s, their **IP**s & **SteamId**s.*
+
+<br>

Documentation/Commands/Game/Remember.md

@@ -0,0 +1,33 @@
+
+# Remember Settings
+
+<kbd>  KEEP  </kbd>   or   <kbd>  KEEPSETTINGS  </kbd>
+
+<br>
+<br>
+
+## Description
+
+*Should the selected player will keep* <br>
+*their settings once a new round starts.*
+
+<br>
+<br>
+
+## Example
+
+*No one will keep their settings.*
+
+```shell
+KEEPSETTINGS * false
+```
+
+<br>
+
+*`Gaben`  will keep their settings.*
+
+```shell
+KEEPSETTINGS Gaben true
+```
+
+<br>

Documentation/Commands/Game/Victory.md

@@ -0,0 +1,13 @@
+
+# Victories
+
+<kbd>  SERVERSTATS  </kbd>   or   <kbd>  ROUNDSTATS  </kbd>   or   <kbd>  STATS  </kbd>   or   <kbd>  ROUNDSTATS  </kbd>   or   <kbd>  RSTATS  </kbd>
+
+<br>
+<br>
+
+## Description
+
+*Displays per-team win since the last server restart.*
+
+<br>

Documentation/Commands/Game/Warp.md

@@ -0,0 +1,103 @@
+
+<br>
+
+<div align = center>
+
+# Teleport
+
+<kbd>  WARP  </kbd>
+
+</div>
+
+<br>
+
+### Description
+
+*Teleports the given player to the given warp point.*
+
+<br>
+
+### Example
+
+*Teleports  `Dave`  to  `Alpha`.*
+
+```shell
+WARP Dave Alpha
+```
+
+<br>
+<br>
+<br>
+
+<div align = center>
+
+# List
+
+<kbd>  WARP  </kbd>  <kbd>  LIST  </kbd>
+
+</div>
+
+<br>
+
+### Description
+
+*Lists all existing warp points.*
+
+<br>
+<br>
+<br>
+
+<div align = center>
+
+# Add
+
+<kbd>  WARP  </kbd>  <kbd>  ADD  </kbd>
+
+</div>
+
+<br>
+
+### Description
+
+*Adds a warp point at the givens player's location.*
+
+<br>
+
+### Example
+
+*Adds warp point  `Alpha`  at  `Daves`  position.*
+
+```shell
+WARP ADD Dave Alpha
+```
+
+<br>
+<br>
+<br>
+
+<div align = center>
+
+# Remove
+
+<kbd>  WARP  </kbd>  <kbd>  REMOVE  </kbd>
+
+</div>
+
+<br>
+
+### Description
+
+*Removes the warp point with the given name.*
+
+<br>
+
+### Example
+
+*Removes the warp point  `Alpha`.*
+
+```shell
+WARP REMOVE Alpha
+```
+
+<br>
+