diff --git a/Commands.md b/Commands.md new file mode 100644 index 0000000..43b093c --- /dev/null +++ b/Commands.md @@ -0,0 +1,89 @@ +### Commands +|Name |Alias|Description |Requires Target|Syntax |Required Level| +|--------------| -----| --------------------------------------------------------| -----------------| -------------| ---------------| +|prune|pa|demote any trusted clients that have not connected recently (defaults to 30 days)|False|!pa \|Owner| +|quit|q|quit IW4MAdmin|False|!q |Owner| +|rcon|rcon|send rcon command to server|False|!rcon \|Owner| +|ban|b|permanently ban a client from the server|True|!b \ \|SeniorAdmin| +|unban|ub|unban client by client id|True|!ub \ \|SeniorAdmin| +|find|f|find client in database|False|!f \|Administrator| +|killserver|kill|kill the game server|False|!kill |Administrator| +|map|m|change to specified map|False|!m \|Administrator| +|maprotate|mr|cycle to the next map in rotation|False|!mr |Administrator| +|plugins|p|view all loaded plugins|False|!p |Administrator| +|tempban|tb|temporarily ban a client for specified time (defaults to 1 hour)|True|!tb \ \ \|Administrator| +|alias|known|get past aliases and ips of a client|True|!known \|Moderator| +|baninfo|bi|get information about a ban for a client|True|!bi \|Moderator| +|fastrestart|fr|fast restart current map|False|!fr |Moderator| +|flag|fp|flag a suspicious client and announce to admins on join|True|!fp \ \|Moderator| +|kick|k|kick a client by name|True|!k \ \|Moderator| +|list|l|list active clients|False|!l |Moderator| +|mask|hide|hide your presence as a privileged client|False|!hide |Moderator| +|reports|reps|get or clear recent reports|False|!reps \|Moderator| +|say|s|broadcast message to all clients|False|!s \|Moderator| +|setlevel|sl|set client to specified privilege level|True|!sl \ \|Moderator| +|setpassword|sp|set your authentication password|False|!sp \|Moderator| +|unflag|uf|Remove flag for client|True|!uf \|Moderator| +|uptime|up|get current application running time|False|!up |Moderator| +|usage|us|get application memory usage|False|!us |Moderator| +|warn|w|warn client for infringing rules|True|!w \ \|Trusted| +|warnclear|wc|remove all warnings for a client|True|!wc \|Trusted| +|admins|a|list currently connected privileged clients|False|!a |User| +|getexternalip|ip|view your external IP address|False|!ip |User| +|help|h|list all available commands|False|!h \|User| +|nextmap|nm|view next map in rotation|False|!nm |User| +|owner|iamgod|claim ownership of the server|False|!iamgod |User| +|ping|pi|get client's latency|False|!pi \|User| +|privatemessage|pm|send message to other client|True|!pm \ \|User| +|report|rep|report a client for suspicious behavior|True|!rep \ \|User| +|rules|r|list server rules|False|!r |User| +|setgravatar|sg|set gravatar for webfront profile|False|!sg \|User| +|whoami|who|give information about yourself|False|!who |User| + + +_These commands include all shipped plugin commands._ + +--- + +#### Player Identification +All players are identified 5 separate ways +1. `npID/GUID/XUID` - The ID corresponding to the player's hardware or forum account +2. `IP` - The player's IP Address +3. `Client ID` - The internal reference to a player, generated by **IW4MAdmin** +4. `Name` - The visible player name as it appears in game +5. `Client Number` - The slot the client occupies on a server. (The number ranges between 0 and the max number of clients allowed on the server) + +For most commands players are identified by their `Name` +However, if they are currently offline, or their name contains un-typable characters, their `Client ID` must be used + +The `Client ID` is specified by prefixing a player's reference number with `@`. +For example, `@123` would reference the player with a `Client ID` of 123. + +**All commands that require a `target` look at the `first argument` for a form of player identification** + +--- + +#### Additional Command Examples +`setlevel` +- _shortcut_ - `sl` +- _Parameter 1_ - Player to modify level of +- _Parameter 2_ - Level to set the player to ```[ User, Trusted, Moderator, Administrator, SeniorAdmin, Owner ]``` +- _Example_ - `!setlevel Player1 SeniorAdmin`, `!sl @123 Moderator` +- **NOTE** - An `owner` cannot set another player's level to `owner` unless the configuration option is enabled during setup + +`ban` +- _Shortcut_ - `b` +- _Parameter 1_ - Player to ban +- _Parameter 2_ - Reason for ban +- _Example_ - `!ban Player1 caught cheating`, `!b @123 GUID Spoofing` + +`tempban` +- _Shortcut_ - `tb` +- _Parameter 1_ - Player to ban +- _Parameter 2_ - Ban length (minutes|hours|days|weeks|years) +- _Parameter 3_ - Reason for ban +- _Example_ - `!tempban Player1 3w racism`, `!tb @123 8h Abusive behaivor` + +`reports` +- _Shortcut_ - `reps` +- _Optional Parameter 1_ - `clear` (erases reports for current server) \ No newline at end of file