aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMinetest-j45 <55553015+Minetest-j45@users.noreply.github.com>2022-03-13 13:59:22 +0000
committerMinetest-j45 <55553015+Minetest-j45@users.noreply.github.com>2022-03-13 13:59:22 +0000
commitdf0683ec8a5292bef79da4114a21aaf55d0d14d2 (patch)
tree40612b81eda4ef68f000295ce989b638f0a4e76c /README.md
parentbeba626925b9fdd7737987caf0d1bee7e069e2ff (diff)
Apply suggestions
Diffstat (limited to 'README.md')
-rw-r--r--README.md39
1 files changed, 22 insertions, 17 deletions
diff --git a/README.md b/README.md
index 8604576..cb094b9 100644
--- a/README.md
+++ b/README.md
@@ -5,120 +5,125 @@ mt-multiserver-chatcommands provides a useful chat command interface for mt-mult
> `shutdown`
```
-Usage: `shutdown`
Perm: cmd_shutdown
Description: Disconnect all clients and stop the server.
+Usage: `shutdown`
```
> `find`
```
-Usage: `find <name>`
Perm: cmd_find
Description: Check whether a player is connected and report their upstream server if they are.
+Usage: `find <name>`
```
> `addr`
```
-Usage: `addr <name>`
Perm: cmd_addr
Description: Find the network address of a player if they're connected.
+Usage: `addr <name>`
```
> `alert`
```
-Usage: `alert <message>`
Perm: cmd_alert
Description: Send a message to all connected clients regardless of their upstream server.
+Usage: `alert <message>`
```
> `send`
```
-Usage: `send <player <server> <name> | current <server> | all <server>>`
Perm: cmd_send
Description: Send player(s) to a new server. player causes a single player to be redirected, current affects all players that are on your current server and all affects everyone.
+Usage: `send <player <server> <name> | current <server> | all <server>>`
+TelnetUsage: `send <player <server> <name> | all <server>>`
+Example: `send player lobby bob`
```
> `players`
```
-Usage: `players`
Perm: cmd_players
Description: Show the player list of every server.
+Usage: `players`
```
> `reload`
```
-Usage: `reload`
Perm: cmd_reload
Description: Reload the configuration file. You should restart the proxy instead if possible.
+Usage: `reload`
```
> `group`
```
-Usage: `group [name]`
Perm: cmd_group
Description: Display the group of a player. Display your group if no player name is specified.
+Usage: `group [name]`
+TelnetUsage: `group <name>`
```
> `perms`
```
-Usage: `perms [name]`
Perm: cmd_perms
Description: Show the permissions of a player. Show your permissions if no player name is specified.
+Usage: `perms [name]`
+TelnetUsage: `perms <name>`
```
> `gperms`
```
-Usage: `gperms <group>`
Perm: cmd_gperms
Description: Show the permissions of a group.
+Usage: `gperms <group>`
```
> `server`
```
-Usage: `server [server]`
Perm: cmd_server
Description: Display your current upstream server and all other configured servers. If a valid server name is specified, switch to that server.
+Usage: `server [server]`
+TelnetUsage: `server`
```
> `kick`
```
-Usage: `kick <name> [reason]`
Perm: cmd_kick
Description: Disconnect a player with an optional reason.
+Usage: `kick <name> [reason]`
```
> `ban`
```
-Usage: `ban <name>`
Perm: cmd_ban
Description: Ban a player from using the proxy.
+Usage: `ban <name>`
```
> `unban`
```
-Usage: `unban <name | address>`
Perm: cmd_unban
Description: Remove a player from the ban list. Accepts addresses and names.
+Usage: `unban <name | address>`
```
> `uptime`
```
-Usage: `uptime`
Perm: cmd_uptime
Description: Show the uptime of the proxy.
+Usage: `uptime`
```
> `help`
```
-Usage: `help [command]`
Perm: cmd_help
Description: Show help for a command (all commands if unspecified).
+Usage: `help [command]`
```
> `usage`
```
-Usage: `usage [command]`
Perm: cmd_usage
Description: Show the usage string of a command (all commands if unspecified).
+Usage: `usage [command]`
```