Updated commands.yml (markdown)

NotMyFault 2020-02-16 17:15:31 +01:00
parent 5a2eba9c64
commit a214545c45
1 changed files with 552 additions and 3 deletions

@ -1,10 +1,111 @@
## This guide is for PlotSquared versions <= 1.12.2 and 1.13+
Located in: `PlotSquared/config/commands.yml`
## Located in: `/plugins/PlotSquared/config/commands.yml`
The commands.yml offers configuration for each command (aliases, description and usage messages).
The commands.yml file offers configuration for each command (aliases, description and usage messages).
Example:
```YML
plot:
aliases:
- plot
- plots
- p
- plotsquared
- plot2
- p2
- ps
- '2'
- plotme
- plotz
- ap
usage: ''
description: ''
confirmation: false
buy:
aliases:
- buy
usage: /plot buy
description: Buy the plot you are standing on
confirmation: false
save:
aliases:
- save
- backup
usage: ''
description: Save your plot
confirmation: false
load:
aliases:
- load
- restore
usage: /plot load
description: Load your plot
confirmation: false
confirm:
aliases:
- confirm
usage: ''
description: Confirm an action
confirmation: false
template:
aliases:
- template
usage: /plot template [import|export] <world> <template>
description: Create or use a world template
confirmation: false
download:
aliases:
- download
- dl
usage: /plot download [schematic|world]
description: Download your plot
confirmation: false
setup:
aliases:
- setup
- create
usage: /plot setup
description: Setup wizard for plot worlds
confirmation: false
area:
aliases:
- area
- world
usage: /plot area <create|info|list|tp|regen>
description: Create a new PlotArea
confirmation: true
debugsavetest:
aliases:
- debugsavetest
usage: /plot debugsavetest
description: This command will force the recreation of all plots in the DB
confirmation: false
debugloadtest:
aliases:
- debugloadtest
usage: /plot debugloadtest
description: This debug command will force the reload of all plots in the DB
confirmation: false
createroadschematic:
aliases:
- createroadschematic
- crs
usage: /plot createroadschematic
description: Add a road schematic to your world using the roads around your current
plot
confirmation: false
debugallowunsafe:
aliases:
- debugallowunsafe
usage: /plot debugallowunsafe
description: Allow unsafe actions until toggled off
confirmation: false
regenallroads:
aliases:
- regenallroads
- rgar
usage: /plot regenallroads <world> [height]
description: Regenerate all roads in the map using the set road schematic
confirmation: false
claim:
aliases:
- claim
@ -12,4 +113,452 @@ claim:
usage: /plot claim
description: Claim the current plot you're standing on
confirmation: false
auto:
aliases:
- auto
- a
usage: /plot auto [length,width]
description: Claim the nearest plot
confirmation: false
visit:
aliases:
- visit
- v
- tp
- teleport
- goto
- home
- h
- warp
usage: /plot visit [<player>|<alias>|<world>|<id>] [#]
description: Visit someones plot
confirmation: false
set:
aliases:
- set
- s
usage: /plot set <biome|alias|home|flag> <value...>
description: Set a plot value
confirmation: false
clear:
aliases:
- clear
- reset
usage: /plot clear
description: Clear the plot you stand on
confirmation: true
delete:
aliases:
- delete
- dispose
- del
- unclaim
usage: /plot delete
description: Delete the plot you stand on
confirmation: true
trust:
aliases:
- trust
- t
usage: /plot trust <player|*>
description: Allow a user to build in a plot and use WorldEdit while the plot owner
is offline.
confirmation: false
add:
aliases:
- add
usage: /plot add <player|*>
description: Allow a user to build in a plot while the plot owner is online.
confirmation: false
leave:
aliases:
- leave
usage: /plot leave
description: Removes self from being trusted or a member of the plot
confirmation: false
deny:
aliases:
- deny
- d
- ban
usage: /plot deny <player|*>
description: Deny a user from entering a plot
confirmation: false
remove:
aliases:
- remove
- r
- untrust
- ut
- undeny
- unban
- ud
usage: /plot remove <player|*>
description: Remove a player from a plot
confirmation: false
info:
aliases:
- info
- i
usage: /plot info <id> [-f, to force info]
description: Display plot info
confirmation: false
near:
aliases:
- near
- n
usage: /plot near
description: Display nearby players
confirmation: false
list:
aliases:
- list
- l
- find
- search
usage: /plot list <forsale|mine|shared|world|top|all|unowned|unknown|player|world|done|fuzzy
<search...>> [#]
description: List plots
confirmation: false
debug:
aliases:
- debug
usage: /plot debug [msg]
description: Show debug information
confirmation: false
schematic:
aliases:
- schematic
- sch
- schem
usage: /plot schematic <save|saveall|paste>
description: Schematic command
confirmation: false
plugin:
aliases:
- plugin
- version
usage: /plot plugin
description: Show plugin information
confirmation: false
purge:
aliases:
- purge
usage: /plot purge world:<world> area:<area> id:<id> owner:<owner> shared:<shared>
unknown:[true|false]
description: Purge all plots for a world
confirmation: true
reload:
aliases:
- reload
- rl
usage: /plot reload
description: Reload translations and world settings
confirmation: false
relight:
aliases:
- relight
usage: /plot relight
description: Relight your plot
confirmation: false
merge:
aliases:
- merge
- m
usage: /plot merge <all|n|e|s|w> [removeroads]
description: Merge the plot you are standing on with another plot
confirmation: true
debugpaste:
aliases:
- debugpaste
- dp
usage: /plot debugpaste
description: Upload settings.yml, worlds.yml, PlotSquared.use_THIS.yml your latest.log
and Multiverse's worlds.yml (if being used) to https://athion.net/ISPaster/paste
confirmation: true
unlink:
aliases:
- unlink
- u
- unmerge
usage: /plot unlink [createroads]
description: Unlink a mega-plot
confirmation: true
kick:
aliases:
- kick
- k
usage: /plot kick <player|*>
description: Kick a player from your plot
confirmation: false
debugclaimtest:
aliases:
- debugclaimtest
usage: ''
description: If you accidentally delete your database, this command will attempt
to restore all plots based on the data from plot signs. Execution time may vary
confirmation: false
inbox:
aliases:
- inbox
usage: /plot inbox [inbox] [delete <index>|clear|page]
description: Review the comments for a plot
confirmation: false
comment:
aliases:
- comment
- msg
usage: ''
description: Comment on a plot
confirmation: false
database:
aliases:
- database
- convert
usage: /plot database [area] <sqlite|mysql|import>
description: Convert/Backup Storage
confirmation: false
swap:
aliases:
- swap
- switch
usage: /plot swap <X;Z>
description: Swap two plots
confirmation: false
music:
aliases:
- music
usage: /plot music
description: Play music in your plot
confirmation: false
debugroadregen:
aliases:
- debugroadregen
usage: /plot debugroadregen <plot|region [height]>
description: Regenerate roads in the plot or region the user is, based on the road
schematic
confirmation: false
debugexec:
aliases:
- debugexec
- exec
- $
usage: ''
description: Mutli-purpose debug command
confirmation: false
setflag:
aliases:
- setflag
- f
- flag
- setflag
usage: /plot flag <set|remove|add|list|info> <flag> <value>
description: Set plot flags
confirmation: false
target:
aliases:
- target
usage: /plot target <<plot>|nearest>
description: Target a plot with your compass
confirmation: false
debugfixflags:
aliases:
- debugfixflags
usage: /plot debugfixflags <world>
description: Attempt to fix all flags for a world
confirmation: false
move:
aliases:
- move
usage: /plot move <X;Z>
description: Move a plot
confirmation: false
condense:
aliases:
- condense
usage: /plot condense <area> <start|stop|info> [radius]
description: Condense a plotworld
confirmation: false
copy:
aliases:
- copy
- copypaste
usage: /plot copy <X;Z>
description: Copy a plot
confirmation: false
chat:
aliases:
- chat
usage: /plot chat [on|off]
description: Toggle plot chat on or off
confirmation: false
trim:
aliases:
- trim
usage: /plot trim <world> [regenerate]
description: Delete unmodified portions of your plotworld
confirmation: false
done:
aliases:
- done
- submit
usage: ''
description: Mark a plot as done
confirmation: false
continue:
aliases:
- continue
usage: ''
description: Continue a plot that was previously marked as done
confirmation: false
middle:
aliases:
- middle
- center
- centre
usage: /plot middle
description: Teleports you to the center of the plot
confirmation: false
grant:
aliases:
- grant
usage: /plot grant <check|add> [player]
description: ''
confirmation: false
setowner:
aliases:
- setowner
- owner
- so
- seto
usage: /plot setowner <player>
description: Set the plot owner
confirmation: true
setdescription:
aliases:
- setdescription
- desc
- setdesc
- setd
- description
usage: /plot desc <description>
description: Set the plot description
confirmation: false
setbiome:
aliases:
- setbiome
- biome
- sb
- setb
- b
usage: /plot biome [biome]
description: Set the plot biome
confirmation: false
setalias:
aliases:
- setalias
- alias
- sa
- name
- rename
- setname
- seta
- nameplot
usage: /plot alias <set|remove> <alias>
description: Set the plot name
confirmation: false
sethome:
aliases:
- sethome
- sh
- seth
usage: /plot sethome [none]
description: Set the plot home to your current position
confirmation: false
cluster:
aliases:
- cluster
- clusters
usage: ''
description: Manage a plot cluster
confirmation: false
debugimportworlds:
aliases:
- debugimportworlds
usage: ''
description: Import worlds by player name
confirmation: false
rate:
aliases:
- rate
- rt
usage: /plot rate [#|next|purge]
description: Rate the plot
confirmation: false
toggle:
aliases:
- toggle
- attribute
usage: /plot toggle <chat|chatspy|clear-confirmation|time|titles|worldedit>
description: Toggle per user settings
confirmation: false
time:
aliases:
- time
usage: ''
description: Toggle plot time settings
confirmation: false
chatspy:
aliases:
- chatspy
- spy
usage: ''
description: Toggle plot chat spy
confirmation: false
chat:
aliases:
- chat
usage: ''
description: Toggle plot chat
confirmation: false
clear-confirmation:
aliases:
- clear-confirmation
usage: ''
description: Toggle autoclear confirmation
confirmation: false
worldedit:
aliases:
- worldedit
- we
- wea
usage: ''
description: Toggle worldedit area restrictions
confirmation: false
titles:
aliases:
- titles
usage: ''
description: Toggle plot title messages
confirmation: false
help:
aliases:
- help
- '?'
usage: help [category|#]
description: Get this help menu
confirmation: false
uuidconvert:
aliases:
- uuidconvert
usage: /plot uuidconvert <lower|offline|online>
description: Debug UUID conversion
confirmation: false
weanywhere:
aliases:
- weanywhere
- wea
usage: /plot weanywhere
description: Force bypass of WorldEdit restrictions
confirmation: false
```