From 46da5e8b32840ff654f233be78d8ae26ad0d706d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E3=83=88=E3=83=88=E3=82=82?= <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Wed, 6 Jul 2022 05:51:17 -0400 Subject: [PATCH] Documentation Rework (#127) Co-authored-by: Evan --- .gitignore | 2 + Documentation/Commands.md | 180 +++++++++++++++ Documentation/Commands/Game/End.md | 24 ++ Documentation/Commands/Game/Players.md | 13 ++ Documentation/Commands/Game/Remember.md | 33 +++ Documentation/Commands/Game/Victory.md | 13 ++ Documentation/Commands/Game/Warp.md | 103 +++++++++ Documentation/Commands/Player/AtBan.md | 33 --- Documentation/Commands/Player/Ban.md | 45 ++++ Documentation/Commands/Player/Break.md | 48 ++++ Documentation/Commands/Player/Breakdoors.md | 33 --- Documentation/Commands/Player/Command.md | 31 --- Documentation/Commands/Player/Empty.md | 37 --- Documentation/Commands/Player/Ghost.md | 110 +++++++++ Documentation/Commands/Player/GhostMode.md | 42 ---- Documentation/Commands/Player/God.md | 39 ++++ Documentation/Commands/Player/Harmless.md | 24 ++ Documentation/Commands/Player/Heal.md | 32 +++ Documentation/Commands/Player/HitPoints.md | 24 ++ Documentation/Commands/Player/Info.md | 24 ++ Documentation/Commands/Player/Instakill.md | 24 ++ Documentation/Commands/Player/Jail.md | 39 ++++ Documentation/Commands/Player/Keys.md | 61 +++++ Documentation/Commands/Player/Kill.md | 32 +++ Documentation/Commands/Player/LockDoors.md | 37 --- Documentation/Commands/Player/Locked.md | 25 ++ Documentation/Commands/Player/Narrator.md | 39 ++++ Documentation/Commands/Player/Position.md | 93 ++++++++ Documentation/Commands/Player/Role.md | 33 +++ Documentation/Commands/Player/Spectator.md | 24 ++ Documentation/Commands/Player/Strip.md | 67 ++++++ Documentation/Commands/Player/Summon.md | 26 +++ Documentation/Commands/Player/Tutorial.md | 24 ++ Documentation/Commands/Plugin/Help.md | 13 ++ Documentation/Commands/Plugin/Version.md | 35 +++ Documentation/Commands/README.md | 53 ----- Documentation/Commands/Server/Color.md | 25 ++ Documentation/Commands/Server/Disable.md | 21 ++ Documentation/Commands/Server/Info.md | 42 ++++ Documentation/Commands/Server/RoundLock.md | 0 Documentation/Commands/Server/Serverstats.md | 13 -- Documentation/Commands/Variables.md | 12 - Documentation/Commands/Whitelist-System.md | 1 - Documentation/Configuration.md | 213 ++++++++++++++++++ .../Configuration/Damage/After Party.md | 39 ++++ Documentation/Configuration/Damage/Blocked.md | 43 ++++ Documentation/Configuration/Damage/Global.md | 25 ++ .../Damage/LCZ De-Containment.md | 25 ++ .../Configuration/Damage/Tutorial.md | 65 ++++++ Documentation/Configuration/Debug/Detected.md | 14 ++ Documentation/Configuration/Debug/Enemy.md | 25 ++ Documentation/Configuration/Debug/Friendly.md | 25 ++ Documentation/Configuration/Debug/Kills.md | 25 ++ Documentation/Configuration/Debug/Special.md | 31 +++ Documentation/Configuration/Debug/Teamkill.md | 25 ++ Documentation/Configuration/General/Color.md | 26 +++ Documentation/Configuration/General/Enable.md | 25 ++ .../Configuration/General/Information.md | 25 ++ Documentation/Configuration/General/Joined.md | 30 +++ Documentation/Configuration/General/Match.md | 34 +++ .../Configuration/General/Tracking.md | 25 ++ .../Configuration/General/Version.md | 25 ++ Documentation/Configuration/Info/Join.md | 26 +++ .../Configuration/Intercom/Blacklist.md | 25 ++ .../Configuration/Intercom/Limited.md | 25 ++ Documentation/Configuration/Intercom/Ready.md | 25 ++ .../Configuration/Intercom/Restart.md | 25 ++ .../Configuration/Intercom/Transmission.md | 39 ++++ .../Configuration/Intercom/Whitelist.md | 42 ++++ .../Configuration/Logging/Commands.md | 25 ++ Documentation/Configuration/Logging/Damage.md | 25 ++ .../Configuration/Logging/Housekeeping.md | 46 ++++ Documentation/Configuration/Logging/Kills.md | 25 ++ .../Configuration/Logging/Location.md | 25 ++ .../Configuration/Logging/TeamKill.md | 25 ++ .../Configuration/Logging/Unified.md | 25 ++ Documentation/Configuration/Types.md | 105 +++++++++ Documentation/Installation.md | 61 +++++ Documentation/README.md | 53 ++++- Documentation/Resources.md | 13 -- .../Configuration-Documentation.md | 120 ---------- Documentation/Server Setup/How-To-Install.md | 22 -- .../Server Setup/Server-Name-Variables.md | 7 - README.md | 27 ++- 84 files changed, 2713 insertions(+), 472 deletions(-) create mode 100644 Documentation/Commands.md create mode 100644 Documentation/Commands/Game/End.md create mode 100644 Documentation/Commands/Game/Players.md create mode 100644 Documentation/Commands/Game/Remember.md create mode 100644 Documentation/Commands/Game/Victory.md create mode 100644 Documentation/Commands/Game/Warp.md delete mode 100644 Documentation/Commands/Player/AtBan.md create mode 100644 Documentation/Commands/Player/Ban.md create mode 100644 Documentation/Commands/Player/Break.md delete mode 100644 Documentation/Commands/Player/Breakdoors.md delete mode 100644 Documentation/Commands/Player/Command.md delete mode 100644 Documentation/Commands/Player/Empty.md create mode 100644 Documentation/Commands/Player/Ghost.md delete mode 100644 Documentation/Commands/Player/GhostMode.md create mode 100644 Documentation/Commands/Player/God.md create mode 100644 Documentation/Commands/Player/Harmless.md create mode 100644 Documentation/Commands/Player/Heal.md create mode 100644 Documentation/Commands/Player/HitPoints.md create mode 100644 Documentation/Commands/Player/Info.md create mode 100644 Documentation/Commands/Player/Instakill.md create mode 100644 Documentation/Commands/Player/Jail.md create mode 100644 Documentation/Commands/Player/Keys.md create mode 100644 Documentation/Commands/Player/Kill.md delete mode 100644 Documentation/Commands/Player/LockDoors.md create mode 100644 Documentation/Commands/Player/Locked.md create mode 100644 Documentation/Commands/Player/Narrator.md create mode 100644 Documentation/Commands/Player/Position.md create mode 100644 Documentation/Commands/Player/Role.md create mode 100644 Documentation/Commands/Player/Spectator.md create mode 100644 Documentation/Commands/Player/Strip.md create mode 100644 Documentation/Commands/Player/Summon.md create mode 100644 Documentation/Commands/Player/Tutorial.md create mode 100644 Documentation/Commands/Plugin/Help.md create mode 100644 Documentation/Commands/Plugin/Version.md delete mode 100644 Documentation/Commands/README.md create mode 100644 Documentation/Commands/Server/Color.md create mode 100644 Documentation/Commands/Server/Disable.md create mode 100644 Documentation/Commands/Server/Info.md delete mode 100644 Documentation/Commands/Server/RoundLock.md delete mode 100644 Documentation/Commands/Server/Serverstats.md delete mode 100644 Documentation/Commands/Variables.md delete mode 100644 Documentation/Commands/Whitelist-System.md create mode 100644 Documentation/Configuration.md create mode 100644 Documentation/Configuration/Damage/After Party.md create mode 100644 Documentation/Configuration/Damage/Blocked.md create mode 100644 Documentation/Configuration/Damage/Global.md create mode 100644 Documentation/Configuration/Damage/LCZ De-Containment.md create mode 100644 Documentation/Configuration/Damage/Tutorial.md create mode 100644 Documentation/Configuration/Debug/Detected.md create mode 100644 Documentation/Configuration/Debug/Enemy.md create mode 100644 Documentation/Configuration/Debug/Friendly.md create mode 100644 Documentation/Configuration/Debug/Kills.md create mode 100644 Documentation/Configuration/Debug/Special.md create mode 100644 Documentation/Configuration/Debug/Teamkill.md create mode 100644 Documentation/Configuration/General/Color.md create mode 100644 Documentation/Configuration/General/Enable.md create mode 100644 Documentation/Configuration/General/Information.md create mode 100644 Documentation/Configuration/General/Joined.md create mode 100644 Documentation/Configuration/General/Match.md create mode 100644 Documentation/Configuration/General/Tracking.md create mode 100644 Documentation/Configuration/General/Version.md create mode 100644 Documentation/Configuration/Info/Join.md create mode 100644 Documentation/Configuration/Intercom/Blacklist.md create mode 100644 Documentation/Configuration/Intercom/Limited.md create mode 100644 Documentation/Configuration/Intercom/Ready.md create mode 100644 Documentation/Configuration/Intercom/Restart.md create mode 100644 Documentation/Configuration/Intercom/Transmission.md create mode 100644 Documentation/Configuration/Intercom/Whitelist.md create mode 100644 Documentation/Configuration/Logging/Commands.md create mode 100644 Documentation/Configuration/Logging/Damage.md create mode 100644 Documentation/Configuration/Logging/Housekeeping.md create mode 100644 Documentation/Configuration/Logging/Kills.md create mode 100644 Documentation/Configuration/Logging/Location.md create mode 100644 Documentation/Configuration/Logging/TeamKill.md create mode 100644 Documentation/Configuration/Logging/Unified.md create mode 100644 Documentation/Configuration/Types.md create mode 100644 Documentation/Installation.md delete mode 100644 Documentation/Resources.md delete mode 100644 Documentation/Server Setup/Configuration-Documentation.md delete mode 100644 Documentation/Server Setup/How-To-Install.md delete mode 100644 Documentation/Server Setup/Server-Name-Variables.md diff --git a/.gitignore b/.gitignore index 1dedc54..631ca3e 100644 --- a/.gitignore +++ b/.gitignore @@ -330,3 +330,5 @@ Builds/ obj/ AdminToolbox/Checklist.txt AdminToolbox/Checklist.txt + +!Documentation/** diff --git a/Documentation/Commands.md b/Documentation/Commands.md new file mode 100644 index 0000000..032323a --- /dev/null +++ b/Documentation/Commands.md @@ -0,0 +1,180 @@ + + + +# Commands + +*How to use **AdminToolbox** commands*
+*both in the server & remote console.* + +
+ +## Requirements + +**AdminToolbox** uses **[SMod]** which requires the
+following to allow for the use of commands: + +- Enable  `enable_ra_server_commands`  in  `config_gameplay.txt` + +- Whitelist your **SteamId** / **Server Role** + +
+
+ +## ![Label Plugin] + +[ 
     Help     
 ][Plugin Help]    +Open the documentation in the browser. + +[ 
  Version  
 ][Plugin Version]    +Plugin version related operations. + +
+
+ +## ![Label Server] + +[ 
  Information  
 ][Server Info]    +Display information about the server. + +[ 
      Disable      
 ][Server Disable]    +Disable the **AdminToolbox** plugin. + +[ 
        Color        
 ][Server Color]    +Colorize the server console. + +
+
+ +## ![Label Game] + +[ 
        Warping        
 ][Game Warp]    +Establish warp points and teleport to them. + +[ 
      Victories      
 ][Game Victory]    +Display the victories for each team. + +[ 
  Keep Settings  
 ][Game Remember]    +Should players keep their settings? + +[ 
        Players        
 ][Game Players]    +List players and related info. + +[ 
      Round End      
 ][Game End]    +Should the round never end? + +
+
+ +## ![Label Player] + +[ 
    Harmless    
 ][Player Harmless]    +Prevent the player from doing any damage. + +[ 
        Jail        
 ][Player Jail]    +Jail a player for a certain amount of time. + +[ 
   Breakable   
 ][Player Break]    +Make a player be able to break doors. + +[ 
    Lockable    
 ][Player Keys]    +Give a player the ability to lock doors. + +[ 
     Lockout     
 ][Player Locked]    +Prevent a player from opening doors. + +[ 
    Narrator    
 ][Player Narrator]    +Set a player as the intercom speaker. + +[ 
    Position    
 ][Player Position]    +Teleport a player to a certain position. + +[ 
        Heal        
 ][Player Heal]    +Heals a player by a certain amount. + +[ 
   Instakill   
 ][Player Instakill]    +Give a player the instakill ability. + +[ 
      Summon      
 ][Player Summon]    +Summon one player to another. + +[ 
    Tutorial    
 ][Player Tutorial]    +Give a player the Tutorial role. + +[ 
  Information  
 ][Player Info]    +Display a players information. + +[ 
   Ghost Mode   
 ][Player Ghost]    +Put a player into GhostMode. + +[ 
     God Mode     
 ][Player God]    +Put a player into GodMode. + +[ 
        Role        
 ][Player Role]    +Give a player a certain role. + +[ 
    Spectator    
 ][Player Spectator]    +Make a player a spectator. + +[ 
  Strip Items  
 ][Player Strip]    +Strip the items of a player. + +[ 
    HitPoints    
 ][Player HitPoints]    +Set a players health. + +[ 
          Ban          
 ][Player Ban]    +Ban an offline player. + +[ 
         Kill         
 ][Player Kill]    +Kill a player. + +
+ + + + +[SMod]: https://github.com/ServerMod/Smod2 + + + + +[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 + + + + +[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 diff --git a/Documentation/Commands/Game/End.md b/Documentation/Commands/Game/End.md new file mode 100644 index 0000000..aa6908d --- /dev/null +++ b/Documentation/Commands/Game/End.md @@ -0,0 +1,24 @@ + +# Round End + +  RLOCK     or     ROUNDLOCK   + +
+
+ +## Description + +*Should rounds go on forever.* + +
+
+ +## Example + +*Round will not end.* + +```shell +ROUNDLOCK true +``` + +
diff --git a/Documentation/Commands/Game/Players.md b/Documentation/Commands/Game/Players.md new file mode 100644 index 0000000..11f2712 --- /dev/null +++ b/Documentation/Commands/Game/Players.md @@ -0,0 +1,13 @@ + +# List Players + +  PLAYERS   + +
+
+ +## Description + +*Lists all **Player**s, their **IP**s & **SteamId**s.* + +
\ No newline at end of file diff --git a/Documentation/Commands/Game/Remember.md b/Documentation/Commands/Game/Remember.md new file mode 100644 index 0000000..2c4ae93 --- /dev/null +++ b/Documentation/Commands/Game/Remember.md @@ -0,0 +1,33 @@ + +# Remember Settings + +  KEEP     or     KEEPSETTINGS   + +
+
+ +## Description + +*Should the selected player will keep*
+*their settings once a new round starts.* + +
+
+ +## Example + +*No one will keep their settings.* + +```shell +KEEPSETTINGS * false +``` + +
+ +*`Gaben`  will keep their settings.* + +```shell +KEEPSETTINGS Gaben true +``` + +
diff --git a/Documentation/Commands/Game/Victory.md b/Documentation/Commands/Game/Victory.md new file mode 100644 index 0000000..fbc803b --- /dev/null +++ b/Documentation/Commands/Game/Victory.md @@ -0,0 +1,13 @@ + +# Victories + +  SERVERSTATS     or     ROUNDSTATS     or     STATS     or     ROUNDSTATS     or     RSTATS   + +
+
+ +## Description + +*Displays per-team win since the last server restart.* + +
diff --git a/Documentation/Commands/Game/Warp.md b/Documentation/Commands/Game/Warp.md new file mode 100644 index 0000000..535e384 --- /dev/null +++ b/Documentation/Commands/Game/Warp.md @@ -0,0 +1,103 @@ + +
+ +
+ +# Teleport + +  WARP   + +
+ +
+ +### Description + +*Teleports the given player to the given warp point.* + +
+ +### Example + +*Teleports  `Dave`  to  `Alpha`.* + +```shell +WARP Dave Alpha +``` + +
+
+
+ +
+ +# List + +  WARP      LIST   + +
+ +
+ +### Description + +*Lists all existing warp points.* + +
+
+
+ +
+ +# Add + +  WARP      ADD   + +
+ +
+ +### Description + +*Adds a warp point at the givens player's location.* + +
+ +### Example + +*Adds warp point  `Alpha`  at  `Daves`  position.* + +```shell +WARP ADD Dave Alpha +``` + +
+
+
+ +
+ +# Remove + +  WARP      REMOVE   + +
+ +
+ +### Description + +*Removes the warp point with the given name.* + +
+ +### Example + +*Removes the warp point  `Alpha`.* + +```shell +WARP REMOVE Alpha +``` + +
+ diff --git a/Documentation/Commands/Player/AtBan.md b/Documentation/Commands/Player/AtBan.md deleted file mode 100644 index 0497ac6..0000000 --- a/Documentation/Commands/Player/AtBan.md +++ /dev/null @@ -1,33 +0,0 @@ -# ATBAN - -Bans IP/STEAMID for X minutes. (For banning offline users) - -## Command usage - -* ATBAN ([string][csharp]: PlayerName/Label) ([string][csharp]: IP or SteamID) <[integer][csharp]: Minutes> - -Parameter | Default State | Description ---: | :--: | :-- -PlayerName / Label | | What shows where Player's name usually is in the ban file. Can be anything -IP / SteamID | | Either a steamID or a IP-adress -Minutes | 43800 | Defaults to 4 weeks when not specified otherwise - -### Command Aliases - -List of Aliases for the word `ATBAN` - -* OBAN -* OFFLINEBAN - -## Examples - -Command | Label | IP / SteamID | Duration | Description ---- | :---: | :---: | :---: | --- -ATBAN | Hubert | 7656119796028xxxx | 60 | Bans the steamID provided for 60 minutes (1 hour) -OBAN | Gaben | 89.82.35.149 | 120 | Bans the IP provided for 120 minutes (2 hours) - -### Note - -[csharp]: https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/built-in-types-table -[player]: ../Variables.md -[resources]: ../Resources.md \ No newline at end of file diff --git a/Documentation/Commands/Player/Ban.md b/Documentation/Commands/Player/Ban.md new file mode 100644 index 0000000..7eb27ac --- /dev/null +++ b/Documentation/Commands/Player/Ban.md @@ -0,0 +1,45 @@ + +# Offline Ban + +  OBAN     or     ATBAN     or     OFFLINEBAN   + +
+
+ +## Description + +*Bans the given **IP** or **SteamID** for*
+*the given amount of minutes.* + +*Used for banning offline players.* + +
+
+ +## Duration + +*Ban time defaults to  `43800 Minutes`  /  `4 Weeks`.* + +
+
+ +## Example + +*Bans the **SteamId** for  `60 Minutes`  and labels it  `Hubert`.* + +```shell +ATBAN Hubert 7656119796028xxxx 60 +``` + +
+ +*Bans the **IP** for  `120 Minutes`  and labels it  `Gaben`.* + +```shell +ATBAN Gaben 89.82.35.149 120 +``` + +
+ + + diff --git a/Documentation/Commands/Player/Break.md b/Documentation/Commands/Player/Break.md new file mode 100644 index 0000000..ec4d800 --- /dev/null +++ b/Documentation/Commands/Player/Break.md @@ -0,0 +1,48 @@ + +# Break Doors + +  BD     or     BREAKDOOR     or     BREAKDOORS   + +
+
+ +## Description + +*Makes the given player able to break doors upon interaction.* + +
+
+ +## Listing + +To list who can break doors, pass  `LIST`. + +
+
+ +## Examples + +*Enabled breaking doors for  `Evan`.* + +```shell +BREAKDOOR Evan true +``` + +
+ +*Toggles door breaking for  `Robert`.* + +```shell +BREAKDOOR Robert +``` + +
+ +*Lists **all** players that can break doors.* + +```shell +BREAKDOOR LIST +``` + +
+ diff --git a/Documentation/Commands/Player/Breakdoors.md b/Documentation/Commands/Player/Breakdoors.md deleted file mode 100644 index 345f21d..0000000 --- a/Documentation/Commands/Player/Breakdoors.md +++ /dev/null @@ -1,33 +0,0 @@ -# BREAKDOORS - -Makes the user able to break doors upon interaction - -## Command usage - -* BREAKDOORS <[Player][player]> <[Boolean][csharp]: State> - -Parameter | Description ---: | :-- -PLAYER | Self-Targeting | Unless other player is specified, targets self -State | Toggle | Unless specified, enabled state toggles - -List of Aliases for the word `BREAKDOORS` - -* BREAKDOOR -* BD - -## Examples - -Command | [Player][player] | [Bool][csharp] (Default: True) | Description ---- | :---: | :---: | --- -BD | Evan | true | Enables breaking doors for specified player -BD | Robert | | Toggles the enabled/disabled state -BREAKDOORS | LIST | | Lists all players with BREAKDOORS enabled - -### Note - -Additional_info - -[csharp]: https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/built-in-types-table -[player]: ../Variables.md -[resources]: ../Resources.md \ No newline at end of file diff --git a/Documentation/Commands/Player/Command.md b/Documentation/Commands/Player/Command.md deleted file mode 100644 index f783e85..0000000 --- a/Documentation/Commands/Player/Command.md +++ /dev/null @@ -1,31 +0,0 @@ -# CommandName - -Does_a_thing - -## Command usage - -* CommandName - -Parameter | Default State | Description ---: | :--: | :-- - -### Command Aliases - -List of Aliases for the word `CommandName` - -* 1 -* 2 -* 3 - -## Examples - -Command | Arguement_1 | Arguement_2 | Arguement_3 | Arguement_4 | Description ---- | :---: | :---: | :---: | :---: | --- - -### Note - -Additional_info - -[csharp]: https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/built-in-types-table -[player]: ../Variables.md -[resources]: ../Resources.md \ No newline at end of file diff --git a/Documentation/Commands/Player/Empty.md b/Documentation/Commands/Player/Empty.md deleted file mode 100644 index 7c81c6b..0000000 --- a/Documentation/Commands/Player/Empty.md +++ /dev/null @@ -1,37 +0,0 @@ -# Empty - -Empties the inventory of the spesified player. Optionally deletes the items completely. - -## Command usage - -* EMPTY [PLAYER][player] - -Parameter | Default State | Description ---: | :--: | :-- -ITEM-ID | | See [resource][resources] page - -### Command Aliases - -List of Aliases for the word `EMPTY` - -* E - -## Examples - -Command | [Player][player] | (Item-ID / DELETE) | | Description ---- | :---: | :---: | :---: | --- -EMPTY | Evan | 11 | | Drops all 05 keycards from player -EMPTY | Robert | 0 | DELETE | Permamently deletes all Janitor keycards from player -EMPTY | Frank | | | Drops all items from player (simmilar to "dropall") -EMPTY | Bob | DELETE | | Permamently deletes all items in Bob's inventory - -### Note - -List of Aliases for the word `DELETE` - -* DEL -* D - -[csharp]: https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/built-in-types-table -[player]: ../Variables.md -[resources]: ../Resources.md \ No newline at end of file diff --git a/Documentation/Commands/Player/Ghost.md b/Documentation/Commands/Player/Ghost.md new file mode 100644 index 0000000..312d275 --- /dev/null +++ b/Documentation/Commands/Player/Ghost.md @@ -0,0 +1,110 @@ + +# GhostMode + +  GH     or     GHOST     or     GHOSTM     or     GHOSTMODE   + +
+
+ +## Description + +*Makes the given player invisible to other.* + +
+
+ +## Enabling + +*To use GhostMode, you will need to set the **[SMod]**
+config option  `sm_enable_ghostmode`  to  `true`.* + +
+
+ +## Invisibility + +*There are multiple invisibility types.* + +  State      Spectators      Speaking   + +
+ +### State + +Is GhostMode enabled? + +
+ +### Spectators + +Can spectators see the ghost? + +*Defaults to  `true`.* + +
+ +### Speaking + +Can other see a talking ghost? + +*Requires the ghost to equip a radio.* + +*Defaults to  `true`.* + +
+
+ +## Listing + +*To list all ghosts, pass  `LIST`  or  `GET`.* + +
+
+ +## Examples + +*Makes  `Evan`  a ghost.* + +```shell +GHOST Evan true +``` + +
+ +*Makes  `Hubert`  a ghost that spectators cannot see.* + +```shell +GHOST Hubert true false +``` + +
+ +*Makes  `Mike`  a ghost that cannot*
+*be seen while talking on the radio.* + +```shell +GHOST Mike true true false +``` + +
+ +*Makes **everyone** a ghost.* + +```shell +GHOST * true +``` + +
+ +*List whose a ghost.* + +```shell +GHOST LIST +``` + +
+ + + + +[SMod]: https://github.com/ServerMod/Smod2 diff --git a/Documentation/Commands/Player/GhostMode.md b/Documentation/Commands/Player/GhostMode.md deleted file mode 100644 index 7918862..0000000 --- a/Documentation/Commands/Player/GhostMode.md +++ /dev/null @@ -1,42 +0,0 @@ -# GhostMode - -Command to go invisible for other players. - -## Command usage - -* GHOSTMODE <[Player][player]> <[Boolean][csharp]: State> <[Boolean][csharp]: Visible to Spectator> <[Boolean][csharp]: Visible when speaking> - -Parameter | Default State | Description ---: | :--: | :-- -PLAYER | Self-Targeting | Unless other player is specified, targets self -State | N/A | The ON/OFF state of the command -Visible to spectator | True | If spectator can see the user or not -Visible while speaking | True | If other players can see the user while user is speaking - -> Note that "Visible while speaking" only works with a radio in the user's hand - -### Command Aliases - -List of Aliases for the word `GHOSTMODE` - -* GH -* GHOST -* GHOSTM - -## Examples - -Command | [Player][player] | [Bool][csharp] (Default: Toggle) | [Bool][csharp] (Default: True) | [Bool][csharp] (Default: True) | Description ---- | :---: | :---: | :---: | :---: | --- -GHOST | Evan | true | | | This would enable ghostmode with `visible to spectator` & `visible when speaking` to true -GHOSTMODE | Hubert | true | false | | This would enable ghostmode without beeing visible to spectators -GH | * | true | | | Would enable ghostmode for all players -GHOSTM | LIST / GET | | | | Would list all players with GHOSTMODE active - -### Note - -All [bools][csharp] are optional ->The SMod `sm_enable_ghostmode` config needs to be set to `true` to use GHOSTMODE - -[csharp]: https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/built-in-types-table -[player]: ../Variables.md -[resources]: ../Resources.md diff --git a/Documentation/Commands/Player/God.md b/Documentation/Commands/Player/God.md new file mode 100644 index 0000000..6c6855b --- /dev/null +++ b/Documentation/Commands/Player/God.md @@ -0,0 +1,39 @@ + +# GodMode + +  ATGOD   + +
+
+ +## Description + +*Sets the given player into GodMode.* + +
+
+ +## No Damage + +Append  `nodmg`  to simultaneously activate it. + +
+
+ +## Examples + +*Makes  `Mike`  a god with NoDmg.* + +```shell +ATGOD Mike true nodmg +``` + +
+ +*Toggles whether or not  `Mike`  is a god.* + +```shell +ATGOD Mike +``` + +
diff --git a/Documentation/Commands/Player/Harmless.md b/Documentation/Commands/Player/Harmless.md new file mode 100644 index 0000000..c6b9aed --- /dev/null +++ b/Documentation/Commands/Player/Harmless.md @@ -0,0 +1,24 @@ + +# Harmless + + NODMG   + +
+
+ +## Description + +*Prevents the given player from doing any damage.* + +
+
+ +## Examples + +*Stops  `Mike`  from doing any damage.* + +```shell +NODMG Mike true +``` + +
diff --git a/Documentation/Commands/Player/Heal.md b/Documentation/Commands/Player/Heal.md new file mode 100644 index 0000000..ff6bf5d --- /dev/null +++ b/Documentation/Commands/Player/Heal.md @@ -0,0 +1,32 @@ + +# Heal + +  ATHEAL   + +
+
+ +## Description + +*Heals the given player by the given amount.* + +
+
+ +## Examples + +*Heals  `Mike`  by  `20 Hp`.* + +```shell +ATHEAL Mike 20 +``` + +
+ +*Heals  `Mike`  completely.* + +```shell +ATHEAL Mike +``` + +
diff --git a/Documentation/Commands/Player/HitPoints.md b/Documentation/Commands/Player/HitPoints.md new file mode 100644 index 0000000..533a5e6 --- /dev/null +++ b/Documentation/Commands/Player/HitPoints.md @@ -0,0 +1,24 @@ + +# HitPoints + +  ATHP     or     ATSETHP   + +
+
+ +## Description + +*Sets the given players HP to the given amount.* + +
+
+ +## Example + +*Sets  `Mike`'s HP to  `40 HitPoints`.* + +```shell +ATHP Mike 40 +``` + +
diff --git a/Documentation/Commands/Player/Info.md b/Documentation/Commands/Player/Info.md new file mode 100644 index 0000000..87923e3 --- /dev/null +++ b/Documentation/Commands/Player/Info.md @@ -0,0 +1,24 @@ + +# Player Info + +  P     or     PLAYER   + +
+
+ +## Description + +*Displays all statistics for the given player.* + +
+
+ +## Example + +*Displays all of  `Mike`'s information.* + +```shell +PLAYER Mike +``` + +
diff --git a/Documentation/Commands/Player/Instakill.md b/Documentation/Commands/Player/Instakill.md new file mode 100644 index 0000000..79df490 --- /dev/null +++ b/Documentation/Commands/Player/Instakill.md @@ -0,0 +1,24 @@ + +# InstaKill + +  IK     or     INSTAKILL     or     INSTANTKILL   + +
+
+ +## Description + +*Let the given player be able to instantly kill.* + +
+
+ +## Example + +*Gives  `Mike`  the instakill ability.* + +```shell +INSTAKILL Mike +``` + +
diff --git a/Documentation/Commands/Player/Jail.md b/Documentation/Commands/Player/Jail.md new file mode 100644 index 0000000..3b2406c --- /dev/null +++ b/Documentation/Commands/Player/Jail.md @@ -0,0 +1,39 @@ + +# Jail + + Jail   + +
+
+ +## Description + +*Jails the given player for the given amount of time.* + +
+
+ +## Un-jailing + +*Simply reuse the command on the jailed player.* + +
+
+ +## Examples + +*Jails  `Mike`  for   `1 Year`.* + +```shell +JAIL Mike +``` + +
+ +*Jails  `Mike`  for  `x`.* + +```shell +JAIL Mike x +``` + +
diff --git a/Documentation/Commands/Player/Keys.md b/Documentation/Commands/Player/Keys.md new file mode 100644 index 0000000..5804525 --- /dev/null +++ b/Documentation/Commands/Player/Keys.md @@ -0,0 +1,61 @@ + +# Lock Doors + +  ATDL     or     ATLD     or     ATLOCK     or     DOORLOCK     or     LOCKDOORS   + +
+
+ +## Description + +*Makes the given player able to*
+*lock doors upon interaction.* + +
+
+ +## Listing + +*To list all players that*
+*have keys, pass  `LIST`.* + +
+
+ +## Example + +*Gives keys to **all** players.* + +```shell +LOCKDOOR * true +``` + +
+ +*Gives keys to **yourself**.* + +```shell +LOCKDOOR true +``` + +
+ +*Takes keys from  `Hubert`* + +```shell +LOCKDOOR Hubert false +``` + +
+ +*List **all** players with keys.* + +```shell +LOCKDOOR LIST +``` + +
+ + + + diff --git a/Documentation/Commands/Player/Kill.md b/Documentation/Commands/Player/Kill.md new file mode 100644 index 0000000..08fc558 --- /dev/null +++ b/Documentation/Commands/Player/Kill.md @@ -0,0 +1,32 @@ + +# Kill + +  KILL     or     SLAY   + +
+
+ +## Description + +*Kills the given player.* + +
+
+ +## Example + +*Kills  `Mike`.* + +```shell +KILL Mike +``` + +
+ +*Kills **everyone** except youself.* + +```shell +KILL * +``` + +
diff --git a/Documentation/Commands/Player/LockDoors.md b/Documentation/Commands/Player/LockDoors.md deleted file mode 100644 index db84865..0000000 --- a/Documentation/Commands/Player/LockDoors.md +++ /dev/null @@ -1,37 +0,0 @@ -# LOCKDOORS - -Makes the user able to lock doors upon interaction - -## Command usage - -* LOCKDOORS <[Boolean][csharp]: State> -* LOCKDOORS <[PLAYER][player]> <[Boolean][csharp]: State> -* LOCKDOORS LIST - -Parameter | Default State | Description ---: | :--: | :-- -PLAYER | Self-Targeting | Unless other player is specified, targets self -State | Toggle | Unless specified, enabled state toggles - -### Command Aliases - -List of Aliases for the word `LOCKDOORS` - -* DOORLOCK -* ATLOCK -* ATLD -* ATDL - -## Examples - -Command | Arguement_1 | Arguement_2 | Description ---- | :---: | :---: | --- -LOCKDOORS | * | | Enables lockdoors for ALL players -ATLD | Evan | True | Enables lockdoors -ATLOCK | Hubert | 0 | Disables lockdoors -ATDL | LIST | | Lists all players with LOCKDOORS enabled - - -[csharp]: https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/built-in-types-table -[player]: ../Variables.md -[resources]: ../Resources.md \ No newline at end of file diff --git a/Documentation/Commands/Player/Locked.md b/Documentation/Commands/Player/Locked.md new file mode 100644 index 0000000..a889060 --- /dev/null +++ b/Documentation/Commands/Player/Locked.md @@ -0,0 +1,25 @@ + +# Lock Doors + +  PL     or     PLOCK     or     PLAYERLOCK     or     PLAYERLOCKDOWN   + +
+
+ +## Description + +*Locks all doors for the given player.* + +
+
+ +## Example + +*Locks all doors for  `Mike`.* + +```shell +PLAYERLOCK Mike true +``` + +
+ diff --git a/Documentation/Commands/Player/Narrator.md b/Documentation/Commands/Player/Narrator.md new file mode 100644 index 0000000..3080c68 --- /dev/null +++ b/Documentation/Commands/Player/Narrator.md @@ -0,0 +1,39 @@ + +# Narrator + +  ATSPEAK     or     ATINTERCOM     or     AT-SPEAK   + +
+
+ +## Description + +*Set the given player as the intercom speaker.* + +
+
+ +## Note + +*Cancels any ongoing broadcasts.* + +
+
+ +## Examples + +*Makes  `Mike`  the narrator.* + +```shell +ATSPEAK Mike +``` + +
+ +*Makes **yourself** the narrator.* + +```shell +ATSPEAK +``` + +
diff --git a/Documentation/Commands/Player/Position.md b/Documentation/Commands/Player/Position.md new file mode 100644 index 0000000..28a56e0 --- /dev/null +++ b/Documentation/Commands/Player/Position.md @@ -0,0 +1,93 @@ + +
+ +
+ +# Move + +  POS      ADD   + +
+ +
+ +### Description + +*Moves the given player by the given amount.* + +
+ +### Example + +*Moves  `Mike`  by  `5 Units`  on the X-Axis.* + +```shell +POS Mike ADD x=5 +``` + +
+ +*Moves  `Mike`  by  `2 Units`  on both the Y & Z Axis.* + +```shell +POS Mike ADD y=2 z=2 +``` + +
+
+
+ +
+ +# Goto + +  POS      SET   + +
+ +
+ +### Description + +*Sets the given player's position..* + +
+ +### Examples + +*Teleports  `Mike`  to  `X:1`  `Y:2`  `Z:3`.* + +```shell +POS Mike SET x=1 y=2 z=3 +``` + +
+
+
+ +
+ +# Where + +  POS      GET   + +
+ +
+ +### Description + +*Query where the given player currently is located at.* + +
+ +### Example + +*Returns the position of  `Mike`.* + +```shell +POS GET Mike +``` + +
+ diff --git a/Documentation/Commands/Player/Role.md b/Documentation/Commands/Player/Role.md new file mode 100644 index 0000000..899ae6e --- /dev/null +++ b/Documentation/Commands/Player/Role.md @@ -0,0 +1,33 @@ + +# Role + +  ROLE   + +
+
+ +## Description + +*Assigns the given player the given role.* + +
+
+ +## Notes + +- Does not teleport the player to the role's spawn. + +- Does not equip the player with the role's items. + +
+
+ +## Example + +*Gives  `Mike`  the  `SCIENTIST`  role.* + +```shell +ROLE Mike 6 +``` + +
diff --git a/Documentation/Commands/Player/Spectator.md b/Documentation/Commands/Player/Spectator.md new file mode 100644 index 0000000..263e335 --- /dev/null +++ b/Documentation/Commands/Player/Spectator.md @@ -0,0 +1,24 @@ + +# Spectator Mode + +  SPEC     or     SPECTATOR   + +
+
+ +## Description + +*Sets if the given player should be a spectator.* + +
+
+ +## Example + +*Puts  `Mike`  into spectator mode.* + +```shell +SPECTATOR Mike true +``` + +
diff --git a/Documentation/Commands/Player/Strip.md b/Documentation/Commands/Player/Strip.md new file mode 100644 index 0000000..ae5ac5b --- /dev/null +++ b/Documentation/Commands/Player/Strip.md @@ -0,0 +1,67 @@ + +# Strip Items + +  E     or     EMPTY   + +
+
+ +## Description + +*Removes items from the given players inventory.* + +
+
+ +## Item + +By appending an item Id, only that item
+will be removed from the inventory. + +
+
+ +## Delete + +  D    or    DEL    or    DELETE   + +If this option is appended, items
+will be delete instead of dropped. + +
+
+ +## Examples + +*Drops all of  `Evens`  05 keycards.* + +```shell +EMPTY Evan 11 +``` + +
+ +*Deletes  `Roberts`  janitor keycards.* + +```shell +EMPTY Robert 0 DELETE +``` + +
+ +*Deletes all of  `Bobs`  items.* + +```shell +EMPTY Bob DELETE +``` + +
+ +*Drops all of  `Franks`  items.* + +```shell +EMPTY Frank +``` + +
+ diff --git a/Documentation/Commands/Player/Summon.md b/Documentation/Commands/Player/Summon.md new file mode 100644 index 0000000..0022d08 --- /dev/null +++ b/Documentation/Commands/Player/Summon.md @@ -0,0 +1,26 @@ + +# Teleport + +  TPX   + +
+
+ +## Description + +*Teleports one player to another.* + +*Uses the closest match to the given names.* + +
+
+ +## Example + +*Teleports  `Dave`  to  `Mike`.* + +```shell +TPX Dave Mike +``` + +
diff --git a/Documentation/Commands/Player/Tutorial.md b/Documentation/Commands/Player/Tutorial.md new file mode 100644 index 0000000..90963cc --- /dev/null +++ b/Documentation/Commands/Player/Tutorial.md @@ -0,0 +1,24 @@ + +# Tutorial Role + +  TUT     or     TUTORIAL   + +
+
+ +## Description + +*Set the given player's role to  `TUTORIAL`.* + +
+
+ +## Example + +*Gives  `Mike`  the  `TUTORIAL`  role.* + +```shell +TUTORIAL Mike +``` + +
diff --git a/Documentation/Commands/Plugin/Help.md b/Documentation/Commands/Plugin/Help.md new file mode 100644 index 0000000..4351a5a --- /dev/null +++ b/Documentation/Commands/Plugin/Help.md @@ -0,0 +1,13 @@ + +# Help + +  ATHELP     + +
+
+ +## Description + +*Opens this documentation in your browser.* + +
diff --git a/Documentation/Commands/Plugin/Version.md b/Documentation/Commands/Plugin/Version.md new file mode 100644 index 0000000..2035fac --- /dev/null +++ b/Documentation/Commands/Plugin/Version.md @@ -0,0 +1,35 @@ + +# Plugin Version + +  AT     + +
+
+ +## Operations + +
+ +### Help + +  AT      HELP     + +*Displays information about the  `AT`  command.* + +
+ +### Info + +  AT      INFO    + +*Compares the current plugin version to the latest available.* + +
+ +### Download + +  AT      DOWNLOAD    + +*Open the download page in a new browser window.* + +
diff --git a/Documentation/Commands/README.md b/Documentation/Commands/README.md deleted file mode 100644 index 92335d9..0000000 --- a/Documentation/Commands/README.md +++ /dev/null @@ -1,53 +0,0 @@ -### Note that all commands below requires you to have `enable_ra_server_commands:` set to true in your `config_gameplay.txt`, and your steamID64/SERVER-ROLE added to the whitelist for them to work. This is part of [Smod](https://github.com/Grover-c13/Smod2), not the plugin. -*** -## Administration COMMANDS / Gameplay COMMANDS -Command | Value Type | Value Type | Description ---- | :---: | :---: | --- -P / PLAYER | Player | | Lists all values for the specified Player -PLAYERS | | | Lists all players + IP's + SteamID's. -[ATBAN](Commands/Player/AtBan.md) | | | For banning offline user's IP/SteamID. See command's page for more info -ATGOD | Player | Boolean | Turns on/off godmode for that player. Use without (bool) to toggle. Add `nodmg` after (bool) to turn on NoDmg as as well for this player -NODMG | Player | Boolean | Turns on/off damageOutput for that player. Use without (bool) to toggle. -ATHP / ATSETHP | Player | Integer | Sets player HP to (Integer). -ATHEAL | Player | Integer | Heals player for (Integer) amount. Use without (Integer) to set to Role default max HP. -TPX | Player1 | Player2 | Teleports Player1 to Player2. (Will not grab all players names that contain the string you entered like TP does, only the closest match) -TUT / TUTORIAL | Player | | Sets player role to TUTORIAL. -ROLE | Player | ROLEID | Sets player to ROLE without teleporting them to ROLE SPAWN or giving items. -KEEP / KEEPSETTINGS | Player| Boolean | Enables keeping player settings on round restart. -RLOCK / ROUNDLOCK | Boolean | | Turns on/off round ending -BD / BREAKDOORS | Player | Boolean | Turns on/off breaking doors for that player. -PL / PLOCK / PLAYERLOCK / PLAYERLOCKDOWN | Player | Boolean | Locks all doors for the specified player. -SPEC / SPECTATOR | Player | Boolean | Player will never spawn naturally. -IK / INSTAKILL / INSTANTKILL | Player | Boolean | Turns on/off instant kills for that player. -ATDISABLE | | | **Disables the Admintoolbox plugin.** Server will need restart to enable it again -ATCOLOR | Boolean | | `Enable/Disable` admintoolbox colors in server console (currently bugged) -JAIL | Player | seconds | Jails the player for the specified (if not specified, defaults to 1 year) time. Re-use to unjail. -S / SERVERINFO | | | Lists information on the server, such as the name, IP, port, player count, round number and duration, admintoolbox coloring, roundlock and jailed players -KILL / SLAY | Player | | Kills target player. Using `*` will exclude the player using the command -ATSPEAK / ATINTERCOM / AT-SPEAK | Player | | Sets player as Intercom Speaker. Use without Player to set yourself. If used while broadcast, the current broadcast will cancel. -ATHELP | | | Opens this GitHub page for the user -AT | HELP / INFO / DOWNLOAD | | `INFO` compares the server's AT version with the latest GitHub one. `DOWNLOAD` opens a new browser page for the newest download -SERVERSTATS / ROUNDSTATS | | | Displays each type of victory since last server (re)boot -[GHOSTMODE](Commands/Player/GhostMode.md) | | | For becoming invisible - ->Any `Player` variable can be switched out with `*` to target all players. Not specifying a bool toggles it. ->Using `(command) list` will list all players with the currently enabled status. (Like godmode for example) - ->Find a complete list of Role ID's & Item ID's [HERE](Resources.md) -*** -### Advanced Commands (Theese are harder to use and/or requires more Values) -Command | Value Type | Value Type | Value Type | Description ---- | :---: | :---: | :---: | --- -WARP | ADD | Player | WarpName | Adds a warp point where `Player` is -WARP | REMOVE | WarpName | | Removes `WarpName` from WarpPoints -WARP | LIST | | | Lists current warp points -WARP | Player | WarpName | | Teleports `Player` to `WarpName` -POS | Player | ADD | x=5 y=10 | Teleports player 5 on X axis, 10 on Y axis (up). (No need to use every coordinate (X Y Z)) -POS | Player | SET | x=50 y=0 z=-50 | Sets player position to X:50 Y:0 Z:-50 -POS | Player | GET | | Gets XYZ position of `Player` -EMPTY | Player | ItemTypeNumber / (D, DEL,DELETE) | (D, DEL,DELETE) | Drops all items (all unless specified) from the player's inv. If used with (D, DEL or DELETE), it deletes the items instead of dropping. (The second del part is for if you use an item number) - - -> Player input doesn't need the full name, it will grab the closest matching name containing your entry -*** -## ^These commands work in both server console and text-based remote admin!^ \ No newline at end of file diff --git a/Documentation/Commands/Server/Color.md b/Documentation/Commands/Server/Color.md new file mode 100644 index 0000000..5ed7018 --- /dev/null +++ b/Documentation/Commands/Server/Color.md @@ -0,0 +1,25 @@ + +# Console Colors + +  ATCOLOR     +  ⚠ Buggy     + +
+
+ +## Description + +*Colorizes the console output from this plugin.* + +
+
+ +## Example + +*Turns colorization on.* + +```shell +ATCOLOR true +``` + +
diff --git a/Documentation/Commands/Server/Disable.md b/Documentation/Commands/Server/Disable.md new file mode 100644 index 0000000..4764d12 --- /dev/null +++ b/Documentation/Commands/Server/Disable.md @@ -0,0 +1,21 @@ + +# Disabling + +  ATDISABLE   + +
+
+ +## Description + +*Disables the **AdminToolbox** plugin.* + +
+
+ +## Enabling + +*To re-enable **AdminToolbox**, you
+must first restart your server.* + +
diff --git a/Documentation/Commands/Server/Info.md b/Documentation/Commands/Server/Info.md new file mode 100644 index 0000000..8aab3e4 --- /dev/null +++ b/Documentation/Commands/Server/Info.md @@ -0,0 +1,42 @@ + +# Information + +  S     or     SERVERINFO   + +
+
+ +## Description + +*Displays information about the server.* + +
+
+ +## Information + +- **AdminToolbox Coloring** + +- **Server** + + - **Name** + + - **Port** + + - **IP** + +- **Round** + + - **Duration** + + - **Number** + + - **Locked** + +- **Player** + + - **Count** + + - **Jailed** + +
\ No newline at end of file diff --git a/Documentation/Commands/Server/RoundLock.md b/Documentation/Commands/Server/RoundLock.md deleted file mode 100644 index e69de29..0000000 diff --git a/Documentation/Commands/Server/Serverstats.md b/Documentation/Commands/Server/Serverstats.md deleted file mode 100644 index 591295e..0000000 --- a/Documentation/Commands/Server/Serverstats.md +++ /dev/null @@ -1,13 +0,0 @@ -# ServerStats - -Command to display per-team wins since last restart - -## Command usage - -```SERVERSTATS``` - -List of Aliases for the word `ServerStats` - -* SSTATS -* ROUNDSTATS -* RSTATS diff --git a/Documentation/Commands/Variables.md b/Documentation/Commands/Variables.md deleted file mode 100644 index f994754..0000000 --- a/Documentation/Commands/Variables.md +++ /dev/null @@ -1,12 +0,0 @@ - - - -# Commonly used parameters - -Parameter | Aliases | Description ---: | :--: | :-- -|* | ALL / EVERY | This will target all of the parameter type| -|PLAYER | Nickname SteamID PlayerID IP | Note: Majority of commands are self-targeting when player is not specified - - - diff --git a/Documentation/Commands/Whitelist-System.md b/Documentation/Commands/Whitelist-System.md deleted file mode 100644 index c9d64a8..0000000 --- a/Documentation/Commands/Whitelist-System.md +++ /dev/null @@ -1 +0,0 @@ -## I'm terribly sorry, but this page hasn't been written yet! \ No newline at end of file diff --git a/Documentation/Configuration.md b/Documentation/Configuration.md new file mode 100644 index 0000000..7597137 --- /dev/null +++ b/Documentation/Configuration.md @@ -0,0 +1,213 @@ + + + +# Configuration + +*Optional parameters you can pass.* + +
+ +## Note + +Place all the following config options in your
+server config, not  `config_remoteadmin.txt`. + +
+
+ +## Types & Variables + +Before you configure any setting,
+check the **[Types]** documentation. + +
+
+ +## Server Name + +You can place  `$atversion`  in your server name
+config to display the **AdminToolbox** version. + +
+
+ +## ![Label General] + +[ 
   Version Checking   
 ][General Version]    +Check for new versions of **AdminToolbox**. + +[ 
   Join Information   
 ][General Info]    +Show extended info for joining players. + +[ 
    Server Tracking    
 ][General Tracking]    +Add tracking in the server name. + +[ 
  Colorized Console  
 ][General Color]    +Colorize the console output. + +[ 
          Join Name           
 ][General Name]    +Show joining players names. + +[ 
   Match Statistics   
 ][General Match]    +Display match Statistics. + +[ 
      Enable Plugin      
 ][General Enable]    +Enable this plugin. + +
+
+ +## ![Label Intercom] + +[ 
            Blacklist            
 ][Intercom Blacklist]    +Block players from using the intercom system. + +[ 
  Transmission Message  
 ][Intercom Transmission]    +Message shown when intercom is transmitting. + +[ 
       Restart Message       
 ][Intercom Restart]    +Message shown when intercom is restarting. + +[ 
            Whitelist            
 ][Intercom Whitelist]    +Allow specific roles to use the intercom. + +[ 
         Ready Message         
 ][Intercom Ready]    +Message shown when intercom is ready. + +[ 
        Limited Access        
 ][Intercom Limited]    +Only allow whitelisted players. + +
+
+ +## ![Label Damage] + +[ 
          Tutorial          
 ][Damage Tutorial]    +Choose what type of damage affect players with the `TUTORIAL` role. + +[ 
         After Party         
 ][Damage After Party]    +Adjust the damage that is dealt after the round ends. + +[ 
 LCZ De-Containment 
 ][Damage LCZ]    +Adjust the LCZ De-Containment damage multiplier. + +[ 
           Blocked           
 ][Damage Blocked]    +Disable specific roles from damaging each other. + +[ 
             Global             
 ][Damage Tutorial]    +Adjust the global damage multiplier. + +
+
+ +## ![Label Info] + +[ 
               Join               
 ][Info Join]    +Set if player names should be shown in the server console upon joining. + +
+
+ +## ![Label Logging] + +[ 
     Unified Data     
 ][Logging Unified]    +Combine data from different servers. + +[ 
     Housekeeping     
 ][Logging Housekeeping]    +Remove logs after a duration. + +[ 
  Plugin Location  
 ][Logging Location]    +Plugin folder location. + +[ 
         Commands        
 ][Logging Commands]    +Log command usage. + +[ 
           Kills           
 ][Logging Kills]    +Remove enemy kills. + +[ 
          Damage          
 ][Logging Damage]    +Log player damage. + +[ 
        Teamkills        
 ][Logging Teamkill]    +Log team kills. + +
+
+ +## ![Label Debug] + +[ 
   Friendly Damage   
 ][Debug Friendly]    +Display damage done to friendly players. + +[ 
         Enemy Kills         
 ][Debug Kills]    +Display enemy kills in the server console. + +[ 
      Enemy Damage      
 ][Debug Enemy]    +Display damage done to enemy players. + +[ 
       Special Kills       
 ][Debug Special]    +Display suicides, scp kills & grenade kills. + +[ 
          Team Kills          
 ][Debug Teamkill]    +Disable team kills in the server console. + +[ 
  Damage Detection  
 ][Debug Detected]    +Control what damage is detected. + +
+ + + + +[Types]: Configuration/Types.md + + + + +[Damage After Party]: Configuration/Damage/After%20Party.md +[Damage Tutorial]: Configuration/Damage/Tutorial.md +[Damage Blocked]: Configuration/Damage/Blocked.md +[Damage Global]: Configuration/Damage/Global.md +[Damage LCZ]: Configuration/Damage/LCZ%20De-Containment.md + +[Info Join]: Configuration/Info/Join.md + +[Debug Teamkill]: Configuration/Debug/Teamkill.md +[Debug Detected]: Configuration/Debug/Detected.md +[Debug Friendly]: Configuration/Debug/Friendly.md +[Debug Special]: Configuration/Debug/Special.md +[Debug Kills]: Configuration/Debug/Kills.md +[Debug Enemy]: Configuration/Debug/Enemy.md + +[General Tracking]: Configuration/General/Tracking.md +[General Version]: Configuration/General/Version.md +[General Enable]: Configuration/General/Enable.md +[General Color]: Configuration/General/Color.md +[General Match]: Configuration/General/Match.md +[General Name]: Configuration/General/Joined.md +[General Info]: Configuration/General/Information.md + +[Intercom Transmission]: Configuration/Intercom/Transmission.md +[Intercom Blacklist]: Configuration/Intercom/Blacklist.md +[Intercom Whitelist]: Configuration/Intercom/Whitelist.md +[Intercom Limited]: Configuration/Intercom/Limited.md +[Intercom Restart]: Configuration/Intercom/Restart.md +[Intercom Ready]: Configuration/Intercom/Ready.md + +[Logging Housekeeping]: Configuration/Logging/Housekeeping.md +[Logging Teamkill]: Configuration/Logging/TeamKill.md +[Logging Commands]: Configuration/Logging/Commands.md +[Logging Location]: Configuration/Logging/Location.md +[Logging Unified]: Configuration/Logging/Unified.md +[Logging Damage]: Configuration/Logging/Damage.md +[Logging Kills]: Configuration/Logging/Kills.md + + + + +[Label Intercom]: https://img.shields.io/badge/Intercom-F47D31?style=for-the-badge&logoColor=white&logo=RSS +[Label Logging]: https://img.shields.io/badge/Logging-5C1F87?style=for-the-badge&logoColor=white&logo=AzureArtifacts +[Label General]: https://img.shields.io/badge/General-1A70B8?style=for-the-badge&logoColor=white&logo=Diaspora +[Label Damage]: https://img.shields.io/badge/Damage-C9284D?style=for-the-badge&logoColor=white&logo=ActiGraph +[Label Debug]: https://img.shields.io/badge/Debug-009287?style=for-the-badge&logoColor=white&logo=HubSpot +[Label Info]: https://img.shields.io/badge/Information-666666?style=for-the-badge&logoColor=white&logo=InternetArchive diff --git a/Documentation/Configuration/Damage/After Party.md b/Documentation/Configuration/Damage/After Party.md new file mode 100644 index 0000000..41fd0ee --- /dev/null +++ b/Documentation/Configuration/Damage/After Party.md @@ -0,0 +1,39 @@ + +# After Party Damage + +  admintoolbox_endedRound_damageMultiplier     +  Float  ➞  1   + +
+
+ +## Description + +*Global damage multiplier for after the round ends.* + +
+
+ +## Example + +
+ +### Peace + +*No damage will be dealt after the round ends.* + +```yaml +admintoolbox_endedRound_damageMultiplier : 0 +``` + +
+ +### Chaos + +*Hell on earth breaks loose when the round ends.* + +```yaml +admintoolbox_endedRound_damageMultiplier : 10 +``` + +
\ No newline at end of file diff --git a/Documentation/Configuration/Damage/Blocked.md b/Documentation/Configuration/Damage/Blocked.md new file mode 100644 index 0000000..55b42d8 --- /dev/null +++ b/Documentation/Configuration/Damage/Blocked.md @@ -0,0 +1,43 @@ + +# Blocked Damage + +  admintoolbox_block_role_damage     +  RoleA:RoleB   + +
+
+ +## Description + +*Blocks  `RoleA`  from damaging  `RoleB`.* + +
+
+ +## Example + +
+ +- `Chaos`  ( **8** ) cannot damage  `DBoys`  ( **1** ) + +- `Scientists`  ( **6** ) cannot harm  `MTF` + +- The opposite is not blocked. + +
+ +```yaml +admintoolbox_block_role_damage : 8:1,6:12:13:15 +``` + +
+ +- `Scientists`  ( **6** ) cannot damage anyone + +- `DBoys`  ( **1** ) cannot attack each other + +```yaml +admintoolbox_block_role_damage : 6:0-1-2-3-4-5-6-7-8-9-10-11-12-13-14-15-16-17,1:1 +``` + +
\ No newline at end of file diff --git a/Documentation/Configuration/Damage/Global.md b/Documentation/Configuration/Damage/Global.md new file mode 100644 index 0000000..c2f7777 --- /dev/null +++ b/Documentation/Configuration/Damage/Global.md @@ -0,0 +1,25 @@ + +# Global Damage + +  admintoolbox_round_damageMultiplier     +  Float  ➞  1   + +
+
+ +## Description + +*Global damage multiplier.* + +
+
+ +## Example + +*All damage will be multiplied by  `6.9`.* + +```yaml +admintoolbox_round_damageMultiplier : 6.9 +``` + +
\ No newline at end of file diff --git a/Documentation/Configuration/Damage/LCZ De-Containment.md b/Documentation/Configuration/Damage/LCZ De-Containment.md new file mode 100644 index 0000000..366edea --- /dev/null +++ b/Documentation/Configuration/Damage/LCZ De-Containment.md @@ -0,0 +1,25 @@ + +# LCZ De-Containment Damage + +  admintoolbox_decontamination_damagemultiplier     +  Float  ➞  1   + +
+
+ +## Description + +*LCZ de-containment damage multiplier.* + +
+
+ +## Example + +*The damage will be multiplied by  `4.2`.* + +```yml +admintoolbox_decontamination_damagemultiplier : 4.2 +``` + +
\ No newline at end of file diff --git a/Documentation/Configuration/Damage/Tutorial.md b/Documentation/Configuration/Damage/Tutorial.md new file mode 100644 index 0000000..55e885e --- /dev/null +++ b/Documentation/Configuration/Damage/Tutorial.md @@ -0,0 +1,65 @@ + +# Tutorial Damage + +  admintoolbox_tutorial_dmg_allowed     +  List  ➞  -1   + +
+
+ +## Description + +*Sets what types of damage the  `TUTORIAL`  role can take.* + +
+
+ +## Choices + +*Values you can use.* + +
+ +### None + +*No damage will be taken.* + +```yaml +admintoolbox_tutorial_dmg_allowed : -1 +``` + +
+ +### All + +*Any type of damage will be taken.* + +```yaml +admintoolbox_tutorial_dmg_allowed : all +``` + +```yaml +admintoolbox_tutorial_dmg_allowed : * +``` + +```yaml +admintoolbox_tutorial_dmg_allowed : -2 +``` + +
+ +### Specific + +*Allows damage from*: + +- Poison ( **29** ) + +- Tesla ( **5** ) + +- P99 ( **13** ) + +```yaml +admintoolbox_tutorial_dmg_allowed : 29,13,5 +``` + +
diff --git a/Documentation/Configuration/Debug/Detected.md b/Documentation/Configuration/Debug/Detected.md new file mode 100644 index 0000000..6ed7a21 --- /dev/null +++ b/Documentation/Configuration/Debug/Detected.md @@ -0,0 +1,14 @@ + +# Detected Damage + +  admintoolbox_debug_damagetypes     +  List  ➞  All Human Player Ids   + +
+
+ +## Description + +*Controls what types of damage are detected.* + +
diff --git a/Documentation/Configuration/Debug/Enemy.md b/Documentation/Configuration/Debug/Enemy.md new file mode 100644 index 0000000..597d60b --- /dev/null +++ b/Documentation/Configuration/Debug/Enemy.md @@ -0,0 +1,25 @@ + +# Enemy Damage + +  admintoolbox_debug_player_damage     +  Boolean  ➞  False   + +
+
+ +## Description + +*Displays all damage done to enemies in the server console.* + +
+
+ +## Example + +*Damage to enemies will be logged in the server console.* + +```yaml +admintoolbox_debug_player_damage : true +``` + +
diff --git a/Documentation/Configuration/Debug/Friendly.md b/Documentation/Configuration/Debug/Friendly.md new file mode 100644 index 0000000..b0ed758 --- /dev/null +++ b/Documentation/Configuration/Debug/Friendly.md @@ -0,0 +1,25 @@ + +# Team Damage + +  admintoolbox_debug_friendly_damage     +  Boolean  ➞  False   + +
+
+ +## Description + +*Displays all team damage done in the server console.* + +
+
+ +## Example + +*Friendly fire will be logged in the server console.* + +```yaml +admintoolbox_debug_friendly_damage : true +``` + +
diff --git a/Documentation/Configuration/Debug/Kills.md b/Documentation/Configuration/Debug/Kills.md new file mode 100644 index 0000000..8f1239b --- /dev/null +++ b/Documentation/Configuration/Debug/Kills.md @@ -0,0 +1,25 @@ + +# Enemy Kills + +  admintoolbox_debug_player_kill     +  Boolean  ➞  False   + +
+
+ +## Description + +*Displays all enemy kills in the server console.* + +
+
+ +## Example + +*Enemy kills will be logged in the server console.* + +```yaml +admintoolbox_debug_player_kill : true +``` + +
diff --git a/Documentation/Configuration/Debug/Special.md b/Documentation/Configuration/Debug/Special.md new file mode 100644 index 0000000..19ea0a6 --- /dev/null +++ b/Documentation/Configuration/Debug/Special.md @@ -0,0 +1,31 @@ + +# Special Deaths + +  admintoolbox_debug_scp_and_self_killed     +  Boolean  ➞  False   + +
+
+ +## Description + +*The following deaths will be logged:* + +- **Grenade Kills** + +- **SCP Kills** + +- **Suicides** + +
+
+ +## Example + +*Special deaths will be logged.* + +```yaml +admintoolbox_debug_scp_and_self_killed : true +``` + +
diff --git a/Documentation/Configuration/Debug/Teamkill.md b/Documentation/Configuration/Debug/Teamkill.md new file mode 100644 index 0000000..3a1a7c1 --- /dev/null +++ b/Documentation/Configuration/Debug/Teamkill.md @@ -0,0 +1,25 @@ + +# Teamkills + +  admintoolbox_debug_friendly_kill     +  Boolean  ➞  True   + +
+
+ +## Description + +*Logs team kills in the server console.* + +
+
+ +## Example + +*Team kills will be logged.* + +```yaml +admintoolbox_debug_friendly_kill : true +``` + +
\ No newline at end of file diff --git a/Documentation/Configuration/General/Color.md b/Documentation/Configuration/General/Color.md new file mode 100644 index 0000000..a05da76 --- /dev/null +++ b/Documentation/Configuration/General/Color.md @@ -0,0 +1,26 @@ + +# Console Color + +  admintoolbox_colors     +  Boolean  ➞  False     +  ⚠ Buggy   + +
+
+ +## Description + +*Colorizes the console output from this plugin.* + +
+
+ +## Example + +*Console messages will be colorized.* + +```yaml +admintoolbox_colors : true +``` + +
diff --git a/Documentation/Configuration/General/Enable.md b/Documentation/Configuration/General/Enable.md new file mode 100644 index 0000000..ce7dcdb --- /dev/null +++ b/Documentation/Configuration/General/Enable.md @@ -0,0 +1,25 @@ + +# Enable Plugin + +  admintoolbox_enable     +  Boolean  ➞  True   + +
+
+ +## Description + +*Enables this plugin and allows it to be loaded.* + +
+
+ +## Example + +*This plugin will not be loaded.* + +```yaml +admintoolbox_enable : false +``` + +
diff --git a/Documentation/Configuration/General/Information.md b/Documentation/Configuration/General/Information.md new file mode 100644 index 0000000..6d17139 --- /dev/null +++ b/Documentation/Configuration/General/Information.md @@ -0,0 +1,25 @@ + +# Join Information + +  admintoolbox_player_join_info_extended     +  Boolean  ➞  True   + +
+
+ +## Description + +*Displays more information about joining players.* + +
+
+ +## Example + +*No extra information will be displayed.* + +```yaml +admintoolbox_player_join_info_extended : false +``` + +
diff --git a/Documentation/Configuration/General/Joined.md b/Documentation/Configuration/General/Joined.md new file mode 100644 index 0000000..e008a97 --- /dev/null +++ b/Documentation/Configuration/General/Joined.md @@ -0,0 +1,30 @@ + +# Join Name + +  admintoolbox_player_join_info     +  Boolean  ➞  True   + +
+
+ +## Description + +*Displays a players name upon joining.* + +
+ +*Ignored if  `admintoolbox_player_`
+`join_info_extended`  is enabled.* + +
+
+ +## Example + +*Joining players names will not be shown.* + +```yaml +admintoolbox_player_join_info : false +``` + +
\ No newline at end of file diff --git a/Documentation/Configuration/General/Match.md b/Documentation/Configuration/General/Match.md new file mode 100644 index 0000000..9fbe34a --- /dev/null +++ b/Documentation/Configuration/General/Match.md @@ -0,0 +1,34 @@ + +# Match Statistics + +  admintoolbox_round_info     +  Boolean  ➞  True   + +
+
+ +## Description + +*Displays the statistics at the start & end of a round.* + +
+
+ +## Statistics + +- **Round Duration** + +- **Round Count** + +
+
+ +## Example + +*Joining players names will not be shown.* + +```yaml +admintoolbox_round_info : false +``` + +
\ No newline at end of file diff --git a/Documentation/Configuration/General/Tracking.md b/Documentation/Configuration/General/Tracking.md new file mode 100644 index 0000000..3139784 --- /dev/null +++ b/Documentation/Configuration/General/Tracking.md @@ -0,0 +1,25 @@ + +# Server Tracking + +  admintoolbox_tracking     +  Boolean  ➞  True   + +
+
+ +## Description + +*Add an invisible  `AT:VersionNumber`  in the server name.* + +
+
+ +## Example + +*Won't add anything to the server name.* + +```yaml +admintoolbox_tracking : false +``` + +
\ No newline at end of file diff --git a/Documentation/Configuration/General/Version.md b/Documentation/Configuration/General/Version.md new file mode 100644 index 0000000..adcad72 --- /dev/null +++ b/Documentation/Configuration/General/Version.md @@ -0,0 +1,25 @@ + +# Version Checking + +  atb_disable_networking     +  Boolean  ➞  False   + +
+
+ +## Description + +*Disables checking for the newest version via **GitHub**.* + +
+
+ +## Example + +*Will not search for the newest version of **AdminToolbox**.* + +```yaml +atb_disable_networking : true +``` + +
\ No newline at end of file diff --git a/Documentation/Configuration/Info/Join.md b/Documentation/Configuration/Info/Join.md new file mode 100644 index 0000000..0d5e4f3 --- /dev/null +++ b/Documentation/Configuration/Info/Join.md @@ -0,0 +1,26 @@ + +# Join Information + +  admintoolbox_info_player_join     +  Boolean  ➞  True   + +
+
+ +## Description + +*If enabled, writes a players name into*
+*the server console when they join.* + +
+
+ +## Example + +*No message will be shown when player joins.* + +```yaml +admintoolbox_info_player_join : false +``` + +
diff --git a/Documentation/Configuration/Intercom/Blacklist.md b/Documentation/Configuration/Intercom/Blacklist.md new file mode 100644 index 0000000..fb027da --- /dev/null +++ b/Documentation/Configuration/Intercom/Blacklist.md @@ -0,0 +1,25 @@ + +# Blacklist + +  admintoolbox_intercom_steamid_blacklist     +  SteamID64   + +
+
+ +## Description + +*Blocks all listed **Steam User Ids** from using the intercom.* + +
+
+ +## Example + +*No players will be blocked from the intercom.* + +```yaml +admintoolbox_intercom_steamid_blacklist : +``` + +
diff --git a/Documentation/Configuration/Intercom/Limited.md b/Documentation/Configuration/Intercom/Limited.md new file mode 100644 index 0000000..e5a56ec --- /dev/null +++ b/Documentation/Configuration/Intercom/Limited.md @@ -0,0 +1,25 @@ + +# Limited Intercom + +  admintoolbox_intercomlock     +  Boolean  ➞  False   + +
+
+ +## Description + +*Locks the intercom for non-whitelisted players.* + +
+
+ +## Example + +*Players will not be locked out by the whitelist.* + +```yaml +admintoolbox_intercomlock : false +``` + +
diff --git a/Documentation/Configuration/Intercom/Ready.md b/Documentation/Configuration/Intercom/Ready.md new file mode 100644 index 0000000..8f5f4e8 --- /dev/null +++ b/Documentation/Configuration/Intercom/Ready.md @@ -0,0 +1,25 @@ + +# Ready Message + +  admintoolbox_intercomready_text     +  String   + +
+
+ +## Description + +*Message to display when the intercom is ready to be used.* + +
+
+ +## Example + +*Shows the message  `Hello World`  once the intercom is ready.* + +```yaml +admintoolbox_intercomready_text : Hello World +``` + +
diff --git a/Documentation/Configuration/Intercom/Restart.md b/Documentation/Configuration/Intercom/Restart.md new file mode 100644 index 0000000..89bdb73 --- /dev/null +++ b/Documentation/Configuration/Intercom/Restart.md @@ -0,0 +1,25 @@ + +# Restart Message + +  admintoolbox_intercomrestart_text     +  String   + +
+
+ +## Description + +*Message that will be shown while the intercom is restarting.* + +
+
+ +## Example + +*Shows the message  `Getting Ready~`  while the intercom counts down.* + +```yaml +admintoolbox_intercomrestart_text : Getting Ready~ +``` + +
diff --git a/Documentation/Configuration/Intercom/Transmission.md b/Documentation/Configuration/Intercom/Transmission.md new file mode 100644 index 0000000..66449da --- /dev/null +++ b/Documentation/Configuration/Intercom/Transmission.md @@ -0,0 +1,39 @@ + +# Transmission Message + +  admintoolbox_intercomtransmit_text     +  String   + +
+
+ +## Description + +*Message that will be shown during the transmission.* + +
+
+ +## Examples + +
+ +### Default + +*Shows the games default transmission message.* + +```yaml +admintoolbox_intercomtransmit_text : +``` + +
+ +### Custom + +*Shows  `You are finally awake!`  while transmitting.* + +```yaml +admintoolbox_intercomtransmit_text : You are finally awake! +``` + +
diff --git a/Documentation/Configuration/Intercom/Whitelist.md b/Documentation/Configuration/Intercom/Whitelist.md new file mode 100644 index 0000000..4a13ffd --- /dev/null +++ b/Documentation/Configuration/Intercom/Whitelist.md @@ -0,0 +1,42 @@ + +# Whitelist + +  admintoolbox_intercom_whitelist     +  ServerRole:SpeakTime:CooldownTime   + +
+
+ +## Description + +*Whitelist of server roles with speak limit and cooldown.* + +
+ +### Roles + +The usable roles can be found in
+the  `config_remoteadmin.txt`  file. + +
+ +### Time + +Time is specified in seconds. + +  1     **=̂**     1 Second   + +
+
+ +## Example + +- `Owner`  can talk for  `120 Seconds`  every  `10 Seconds`. + +- `Moderator`  can talk for  `90 Seconds`  every  `20 Seconds`. + +```yaml +admintoolbox_intercom_whitelist : owner:120:10, moderator:90:20 +```` + +
diff --git a/Documentation/Configuration/Logging/Commands.md b/Documentation/Configuration/Logging/Commands.md new file mode 100644 index 0000000..6de1125 --- /dev/null +++ b/Documentation/Configuration/Logging/Commands.md @@ -0,0 +1,25 @@ + +# Command Logging + +  admintoolbox_log_commands     +  Boolean  ➞  False   + +
+
+ +## Description + +*Logs used commands to the log files.* + +
+
+ +## Example + +*No record will of the command usage will be retained.* + +```yaml +admintoolbox_log_commands : false +``` + +
diff --git a/Documentation/Configuration/Logging/Damage.md b/Documentation/Configuration/Logging/Damage.md new file mode 100644 index 0000000..27ad7ae --- /dev/null +++ b/Documentation/Configuration/Logging/Damage.md @@ -0,0 +1,25 @@ + +# Player Damage + +  admintoolbox_log_damage     +  Boolean  ➞  False   + +
+
+ +## Description + +*Logs all player damage.* + +
+
+ +## Example + +*No player damage will be logged.* + +```yaml +admintoolbox_log_damage : false +``` + +
diff --git a/Documentation/Configuration/Logging/Housekeeping.md b/Documentation/Configuration/Logging/Housekeeping.md new file mode 100644 index 0000000..2228dcd --- /dev/null +++ b/Documentation/Configuration/Logging/Housekeeping.md @@ -0,0 +1,46 @@ + +# Housekeeping + +  admintoolbox_logremover_hours_old     +  Integer  ➞  0   + +
+
+ +## Description + +*Removes log files that are older than specified.* + +
+
+ +## Format + +The duration is specified in  `hours`. + +
+
+ +## Examples + +
+ +### Eternity + +*Keep log files forever.* + +```yaml +admintoolbox_logremover_hours_old : 0 +``` + +
+ +### 1 Day + +*Keep log files for 24 hours.* + +```yaml +admintoolbox_logremover_hours_old : 24 +``` + +
diff --git a/Documentation/Configuration/Logging/Kills.md b/Documentation/Configuration/Logging/Kills.md new file mode 100644 index 0000000..62d5a87 --- /dev/null +++ b/Documentation/Configuration/Logging/Kills.md @@ -0,0 +1,25 @@ + +# Enemy Kills + +  admintoolbox_log_kills     +  Boolean  ➞  False   + +
+
+ +## Description + +*Logs enemy kills.* + +
+
+ +## Example + +*Enemy kills will not be logged.* + +```yaml +admintoolbox_log_kills : false +``` + +
diff --git a/Documentation/Configuration/Logging/Location.md b/Documentation/Configuration/Logging/Location.md new file mode 100644 index 0000000..2fc693c --- /dev/null +++ b/Documentation/Configuration/Logging/Location.md @@ -0,0 +1,25 @@ + +# Plugin Folder + +  admintoolbox_folder_path     +  String  ➞  %Appdata%\Roaming\SCP Secret Laboratory\   + +
+
+ +## Description + +*Location of the **AdminToolbox** folder.* + +
+
+ +## Example + +*Sets the **AdminToolbox** location to a custom path.* + +```yaml +admintoolbox_folder_path : C:\Users\DrMiller\SCP-AdminToolbox\ +``` + +
diff --git a/Documentation/Configuration/Logging/TeamKill.md b/Documentation/Configuration/Logging/TeamKill.md new file mode 100644 index 0000000..590052a --- /dev/null +++ b/Documentation/Configuration/Logging/TeamKill.md @@ -0,0 +1,25 @@ + +# Teamkills + +  admintoolbox_log_teamkills     +  Boolean  ➞  False   + +
+
+ +## Description + +*Logs team kills.* + +
+
+ +## Example + +*No team kills will be logged.* + +```yaml +admintoolbox_log_teamkills : false +``` + +
diff --git a/Documentation/Configuration/Logging/Unified.md b/Documentation/Configuration/Logging/Unified.md new file mode 100644 index 0000000..c5fe3a1 --- /dev/null +++ b/Documentation/Configuration/Logging/Unified.md @@ -0,0 +1,25 @@ + +# Unified Data + +  admintoolbox_stats_unified     +  Boolean  ➞  True   + +
+
+ +## Description + +*Keeps data from all servers in one common folder.* + +
+
+ +## Example + +*Every server will have it's own data folder.* + +```yaml +admintoolbox_stats_unified : false +``` + +
diff --git a/Documentation/Configuration/Types.md b/Documentation/Configuration/Types.md new file mode 100644 index 0000000..200215d --- /dev/null +++ b/Documentation/Configuration/Types.md @@ -0,0 +1,105 @@ + +# Types + +*Types and variables you can use in the settings.* + +
+ +## Boolean + +Either  `true`  or  `false`. + +
+
+ +## Integer + +Any whole number / non-decimal. + +`1`  ,  `2`  ,  `69`  ,  `621` + +
+
+ +## Float + +A decimal number. + +`0.9`  ,  `22.2222` + +
+
+ +## List + +A list of items, separated by a comma. + +`1,2,20,9,33` + +
+
+ +## Dictionary + +Key-Value pairs separated by commas. + +`1:2`  ,  `1:2,2:3,40:1` + +
+
+ +## Random + +If a config option has an  `R`  before it, it
+indicates you can use a random value. + +
+ +- A random value is defined by having  `{}`. + +- Items are listed like  `weight%value`. + +- Weight values default to  `1`. + +- Pairs are separated by  `|`. + +
+ +### Example + +```yaml +RandomList : {1%1|2%7|6},3,6,{15%3|2|45%2} +``` + +
+
+ +## SteamID64 + +A steam **[Profile Id]**. + +
+
+ +## Variables + +The following variables can be used in intercom messages: + +- `$playerhp`  |  `$playerhealth` + +- `$playerrole` + +- `$playerteam` + +- `$playerrank` + +- `$playerid` + +- `$player` + +
+ + + + +[Profile Id]: https://steamid.xyz/ \ No newline at end of file diff --git a/Documentation/Installation.md b/Documentation/Installation.md new file mode 100644 index 0000000..1eac171 --- /dev/null +++ b/Documentation/Installation.md @@ -0,0 +1,61 @@ + +# Installation + +*How to install this mod for your server.* + +
+ +## Requirements + +
+ +### ServerMod + +*This is a server side plugin framework with*
+*a bunch of additional configuration options,*
+*fixes, security patches and some optimization.* + +[![Button GitHub]][GitHub]    +[![Button Discord]][Discord] + +
+
+ +## Steps + +
+ +### Manual + +1. Download the latest  `.dll`  **[Release]**. + +2. Navigate to your **SCP:SL** server folder. + +3. Place the file in the  `sm_plugins`  folder. + +
+ +### Automated + +You can simply run the  `AutoUpdate.bat`  script. + +##### Notes + +- Only updates if you have an older version installed. + +- Cannot be used while your server is running. + +
+ + + + +[Release]: https://github.com/Rnen/AdminToolbox/releases/latest +[Discord]: https://discord.gg/8nvmMTr +[GitHub]: https://github.com/ServerMod/Smod2 + + + + +[Button Discord]: https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logoColor=white&logo=Discord +[Button GitHub]: https://img.shields.io/badge/GitHub-171515?style=for-the-badge&logoColor=white&logo=GitHub diff --git a/Documentation/README.md b/Documentation/README.md index fdf161c..a540d4c 100644 --- a/Documentation/README.md +++ b/Documentation/README.md @@ -1,9 +1,50 @@ -# Welcome to the AdminToolbox Documentation! -Pages can be found on the right of the screen + -### Feel free to contribute to this :smile: -> I'm actually really terrible at writing documentation, so any help is greatly appriciated +# Documentation -*** -### Different pages can be found in the subfolders here. \ No newline at end of file +
+ +## [![Label Installation]][Installation] + +*How to add this plugin to your server.* + +
+
+ +## [![Label Configuration]][Configuration] + +*How configure optional parameters for your server.* + +
+
+ +## [![Label Commands]][Commands] + +*How to use the **AdminToolbox** commands.* + +
+
+ +## [![Label Resources]][Resources] + +*Lists of **Ids** and **Types**.* + +
+ + + + +[Resources]: https://github.com/ServerMod/Smod2/wiki/Enum-Lists + +[Configuration]: Configuration.md#Top +[Installation]: Installation.md +[Commands]: Commands.md#Top + + + + +[Label Configuration]: https://img.shields.io/badge/Configuration-1A86FD?style=for-the-badge&logoColor=white&logo=BookStack +[Label Installation]: https://img.shields.io/badge/Installation-A9225C?style=for-the-badge&logoColor=white&logo=DocuSign +[Label Resources]: https://img.shields.io/badge/Resources-66459B?style=for-the-badge&logoColor=white&logo=AzureArtifacts +[Label Commands]: https://img.shields.io/badge/Commands-00B265?style=for-the-badge&logoColor=white&logo=GNUBash diff --git a/Documentation/Resources.md b/Documentation/Resources.md deleted file mode 100644 index 124a2a8..0000000 --- a/Documentation/Resources.md +++ /dev/null @@ -1,13 +0,0 @@ - -# Content: -[Role ID's](https://github.com/ServerMod/Smod2/wiki/Enum-Lists#role) - -[Item ID's](https://github.com/ServerMod/Smod2/wiki/Enum-Lists#itemtype) - -[DamageType ID's](https://github.com/ServerMod/Smod2/wiki/Enum-Lists#damagetype) - -[Team ID's](https://github.com/ServerMod/Smod2/wiki/Enum-Lists#damagetype) - -[Room ID's](https://github.com/ServerMod/Smod2/wiki/Enum-Lists#damagetype) - -[And More Types!](https://github.com/ServerMod/Smod2/wiki/Enum-Lists) diff --git a/Documentation/Server Setup/Configuration-Documentation.md b/Documentation/Server Setup/Configuration-Documentation.md deleted file mode 100644 index 961719c..0000000 --- a/Documentation/Server Setup/Configuration-Documentation.md +++ /dev/null @@ -1,120 +0,0 @@ -# If you do not intend to change the default values, there's no need to include any of theese in your config - ->Crossed out config options are temporarily removed, unless otherwise specified in the description - -*** - -## Variable Types - -- **Boolean:** True or False value -- **Integer:** Any whole number (non-decimal) -- **Float:** A number with decimals (Formatting like "1.5") -- **List:** A list of items separated by a `,` (comma). For example: `list: 1,2,3,4,5` -- **Dictionary:** A dictionary of items separated by ":", and each entry separated by ",", for example: `dictionary: 1:2,2:3,3:4` -- **Seconds:** Time in seconds, usually a value of -1 disables the feature -- **Minutes:** Time in minutes, usually a value of -1 disables the feature -- **R:** If the config option has an R before it, it means that you can use a random value in it. A random value is defined by having "{}", items listed like "weight%value" where if you don't put a weight it defaults to a weight of 1, separated by "|", for example: `rlist: {1%1|2%7|6},3,6,{15%3|2|45%2}` -- **STEAMID64:** Steam Profile number identifier [Find yours here!](https://steamid.xyz/) - -*** - -### General Settings - -Config Option | Value Type | Default Value | Description ---- | :---: | :---: | --- -admintoolbox_enable | Boolean | True | `Enable / Disable` AdminToolbox from loading on server start -admintoolbox_colors | Boolean | False | `Enable/Disable` admintoolbox colors in server console (currently bugged) -atb_disable_networking | Boolean | False | `True` disables all GitHub version checking. -admintoolbox_tracking | Boolean | True | Puts an invisible `AT:VersionNumber` in the server name -admintoolbox_round_info | Boolean | True | Displays round-count and duration on start/end of round -admintoolbox_player_join_info_extended | Boolean | True | Displays extended info about joining player -admintoolbox_player_join_info | Boolean | True | Displays joining player's name upon joining. (This does nothing if `extended` version is true) -*** - -### Damage Settings - -Damage Config Option | Value Type | Default Value | Description ---- | :--- | :--- | ---: -admintoolbox_tutorial_dmg_allowed | List | -1 | What damage types the TUTORIAL role is allowed to take. -1 means no damagetypes allowed, `-2` means all. (Alternatively to -2 you can write `all` or `*`) -admintoolbox_round_damageMultiplier | Float | 1 | Multiplies all damage by this number -admintoolbox_endedRound_damageMultiplier | Float | 1 | Multiplies all damage by this number after round ends. For maximum chaos enter high number (10 or something) To turn off dmg on round end, enter `0`. -admintoolbox_decontamination_damagemultiplier | Float | 1 | Multiplies LCZ decontaimnent damage with the specified number -admintoolbox_block_role_damage | roleX:role1 | | Blocks damage between specified roles. -*** - -```yaml -#Example: Chaos cannot damage Dboys, scientists cannot harm any MTF. (But opposite is fine for both) -admintoolbox_block_role_damage: 8:1,6:12:13:15 -``` - -*** - -### Info Settings - -Config Option | Value Type | Default Value | Description ---- | :---: | :---: | --- -admintoolbox_info_player_join | Boolean | True | Writes Playername in server console when player joins (Currently only works for players joining, not leaving) -*** - -### Intercom Settings - -Intercom Config Option | Value Type | Default Value | Description ---- | :---: | :---: | --- -admintoolbox_intercom_whitelist | ServerRole:SpeakTime:CooldownTime | | Whitelist of server roles (roles from `config_remoteadmin.txt` with specific time settings -admintoolbox_intercom_steamid_blacklist | SteamID64 | | List of people who cannot use the intercom -admintoolbox_intercomlock | Boolean | False | If true locks the intercom for non-whitelisted players -admintoolbox_intercomtransmit_text | String | | What text the screen displays when transmitting (empty results in default game behaviour) -admintoolbox_intercomready_text | String | | What text the screen displays when the intercom is ready to be used -admintoolbox_intercomrestart_text | String | | What text the screen displays when its restarting (counting down) - -Name variables for intercom_transmit config: -`$player` `$playerid` `$playerrole` `$playerteam` `$playerhp` (alternative `$playerhealth`) `$playerrank` -*** - -### Logfile settings - -> File(s) will be created at the path specified in `admintoolbox_folder_path` config (SL Appdata Folder by default) - -Config Option | Value Type | Default Value | Description ---- | :---: | :---: | --- -admintoolbox_log_teamkills | Boolean | False | Writes teamkills to the AT logfile -admintoolbox_log_kills | Boolean | False | Writes non-team kills to the AT logfile -admintoolbox_log_commands | Boolean | False | Writes command usage to the AT logfile -admintoolbox_log_damage | Boolean | False | Writes all player-damage to the AT logfile -admintoolbox_folder_path | String (Path) | %Appdata%\Roaming\SCP Secret Laboratory\ | Where the Admintoolbox folder will be located -admintoolbox_stats_unified | Boolean | True | If true uses one folder for all servers, false creates a folder per server -admintoolbox_logremover_hours_old | Int | 0 | Automaticly removes AT logs older than specified hours of age. 0 means disabled - -*** - -### Debug Settings - -Config Option | Value Type | Default Value | Description ---- | :---: | :---: | --- -admintoolbox_debug_damagetypes | List | All human player damage ID's | What damage types to detect. -admintoolbox_debug_player_damage | Boolean | False | Displays all non-friendly kills in server console. -admintoolbox_debug_friendly_damage | Boolean | False | Displays team damage in server console. -admintoolbox_debug_player_kill | Boolean | False | Displays all non-friendly kills in server console. -admintoolbox_debug_scp_and_self_killed | Boolean | False | Displays suicides, granade kills and SCP kills in server console. -admintoolbox_debug_friendly_kill | Boolean | True | Displays teamkills in server console. -*** - -### *Note that all configs should go in your server config file, not config_remoteadmin.txt - -### Examples - -```yaml -#The example would make scientists (6) not able to damage any class, dboys (1) not able to attack other dboys (1)) -admintoolbox_block_role_damage: 6:0-1-2-3-4-5-6-7-8-9-10-11-12-13-14-15-16-17,1:1 - - -admintoolbox_intercom_whitelist: owner:120:10, moderator:90:20 -``` - ->Find a complete list of DamageID's, RoleID's and more in the [RESOURCES](Resources.md) page! - -*** - -### Place any suggestions/problems in [issues](https://github.com/Rnen/AdminToolbox/issues)! - -# Thanks & Enjoy. \ No newline at end of file diff --git a/Documentation/Server Setup/How-To-Install.md b/Documentation/Server Setup/How-To-Install.md deleted file mode 100644 index 1ebb807..0000000 --- a/Documentation/Server Setup/How-To-Install.md +++ /dev/null @@ -1,22 +0,0 @@ -# ServerMod - (This is required for any plugin) - -ServerMod is a server side plugin framework with a bunch of additional configuration options, bug fixes, security patches and some optimisations built in. - -* SMOD can be found here: [Smod Github](https://github.com/ServerMod/Smod2) -* SMOD Discord: [Invitation Link](https://discord.gg/8nvmMTr) - -*** - -## To install - -1. Grab newest `.dll` file of AdminToolbox: [Latest Release](https://github.com/Rnen/AdminToolbox/releases/latest) -2. Navigate to your **SCP Secret Lab Server** folder. -3. Drag `AdminToolbox.dll` into the `sm_plugins` folder - -## Alternative - -Running the AutoUpdate.bat file will automatically download and replace your current AdminToolbox with the newest version! - -> Note that it does not download if the GitHub version is equal to your current version - -> Note that you cannot use this while the server is running \ No newline at end of file diff --git a/Documentation/Server Setup/Server-Name-Variables.md b/Documentation/Server Setup/Server-Name-Variables.md deleted file mode 100644 index 2590239..0000000 --- a/Documentation/Server Setup/Server-Name-Variables.md +++ /dev/null @@ -1,7 +0,0 @@ -## List of Server Name Variables - -Theese are key-words you can put in your server name config, that will be replaced with a value - -Variable | Description -:--:|:-- -$atversion | Displays the current AdminToolbox version \ No newline at end of file diff --git a/README.md b/README.md index 7f2d420..bc3e2d0 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,8 @@
[![Badge Release]][Releases]    -[![Badge Downloads]][Releases]    [![Badge Commit]][Commit]    +[![Badge Downloads]][Releases]    [![Badge Watchers]][Watchers]
@@ -12,20 +12,20 @@ # Admin Toolbox -*A **SMod** server plugin for **[SCP: Secret Laboratory]**.* +*A **SMod** server plugin for **[SCP:Secret Laboratory]**.*
- ---- +
+
[![Button Installation]][Wiki]    [![Button Issues & Ideas]][Issues]    +[![Button Documentation]][Documentation]    [![Button Development]][Projects] ---- -
+


@@ -111,19 +111,22 @@ server modifications for the game **SCP:Secret Laboratory**. [Issues]: https://GitHub.com/Rnen/AdminToolbox/issues [Commit]: https://GitHub.com/Rnen/AdminToolbox/commit [Wiki]: https://GitHub.com/Rnen/AdminToolbox/wiki -[SCP: Secret Laboratory]: https://store.steampowered.com/app/700330/SCP_Secret_Laboratory/ +[SCP:Secret Laboratory]: https://store.steampowered.com/app/700330/SCP_Secret_Laboratory/ + +[Documentation]: Documentation/#Top -[Badge Downloads]: https://img.shields.io/github/downloads/Rnen/AdminToolbox/total.svg?style=for-the-badge&color=A9225C&logoColor=white&logo=DocuSign -[Badge Watchers]: https://img.shields.io/github/watchers/Rnen/AdminToolbox.svg?style=for-the-badge&label=Watcher&maxAge=2592000&color=73398D&logoColor=white&logo=Git -[Badge Release]: https://img.shields.io/github/v/release/Rnen/AdminToolbox?style=for-the-badge -[Badge Commit]: https://img.shields.io/github/last-commit/Rnen/AdminToolbox?style=for-the-badge&color=258AAF&logoColor=white&logo=GitHub +[Badge Downloads]: https://img.shields.io/github/downloads/Rnen/AdminToolbox/total.svg?style=flat&color=A9225C&logoColor=white&logo=DocuSign +[Badge Watchers]: https://img.shields.io/github/watchers/Rnen/AdminToolbox.svg?style=flat&label=Watcher&color=73398D&logoColor=white&logo=Git&maxAge=2592000 +[Badge Release]: https://img.shields.io/github/v/release/Rnen/AdminToolbox?style=flat&color=569A31&logoColor=white&logo=SCPFoundation +[Badge Commit]: https://img.shields.io/github/last-commit/Rnen/AdminToolbox?style=flat&color=00A8E1&logoColor=white&logo=GitHub [Button Issues & Ideas]: https://img.shields.io/badge/Issues_&_Ideas-00A8E1?style=for-the-badge&logoColor=white&logo=AskUbuntu [Button Installation]: https://img.shields.io/badge/Installation-569A31?style=for-the-badge&logoColor=white&logo=DocuSign -[Button Development]: https://img.shields.io/badge/Projects-66459B?style=for-the-badge&logoColor=white&logo=AzureArtifacts +[Button Documentation]: https://img.shields.io/badge/Documentation-A9225C?style=for-the-badge&logoColor=white&logo=GitBook +[Button Development]: https://img.shields.io/badge/Projects-73398D?style=for-the-badge&logoColor=white&logo=AzureArtifacts