aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 13 insertions, 14 deletions
diff --git a/README.md b/README.md
index ed0efc0..f653589 100644
--- a/README.md
+++ b/README.md
@@ -1,22 +1,21 @@
# LeaveCmd
-Universal leave command for spigot 1.19
+Universal leave command for spigot 1.16+
Instead of players needing to remember /hg leave or /bw leave, they can just use /leave.
The plugin decides what command to use based on the world the player is in.
-## Commands:
-- /leave
-- /leavecmd reload
+### Commands / Permissions
-## Permissions:
-- leaveCmd.leave
-- leaveCmd.admin
+| Command | Description | Permission |
+|--------------------|------------------------|-------------------|
+| `/leave` | Leave the current game | `leaveCmd.leave` |
+| `/leavecmd reload` | Reload the config | `leavecmd.relaod` |
-## Config:
- commands:
- //ex: "command"
- //hg: "hungergames leave"
- worlds:
- //world: ex
- //arena: hg
+### Configuration
+`/leave` will match against the first key that is a substring of the wold name.
+
+```yaml
+commands:
+ "HG-": "hg leave"
+```