From 6b42901f8b5335eede61f97f99eb8513a54e3c3e Mon Sep 17 00:00:00 2001 From: William Date: Wed, 25 Oct 2023 16:59:38 +0100 Subject: [PATCH] docs: Improve command docs layout --- docs/Commands.md | 526 ++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 426 insertions(+), 100 deletions(-) diff --git a/docs/Commands.md b/docs/Commands.md index 7591430c5..16dc2f85c 100644 --- a/docs/Commands.md +++ b/docs/Commands.md @@ -3,40 +3,428 @@ HuskHomes provides a range of commands for you to use. This page will detail the ## Commands & Permissions Table > **Command Conflicts:** If you have multiple plugins providing similar commands, you may need to [create aliases](command-conflicts) to ensure HuskHomes' commands take priority. -This is a table of HuskHomes' commands and their required permission nodes. Additional permissions provided by the plugin to control other variables are detailed further below! - -| Command | Description | Base Permission† | Default‡ | -|-----------------------------------------------------------------|-----------------------------------------------------|-------------------------------|:----------------:| -| `/home ` | Teleport to a home | `huskhomes.command.home` | ✅ | -| `/homelist [page]` | Get a list of your homes | `huskhomes.command.homelist` | ✅ | -| `/sethome ` | Set a new home with given name | `huskhomes.command.sethome` | ✅ | -| `/delhome ` | Delete a home you previously set | `huskhomes.command.delhome` | ✅ | -| `/edithome [rename/description/relocate/privacy] [args]` | Edit one of your homes | `huskhomes.command.edithome` | ✅ | -| `/phome []` | Teleport to a public home | `huskhomes.command.phome` | ✅ | -| `/phomelist [page]` | View the list of public homes | `huskhomes.command.phomelist` | ✅ | -| `/warp ` | Teleport to a warp | `huskhomes.command.warp` | ✅ | -| `/warplist [page]` | View the list of warps | `huskhomes.command.warplist` | ✅ | -| `/setwarp ` | Set a new warp with given name | `huskhomes.command.setwarp` | ❌ | -| `/delwarp ` | Delete a warp | `huskhomes.command.delwarp` | ❌ | -| `/editwarp [rename/description/relocate] [args]` | Edit a warp | `huskhomes.command.editwarp` | ❌ | -| `/tp [destination]` | Teleport to another player or location | `huskhomes.command.tp` | ❌ | -| `/tphere ` | Teleport another player to you | `huskhomes.command.tphere` | ❌ | -| `/tpa ` | Request to teleport to another player | `huskhomes.command.tpa` | ✅ | -| `/tpahere ` | Request another player to teleport to you | `huskhomes.command.tpahere` | ✅ | -| `/tpaccept [player]` | Accept a teleport request | `huskhomes.command.tpaccept` | ✅ | -| `/tpdecline [player]` | Decline a teleport request | `huskhomes.command.tpdecline` | ✅ | -| `/rtp [player] [world]` | Teleport randomly into the wild | `huskhomes.command.rtp` | ✅ | -| `/tpignore` | Ignore incoming teleport requests | `huskhomes.command.tpignore` | ✅ | -| `/tpoffline ` | Teleport to where a player was last online | `huskhomes.command.tpoffline` | ❌ | -| `/tpall` | Teleport everyone to your position | `huskhomes.command.tpall` | ❌ | -| `/tpaall` | Request that everyone teleports to you | `huskhomes.command.tpaall` | ❌ | -| `/spawn` | Teleport to spawn | `huskhomes.command.spawn` | ✅ | -| `/setspawn` | Set the spawn position | `huskhomes.command.setspawn` | ❌ | -| `/back` | Return to your previous position, or where you died | `huskhomes.command.back` | ✅ | -| `/huskhomes [about/help/reload/import/delete/update]` | View plugin information & reload configs | `huskhomes.command.huskhomes` | ✅ | - -* † **Base Permission** — Required permission for basic command execution; some commands require additional permissions for certain functions ([See below…](#other-permissions)) -* ‡ **Default** — ✅ = Accessible by all players by default — ❌ = Accessible only by server operators by default. + + + + + + + + +
Key
✅Accessible by all players by default
❌Accessible only by server operators by default
+ +This is a table of HuskHomes commands, how to use them, and their required permission nodes. Additional permissions for bypassing teleport warmup and economy checks are detailed below. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CommandDescriptionPermissionDefault
Home commands
/home/home [name]Teleport to one of your homeshuskhomes.command.home✅
/home [<owner_name.home_name>]Teleport to another user's homehuskhomes.command.home.other❌
/homelist/homelist [page]View a list of your homeshuskhomes.command.homelist✅
/homelist <owner_name> [page]View a list of another user's homeshuskhomes.command.homelist.other❌
/sethome/sethome [name]Set a new home with a namehuskhomes.command.sethome✅
/delhome/delhome [name]Delete a home you previously sethuskhomes.command.delhome✅
/delhome all [confirm]Delete all of your homes
/delhome <owner_name.home_name>Delete the home of another userhuskhomes.command.delhome.other❌
/edithome/edithome <name>View and edit information about a homehuskhomes.command.edithome✅
/edithome <name> rename <new_name>Rename a homehuskhomes.command.edithome.rename✅
/edithome <name> description <text>Set a home's descriptionhuskhomes.command.edithome.description✅
/edithome <name> relocateMove a home to your current positionhuskhomes.command.edithome.relocate✅
/edithome <name> privacy [public|private]Set a home's privacy (make it public or private)huskhomes.command.edithome.privacy✅
/edithome <owner_name.home_name> [args]View and edit another user's homehuskhomes.command.edithome.other❌
/phome/phome [<owner_name.home_name>]Teleport to a public homehuskhomes.command.phome✅
/phomelist/phomelist [page]View the list of public homeshuskhomes.command.phomelist✅
Warp commands
/warp/warp [name]Teleport to a warphuskhomes.command.warp†✅
/warp <name> <teleporter_name>Teleport another online user to a warphuskhomes.command.warp.other†❌
/warplist/warplist [page]View the list of warpshuskhomes.command.warplist✅
/setwarp/setwarp <name>Set a new warp with a namehuskhomes.command.setwarp❌
/delwarp/delwarp <name>Delete a warphuskhomes.command.delwarp❌
/editwarp/editwarp <name>View and edit information about a warphuskhomes.command.editwarp❌
/editwarp <name> rename <new_name>Rename a warphuskhomes.command.editwarp.rename❌
/editwarp <name> description <text>Set a warp's descriptionhuskhomes.command.editwarp.description❌
/editwarp <name> relocateMove a warp to your current positionhuskhomes.command.editwarp.relocate❌
Spawn commands
/spawn/spawnTeleport to the spawn positionhuskhomes.command.spawn✅
/spawn [teleporter_name]Teleport another online user to the spawn positionhuskhomes.command.spawn.other❌
/setspawnSet the spawn position to your current locationhuskhomes.command.setspawn❌
Teleport commands
/tp/tp <target_name>Teleport to an online userhuskhomes.command.tp❌
/tp <teleporter_name> <target_name>Teleport an online user to another online userhuskhomes.command.tp.other❌
/tp <(x) (y) (z) [yaw] [pitch] [world_name] [server_name]>Teleport to a set of coordinateshuskhomes.command.tp.coordinates❌
/tp <teleporter_name> <coordinates>Teleport an online user to a set of coordinateshuskhomes.command.tp.other
huskhomes.command.tp.coordinates		❌
/tphere/tphere <username>Teleport an online user to your positionhuskhomes.command.tphere❌
/tpoffline/tpoffline <username>Teleport to where a user last logged outhuskhomes.command.tpoffline❌
/tpallTeleport everyone to your positionhuskhomes.command.tpall❌
Teleport request commands
/tpa/tpa <username>Send a request to teleport to another online userhuskhomes.command.tpa✅
/tpahere/tpahere <username>Send a request asking another online user to teleport to youhuskhomes.command.tpahere✅
/tpaallRequest that everyone teleports to youhuskhomes.command.tpaall❌
/tpaccept/tpacceptAccept the last teleport request you receivedhuskhomes.command.tpaccept✅
/tpaccept [username]Accept a teleport request from a specific user
/tpdecline/tpdeclineDecline the last teleport request you receivedhuskhomes.command.tpdecline✅
/tpdecline [username]Decline a teleport request from a specific user
/tpignoreToggle whether to ignore incoming teleport requestshuskhomes.command.tpignore✅
Random teleport command
/rtp/rtpTeleport randomly into the wildhuskhomes.command.rtp✅
/rtp <world>Teleport randomly in a specific worldhuskhomes.command.rtp.world❌
/rtp <world> <player>Teleport another user randomly into the wildhuskhomes.command.rtp.other❌
Back teleport command
/backTeleport to your last position (see below)huskhomes.command.back✅
Teleport back to where you last teleported fromhuskhomes.command.back.previous✅
Teleport back to where you last diedhuskhomes.command.back.death‡✅
Plugin management command
/huskhomes/huskhomesUse plugin management commandshuskhomes.command.huskhomes✅
/huskhomes aboutView the plugin about menuhuskhomes.command.huskhomes.about✅
/huskhomes help [page]View the list of enabled plugin commandshuskhomes.command.huskhomes.help✅
/huskhomes updateCheck for plugin updateshuskhomes.command.huskhomes.update❌
/huskhomes reloadReload the plugin locales and config filehuskhomes.command.huskhomes.reload❌
/huskhomes importImport data from another pluginhuskhomes.command.huskhomes.import❌
/huskhomes delete player <username> [confirm]Delete player data from the system databasehuskhomes.command.huskhomes.delete❌
/huskhomes delete homes <world_name> [server_name] [confirm]Delete all homes on a specific world and/or server
/huskhomes delete warps <world_name> [server_name] [confirm]Delete all warps on a specific world and/or server
+ +### Notes +† — If [[Permission Restricted Warps]] are in use, `/warp` also requires the applicable `huskhomes.command.warp.(warp_name)` permission node. + +‡ — Requires `return_by_death` to be enabled in [`config.yml`](config-files). ### Command Aliases The following commands have aliases that can also be used for convenience: @@ -51,9 +439,9 @@ The following commands have aliases that can also be used for convenience: | `/tpaccept` | `/tpyes` | | `/tpdecline` | `/tpno`, `/tpdeny` | -## Disabling Commands +## Disabling commands -If you'd like to disable a command, add it to the `disabled_commands` section of your config file as detailed below. Note that on servers running Paper for versions earlier than Minecraft 1.19.4, or servers just running plain Spigot instead of Paper (not recommended—please upgrade to Paper!), disabled commands will still be _registered_ but a disabled command message will appear. On servers running Paper for Minecraft 1.19.4+, HuskHomes will be registered as a Paper Plugin (and will appear as such in the `/plugins` menu) and disabled commands will not be registered at all. +If you'd like to disable a command, add it to the `disabled_commands` section of your config file as detailed below and the command will not be registered.
Disabling a command in config.yml @@ -65,7 +453,7 @@ disabled_commands: [ '/rtp' ]
-## Home Limits +## Home limits You can modify the maximum number of homes, the allotment of free homes and the number of public homes a user can set through permission nodes. * `huskhomes.max_homes.` — Determines the max number of homes a user can set @@ -78,38 +466,7 @@ If users have multiple permission nodes (i.e. from being in multiple permission Note that these permission-set values override the values set in the plugin config (`max_homes`, `max_public_homes` under `general` and `free_homes` under `economy`). -## Other Permissions - -
-Return to last position or death with /back - -These permissions control what the user can do with the back command, including the ability to return to their last position or to where they died. - -| Command | Description | Permission | Default | -|----------------------------|--------------------------------------------------------|-----------------------------------|:-------:| -| `/back` (after respawning) | Use /back to return to where you died† | `huskhomes.command.back.death` | ✅ | -| `/back` | Use /back to return to your previous teleport position | `huskhomes.command.back.previous` | ✅ | - -†Note that return by death must be enabled in the plugin [[config files]] for this to work. -
- -
-Home privacy - -These permissions allow you to make a home public/private (toggling its privacy). There are also permissions that let you use, edit and delete homes that have not been set publicly. - -| Command | Description | Permission | Default | -|-------------------------------------------------------------------------------------|----------------------------------------------|--------------------------------------|:-------:| -| `/edithome privacy [public/private]` | Modify the privacy of a home | `huskhomes.command.edithome.privacy` | ❌ | -| `/homelist [page]` | View a list of a user's homes | `huskhomes.command.home.other` | ❌ | -| `/home [.]` | Teleport to a user's home, public or private | `huskhomes.command.home.other` | ❌ | -| `/edithome [.] [rename/description/relocate/privacy] [args]` | Edit a user's home | `huskhomes.command.edithome.other` | ❌ | -| `/delhome [.]` | Delete a user's home | `huskhomes.command.delhome.other` | ❌ | -
- - -
-Bypass teleport warmup, cooldowns & economy checks +## Bypass permission nodes These permissions let you bypass teleportation warmup checks, cooldown, and economy checks @@ -120,34 +477,3 @@ These permissions let you bypass teleportation warmup checks, cooldown, and econ | Bypass [economy checks](economy-hook) | `huskhomes.bypass_economy_checks` | Not set | †This is not effective when the teleport warmup time is set to `<= 0` in the config file. -
- -
-Additional teleportation permissions - -These permissions allow you to use /tp and /rtp to teleport other players remotely, teleport to co-ordinates, and randomly teleport to other worlds. - -| Command | Description | Permission | Default | -|---------------------------------------------|----------------------------------------|------------------------------------|:-------:| -| `/tp [player] [target] ` | Teleport another player | `huskhomes.command.tp.other` | ❌ | -| `/tp [player] [world] [server]` | Teleport to a set of coordinates. | `huskhomes.command.tp.coordinates` | ❌ | -| `/rtp [player] [world]` | Randomly teleport another player. | `huskhomes.command.rtp.other` | ❌ | -| `/rtp [player] [world]` | Randomly teleport in a specific world. | `huskhomes.command.rtp.world` | ❌ | -| `/spawn [player]` | Teleport another player to spawn. | `huskhomes.command.spawn.other` | ❌ | -| `/warp [name] [player]` | Teleport another player to a warp. | `huskhomes.command.warp.other` | ❌ | -
- -
-/huskhomes command arguments - -These permissions control what arguments of the /huskhomes command a user may use. - -| Command | Description | Permission | Default | -|-------------------------------------------------|----------------------------------------------------------|--------------------------------------|:-------:| -| `/huskhomes help [page]` | View a list of HuskHomes commands | `huskhomes.command.huskhomes.help` | ✅ | -| `/huskhomes [about]` | View the plugin about menu | `huskhomes.command.huskhomes.about` | ✅ | -| `/huskhomes reload` | Reload the plugin config and message files | `huskhomes.command.huskhomes.reload` | ❌ | -| `/huskhomes import [list/start]` | Import data from other plugins/mods | `huskhomes.command.huskhomes.import` | ❌ | -| `/huskhomes delete [player/homes/warps] [args]` | Perform bulk actions on homes/warps & delete player data | `huskhomes.command.huskhomes.delete` | ❌ | -| `/huskhomes update` | Check for updates | `huskhomes.command.huskhomes.update` | ❌ | -
\ No newline at end of file