From 4d6f0666e5a4531ae638e0f7bd334276271ddfbe Mon Sep 17 00:00:00 2001 From: Jesse Boyd Date: Sat, 22 Aug 2015 03:41:39 +1000 Subject: [PATCH] Updated Commands (markdown) --- Commands.md | 1116 ++++++++++++++++++++++++--------------------------- 1 file changed, 526 insertions(+), 590 deletions(-) diff --git a/Commands.md b/Commands.md index e5f8062..43ba43d 100644 --- a/Commands.md +++ b/Commands.md @@ -1,1052 +1,988 @@ -## add -### Description +## [ADD](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-add) +#### Description `Allow a user to build while you are online` -### Usage +#### Usage `/plot add ` -#### Required arguments +##### Required arguments `PlayerName` : `Dinnerbone` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[a]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.add` -#### Sub -`TODO` +*** -## auto -### Description +## [AUTO](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-auto) +#### Description `Claim the nearest plot` -### Usage +#### Usage `/plot auto` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[a]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.auto` -#### Sub -`TODO` +*** -## bo3 -### Description +## [BO3](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-bo3) +#### Description `Mark a plot as done` -### Usage +#### Usage `/{label} bo3` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[bo2]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.done` -#### Sub -`TODO` +*** -## buy -### Description +## [BUY](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-buy) +#### Description `Buy the plot you are standing on` -### Usage +#### Usage `/plot buy` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[b]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.buy` -#### Sub -`TODO` +*** -## chat -### Description +## [CHAT](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-chat) +#### Description `Toggle plto chant on or off` -### Usage +#### Usage `/plot chat [on|off]` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.chat` -#### Sub -`TODO` +*** -## claim -### Description +## [CLAIM](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-claim) +#### Description `Claim the current plot you're standing on` -### Usage +#### Usage `/plot claim` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[c]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.claim` -#### Sub -`TODO` +*** -## clear -### Description +## [CLEAR](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-clear) +#### Description `Clear a plot` -### Usage +#### Usage `/plot clear [id]` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.clear` -#### Sub -`TODO` +*** -## comment -### Description +## [COMMENT](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-comment) +#### Description `Comment on a plot` -### Usage +#### Usage `/{label} comment` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[msg]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.comment` -#### Sub -`TODO` +*** -## condense -### Description +## [CONDENSE](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-condense) +#### Description `Condense a plotworld` -### Usage +#### Usage `/{label} condense` -#### Required callers +##### Required callers `CONSOLE` -### Aliases +#### Aliases `[]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.admin` -#### Sub -`TODO` +*** -## confirm -### Description +## [CONFIRM](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-confirm) +#### Description `Confirm an action` -### Usage +#### Usage `/{label} confirm` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.use` -#### Sub -`TODO` +*** -## continue -### Description +## [CONTINUE](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-continue) +#### Description `Continue a plot that was previously marked as done` -### Usage +#### Usage `/{label} continue` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.continue` -#### Sub -`TODO` +*** -## copy -### Description +## [COPY](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-copy) +#### Description `Copy a plot` -### Usage +#### Usage `/plot copy ` -#### Required arguments +##### Required arguments `PlotID` : `-6;3` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[copypaste]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.copy` -#### Sub -`TODO` +*** -## createroadschematic -### Description +## [CREATEROADSCHEMATIC](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-createroadschematic) +#### Description `Add a road schematic to your world using the roads around your current plot` -### Usage +#### Usage `/plot createroadschematic` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[crs]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.createroadschematic` -#### Sub -`TODO` +*** -## database -### Description +## [DATABASE](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-database) +#### Description `Convert/Backup Storage` -### Usage +#### Usage `/plots database [world] ` -#### Required callers +##### Required callers `CONSOLE` -### Aliases +#### Aliases `[convert]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.database` -#### Sub -`TODO` +*** -## debug -### Description +## [DEBUG](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-debug) +#### Description `Show debug information` -### Usage +#### Usage `/plot debug [msg]` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.admin` -#### Sub -`TODO` +*** -## debugallowunsafe -### Description +## [DEBUGALLOWUNSAFE](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-debugallowunsafe) +#### Description `Allow unsafe actions until toggled off` -### Usage +#### Usage `/plot debugallowunsafe` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.debugallowunsafe` -#### Sub -`TODO` +*** -## debugclaimtest -### Description +## [DEBUGCLAIMTEST](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-debugclaimtest) +#### Description `If you accidentally delete your database, this command will attempt to restore all plots based on the data from plot sighs. Execution time may vary` -### Usage +#### Usage `/{label} debugclaimtest` -#### Required callers +##### Required callers `CONSOLE` -### Aliases +#### Aliases `[]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.debugclaimtest` -#### Sub -`TODO` +*** -## debugclear -### Description +## [DEBUGCLEAR](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-debugclear) +#### Description `Clear a plot using a fast experiment algorithm` -### Usage +#### Usage `/{label} debugclear` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[fastclear]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.debugclear` -#### Sub -`TODO` +*** -## debugexec -### Description +## [DEBUGEXEC](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-debugexec) +#### Description `Mutli-purpose debug command` -### Usage +#### Usage `/{label} debugexec` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[exec]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.admin` -#### Sub -`TODO` +*** -## debugfixflags -### Description +## [DEBUGFIXFLAGS](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-debugfixflags) +#### Description `Attempt to fix all flags for a world` -### Usage +#### Usage `/plot debugfixflags ` -#### Required arguments +##### Required arguments `String` : `Example` -#### Required callers +##### Required callers `CONSOLE` -### Aliases +#### Aliases `[]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.debugfixflags` -#### Sub -`TODO` +*** -## debugloadtest -### Description +## [DEBUGLOADTEST](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-debugloadtest) +#### Description `This debug command will force the reload of all plots in the DB` -### Usage +#### Usage `/plot debugloadtest` -#### Required callers +##### Required callers `CONSOLE` -### Aliases +#### Aliases `[]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.debugloadtest` -#### Sub -`TODO` +*** -## debugpaste -### Description +## [DEBUGPASTE](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-debugpaste) +#### Description `Upload settings.yml & latest.log to hastebin` -### Usage +#### Usage `/plot debugpaste` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[dp]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.debugpaste` -#### Sub -`TODO` +*** -## debugroadregen -### Description +## [DEBUGROADREGEN](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-debugroadregen) +#### Description `Regenerate all roads based on the road schematic` -### Usage +#### Usage `/plot debugroadregen` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.debugroadregen` -#### Sub -`TODO` +*** -## debugsavetest -### Description +## [DEBUGSAVETEST](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-debugsavetest) +#### Description `This command will force the recreation of all plots in the DB` -### Usage +#### Usage `/plot debugsavetest` -#### Required callers +##### Required callers `CONSOLE` -### Aliases +#### Aliases `[]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.debugsavetest` -#### Sub -`TODO` +*** -## delete -### Description +## [DELETE](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-delete) +#### Description `Delete a plot` -### Usage +#### Usage `/plot delete` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[dispose, del]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.delete` -#### Sub -`TODO` +*** -## deny -### Description +## [DENY](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-deny) +#### Description `Deny a user from a plot` -### Usage +#### Usage `/plot deny ` -#### Required arguments +##### Required arguments `PlayerName` : `Dinnerbone` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[d]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.deny` -#### Sub -`TODO` +*** -## done -### Description +## [DONE](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-done) +#### Description `Mark a plot as done` -### Usage +#### Usage `/{label} done` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[submit]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.done` -#### Sub -`TODO` +*** -## download -### Description +## [DOWNLOAD](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-download) +#### Description `Download your plot` -### Usage +#### Usage `/{label} download` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[dl]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.download` -#### Sub -`TODO` +*** -## fill -### Description +## [FILL](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-fill) +#### Description `Fill or surround a plot in bedrock` -### Usage +#### Usage `/plot fill` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[debugfill]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.fill` -#### Sub -`TODO` +*** -## flag -### Description +## [FLAG](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-flag) +#### Description `Manage plot flags` -### Usage +#### Usage `/plot flag ` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[f]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.flag` -#### Sub -`TODO` +*** -## help -### Description +## [HELP](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-help) +#### Description `Get this help menu` -### Usage +#### Usage `/{label} help` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[he]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.help` -#### Sub -`TODO` +*** -## home -### Description +## [HOME](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-home) +#### Description `Go to your plot` -### Usage +#### Usage `/plot home [id|alias]` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[h]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.home` -#### Sub -`TODO` +*** -## inbox -### Description +## [INBOX](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-inbox) +#### Description `Review the comments for a plot` -### Usage +#### Usage `/plot inbox [inbox] [delete |clear|page]` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.inbox` -#### Sub -`TODO` +*** -## info -### Description +## [INFO](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-info) +#### Description `Display plot info` -### Usage +#### Usage `/plot info ` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[i]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.info` -#### Sub -`TODO` +*** -## kick -### Description +## [KICK](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-kick) +#### Description `Kick a player from your plot` -### Usage +#### Usage `/{label} kick` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[k]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.kick` -#### Sub -`TODO` +*** -## list -### Description +## [LIST](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-list) +#### Description `List plots` -### Usage +#### Usage `/{label} list` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[l]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.list` -#### Sub -`TODO` +*** -## load -### Description +## [LOAD](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-load) +#### Description `Load your plot` -### Usage +#### Usage `/plot restore` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[restore]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.load` -#### Sub -`TODO` +*** -## merge -### Description +## [MERGE](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-merge) +#### Description `Merge the plot you are standing on, with another plot` -### Usage +#### Usage `/plot merge [direction]` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[m]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.merge` -#### Sub -`TODO` +*** -## move -### Description +## [MOVE](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-move) +#### Description `Move a plot` -### Usage +#### Usage `/{label} move` -#### Required arguments +##### Required arguments `PlotID` : `-6;3` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[debugmove]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.move` -#### Sub -`TODO` +*** -## music -### Description +## [MUSIC](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-music) +#### Description `Player music in a plot` -### Usage +#### Usage `/plot music` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.music` -#### Sub -`TODO` +*** -## plugin -### Description +## [PLUGIN](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-plugin) +#### Description `Show plugin information` -### Usage +#### Usage `/{label} plugin` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[version]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.use` -#### Sub -`TODO` +*** -## purge -### Description +## [PURGE](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-purge) +#### Description `Purge all plots for a world` -### Usage +#### Usage `/{label} purge` -#### Required callers +##### Required callers `CONSOLE` -### Aliases +#### Aliases `[]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.admin` -#### Sub -`TODO` +*** -## rate -### Description +## [RATE](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-rate) +#### Description `Rate the plot` -### Usage +#### Usage `/plot rate [#|next]` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[rt]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.rate` -#### Sub -`TODO` +*** -## regenallroads -### Description +## [REGENALLROADS](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-regenallroads) +#### Description `Regenerate all roads in the map using the set road schematic` -### Usage +#### Usage `/plot regenallroads ` -#### Required arguments +##### Required arguments `String` : `Example` -#### Required callers +##### Required callers `CONSOLE` -### Aliases +#### Aliases `[rgar]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.regenallroads` -#### Sub -`TODO` +*** -## reload -### Description +## [RELOAD](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-reload) +#### Description `Reload configurations` -### Usage +#### Usage `/plot reload` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.admin.command.reload` -#### Sub -`TODO` +*** -## remove -### Description +## [REMOVE](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-remove) +#### Description `Remove a player from a plot` -### Usage +#### Usage `/plot remove ` -#### Required arguments +##### Required arguments `PlayerName` : `Dinnerbone` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[r]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.remove` -#### Sub -`TODO` +*** -## save -### Description +## [SAVE](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-save) +#### Description `Save your plot` -### Usage +#### Usage `/{label} save` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[backup]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.save` -#### Sub -`TODO` +*** -## schematic -### Description +## [SCHEMATIC](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-schematic) +#### Description `Schematic command` -### Usage +#### Usage `/plot schematic ` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[sch]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.schematic` -#### Sub -`TODO` +*** -## set -### Description +## [SET](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-set) +#### Description `Set a plot value` -### Usage +#### Usage `/plot set ` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[s]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.set` -#### Sub -`TODO` +*** -## setowner -### Description +## [SETOWNER](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-setowner) +#### Description `Set the plot owner` -### Usage +#### Usage `/plot setowner ` -#### Required arguments +##### Required arguments `PlayerName` : `Dinnerbone` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[so]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.set.owner` -#### Sub -`TODO` +*** -## setup -### Description +## [SETUP](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-setup) +#### Description `Setup wizard for plot worlds` -### Usage +#### Usage `/plot setup` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[create]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.admin.command.setup` -#### Sub -`TODO` +*** -## swap -### Description +## [SWAP](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-swap) +#### Description `Swap two plots` -### Usage +#### Usage `/{label} swap` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[switch]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.swap` -#### Sub -`TODO` +*** -## target -### Description +## [TARGET](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-target) +#### Description `Target a plot with your compass` -### Usage +#### Usage `/plot target ` -#### Required arguments +##### Required arguments `PlotID` : `-6;3` -#### Required callers +##### Required callers `NONE` -### Aliases +#### Aliases `[]` -### Permissions -#### Primary +#### Permissions +##### Primary plots.target` -#### Sub -`TODO` +*** -## template -### Description +## [TEMPLATE](https://github.com/IntellectualSites/PlotSquared/wiki/Command:-template) +#### Description `Create or use a world template` -### Usage +#### Usage `/plot template [import|export]