Skip to content
This repository has been archived by the owner on Feb 1, 2024. It is now read-only.

Commit

Permalink
Moving the wiki stuff over to a folder (#126)
Browse files Browse the repository at this point in the history
* Moving the wiki stuff over to a Docs folder
  • Loading branch information
Rnen authored Jul 3, 2022
1 parent bb755f2 commit ce9b2ed
Show file tree
Hide file tree
Showing 16 changed files with 463 additions and 0 deletions.
33 changes: 33 additions & 0 deletions Documentation/Commands/Player/AtBan.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# 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
33 changes: 33 additions & 0 deletions Documentation/Commands/Player/Breakdoors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# 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
31 changes: 31 additions & 0 deletions Documentation/Commands/Player/Command.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# 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
37 changes: 37 additions & 0 deletions Documentation/Commands/Player/Empty.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Empty

Empties the inventory of the spesified player. Optionally deletes the items completely.

## Command usage

* EMPTY [PLAYER][player] <ITEM-ID/DELETE> <DELETE>

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) | <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
42 changes: 42 additions & 0 deletions Documentation/Commands/Player/GhostMode.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# 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
37 changes: 37 additions & 0 deletions Documentation/Commands/Player/LockDoors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# 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
53 changes: 53 additions & 0 deletions Documentation/Commands/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
### 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!^
Empty file.
13 changes: 13 additions & 0 deletions Documentation/Commands/Server/Serverstats.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# ServerStats

Command to display per-team wins since last restart

## Command usage

```SERVERSTATS```

List of Aliases for the word `ServerStats`

* SSTATS
* ROUNDSTATS
* RSTATS
12 changes: 12 additions & 0 deletions Documentation/Commands/Variables.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@



# 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



1 change: 1 addition & 0 deletions Documentation/Commands/Whitelist-System.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
## I'm terribly sorry, but this page hasn't been written yet!
9 changes: 9 additions & 0 deletions Documentation/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# 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
***
### Different pages can be found in the subfolders here.
13 changes: 13 additions & 0 deletions Documentation/Resources.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@

# 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)
Loading

0 comments on commit ce9b2ed

Please sign in to comment.