Skip to content
This repository was archived by the owner on Jul 22, 2023. It is now read-only.

Commands

Jump to bottom
Robert Rauh edited this page Nov 4, 2019 · 64 revisions

Want to document some commands?

  • This page is automatically generated
  • Fork the project and add a javadoc comment to one of the command classes
  • Then do a pull request and it will be added to this page
  • This page is optimized to PlotSquared v4 and upwards. Some commands might not work in lesser versions or act different.

Contents

CLAIMING
TELEPORT
SETTINGS
CHAT
SCHEMATIC
APPEARANCE
INFO
DEBUG
ADMINISTRATION

Commands

BUY

Description

Buy the plot you are standing on

Usage

/plot buy

Aliases

[ buy ]

Permissions

plots.buy

SAVE

Description

Save your plot

Usage

/plot save

Aliases

[ save,backup ]

Permissions

Primary
  • plots.save
Other
  • plots.admin.command.save

LOAD

Description

Load your plot

Usage

Primary
  • /plot restore
Other
  • /plot load <index>

Aliases

[ load,restore ]

Permissions

Primary
  • plots.load
Other
  • plots.admin.command.load

CONFIRM

Description

Confirm an action

Usage

/plot confirm

Aliases

[ confirm ]

Permissions

plots.use

TEMPLATE

Description

Create or use a world template

Usage

Primary
  • /plot template [import|export] <world> <template>
Other
  • /plot template <import|export> <world> [template]
  • /plot template export <world>
  • /plot template import <world> <template>

Aliases

[ template ]

Permissions

plots.admin

DOWNLOAD

Description

Download your plot

Usage

/plot download [schematic|bo3|world]

Required callers

PLAYER

Aliases

[ download,dl ]

Permissions

Primary
  • plots.download
Other
  • plots.download.bo3
  • plots.download.world

UPDATE

Description

Update PlotSquared

Usage

Primary
  • /plot update
Other
  • /plot update [url]

Aliases

[ update,updateplugin ]

Permissions

plots.admin.command.update

TEMPLATE

Description

Create or use a world template

Usage

Primary
  • /plot template [import|export] <world> <template>
Other
  • /plot template <import|export> <world> [template]
  • /plot template export <world>
  • /plot template import <world> <template>

Aliases

[ template ]

Permissions

plots.admin

SETUP

Description

Setup wizard for plot worlds

Usage

/plot setup

Aliases

[ setup,create ]

Permissions

plots.admin.command.setup

AREA

Description

Create a new PlotArea

Usage

Primary
  • /plot area <create|info|list|tp|regen>
Other
  • /plot visit [area]
  • info [area]
  • create [world[:id]] [<modifier>=<value>]...
  • /plot area create [world[:id]] [<modifier>=<value>]...
  • list [#]

Aliases

[ area,world ]

Permissions

Primary
  • plots.area
Other
  • plots.area.list
  • plots.area.info
  • plots.area.create
  • plots.area.tp
  • plots.area.regen

DEBUGSAVETEST

Description

This command will force the recreation of all plots in the DB

Usage

/plot debugsavetest

Required callers

CONSOLE

Aliases

[ debugsavetest ]

Permissions

plots.debugsavetest

DEBUGLOADTEST

Description

This debug command will force the reload of all plots in the DB

Usage

/plot debugloadtest

Required callers

CONSOLE

Aliases

[ debugloadtest ]

Permissions

plots.debugloadtest

CREATEROADSCHEMATIC

Description

Add a road schematic to your world using the roads around your current plot

Usage

/plot createroadschematic

Aliases

[ createroadschematic,crs ]

Permissions

plots.createroadschematic

DEBUGALLOWUNSAFE

Description

Allow unsafe actions until toggled off

Usage

/plot debugallowunsafe

Aliases

[ debugallowunsafe ]

Permissions

plots.debugallowunsafe

REGENALLROADS

Description

Regenerate all roads in the map using the set road schematic

Usage

/plot regenallroads <world> [height]

Required callers

CONSOLE

Aliases

[ regenallroads,rgar ]

Permissions

plots.regenallroads

CLAIM

Description

Claim the current plot you're standing on. If you activated the "specify_on_claim" option in the world.yml you can define a schematic.

Usage

Primary
  • /plot claim
Other
  • /plot claim <schematic>

Required callers

PLAYER

Aliases

[ claim,c ]

Permissions

Primary
  • plots.claim
Other
  • plots.plot.<#>
  • plots.claim." + schemati
  • plots.claim.<arg>
  • plots.admin.command.schematic

AUTO

Description

Claim the nearest plot

Usage

/plot auto [length,width]

Aliases

[ auto,a ]

Permissions

Primary
  • plots.auto
Other
  • plots.plot.<#>
  • plots.claim." + schemati
  • plots.auto.mega
  • plots.claim.<arg>
  • plots.admin.command.schematic

VISIT

Description

Visit someones plot

Usage

Primary
  • /plot visit [player|alias|world|id] [#]
Other
  • /plot visit <world>;<id> [#]

Required callers

PLAYER

Aliases

[ visit,v,tp,teleport,goto,home,h ]

Permissions

Primary
  • plots.visit
Other
  • plots.visit.unowned
  • plots.home
  • plots.visit.owned
  • plots.visit.shared
  • plots.visit.other

SET

Description

Set a plot value

Usage

/plot set <biome|alias|home|flag> <value...>

Aliases

[ set,s ]

Permissions

Primary
  • plots.set
Other
  • plots.set." + componen
  • plots.set.<arg>

CLEAR

Description

Clear a plot

Usage

/plot clear

Aliases

[ clear,reset ]

Permissions

Primary
  • plots.clear
Other
  • plots.admin.command.clear
  • plots.continue

DELETE

Description

Delete a plot

Usage

/plot delete

Aliases

[ delete,dispose,del,reset ]

Permissions

Primary
  • plots.delete
Other
  • plots.admin.command.delete

TRUST

Description

Allow a player to build in a plot

Usage

/plot trust <player>

Required callers

PLAYER

Aliases

[ trust,t ]

Permissions

Primary
  • plots.trust
Other
  • plots.admin.command.trust
  • plots.trust.everyone

ADD

Description

Allow a user to build while you are online

Usage

/plot add <player>

Required callers

PLAYER

Aliases

[ add ]

Permissions

Primary
  • plots.add
Other
  • plots.admin.command.trust
  • plots.trust.everyone

DENY

Description

Deny a user from a plot

Usage

/plot deny <player>

Required callers

PLAYER

Aliases

[ deny,d,ban ]

Permissions

Primary
  • plots.deny
Other
  • plots.admin.command.deny
  • plots.deny.everyone

REMOVE

Description

Remove a player from a plot

Usage

/plot remove <player>

Required callers

PLAYER

Aliases

[ remove,r,untrust,ut,undeny,ud,unban ]

Permissions

Primary
  • plots.remove
Other
  • plots.admin.command.remove

INFO

Description

Display plot info

Usage

/plot info <id>

Aliases

[ info,i ]

Permissions

plots.info

LIST

Description

List plots

Usage

Primary
  • /plot list <forsale|mine|shared|world|top|all|unowned|unknown|player|world|done|fuzzy <search...>> [#]
Other
  • /plot list fuzzy <search...> [#]

Aliases

[ list,l,find,search ]

Permissions

Primary
  • plots.list
Other
  • plots.list.world.<arg>
  • plots.list.top
  • plots.list.mine
  • plots.list.world
  • plots.list.done
  • plots.list.all
  • plots.list.shared
  • plots.list.expired
  • plots.list.unowned
  • plots.list.world." + worl
  • plots.list.player
  • plots.list.forsale
  • plots.list.world." + args[0
  • plots.list.unknown
  • plots.list.area
  • plots.list.fuzzy

DEBUG

Description

Show debug information

Usage

/plot debug [msg]

Aliases

[ debug ]

Permissions

plots.admin

SCHEMATIC

Description

Schematic command

Usage

/plot schematic <arg...>

Aliases

[ schematic,sch ]

Permissions

Primary
  • plots.schematic
Other
  • plots.admin.command.schematic.paste
  • plots.admin.command.schematic.save
  • plots.schematic.test
  • plots.schematic.save
  • plots.schematic.paste

PLUGIN

Description

Show plugin information

Usage

/plot plugin

Aliases

[ plugin,version ]

Permissions

plots.use

PURGE

Description

Purge all plots for a world

Usage

/plot purge world:<world> area:<area> id:<id> owner:<owner> shared:<shared> unknown:[true|false]

Required callers

CONSOLE

Aliases

[ purge ]

Permissions

plots.admin

RELOAD

Description

Reload configurations

Usage

/plot reload

Aliases

[ reload ]

Permissions

plots.admin.command.reload

RELIGHT

Description

Relight your plot

Usage

/plot relight

Aliases

[ relight ]

Permissions

plots.relight

MERGE

Description

Merge the plot you are standing on, with another plot

Usage

Primary
  • /plot merge <all|n|e|s|w> [removeroads]
Other
  • /plot merge < <arg> | <arg> > [removeroads]

Required callers

PLAYER

Aliases

[ merge,m ]

Permissions

Primary
  • plots.merge
Other
  • plots.merge.<#>
  • plots.admin.command.merge
  • plots.merge.other
  • plots.merge.keeproad

DEBUGPASTE

Description

Upload settings.yml, worlds.yml, commands.yml, latest.log, PlotSquared.use_THIS.yml and Multiverse's worlds.yml (if being used) to https://athion.net/ISPaster/paste/

Usage

/plot debugpaste

Aliases

[ debugpaste,dp ]

Permissions

plots.debugpaste

UNLINK

Description

Unlink a mega-plot

Usage

/plot unlink

Aliases

[ unlink,u,unmerge ]

Permissions

Primary
  • plots.unlink
Other
  • plots.admin.command.unlink

KICK

Description

Kick a player from your plot

Usage

/plot kick <player>

Required callers

PLAYER

Aliases

[ kick,k ]

Permissions

Primary
  • plots.kick
Other
  • plots.admin.command.kick

RATE

Description

Rate the plot

Usage

/plot rate [#|next]

Aliases

[ rate,rt ]

Permissions

Primary
  • plots.rate
Other
  • plots.comment

DEBUGCLAIMTEST

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

Usage

/plot debugclaimtest

Required callers

CONSOLE

Aliases

[ debugclaimtest ]

Permissions

plots.debugclaimtest

INBOX

Description

Review the comments for a plot

Usage

/plot inbox [inbox] [delete <index>|clear|page]

Aliases

[ inbox ]

Permissions

plots.inbox

COMMENT

Description

Comment on a plot

Usage

/plot comment

Aliases

[ comment,msg ]

Permissions

plots.comment

DATABASE

Description

Convert/Backup Storage

Usage

/plots database [area] <sqlite|mysql|import>

Required callers

CONSOLE

Aliases

[ database,convert ]

Permissions

plots.database

SWAP

Description

Swap two plots

Usage

Primary
  • /plot swap <X;Z>
Other
  • /plot copy <X;Z>

Aliases

[ swap,switch ]

Permissions

Primary
  • plots.swap
Other
  • plots.admin
  • .PERMISSION_ADMIN.s

MUSIC

Description

Player music in a plot

Usage

/plot music

Required callers

PLAYER

Aliases

[ music ]

Permissions

plots.music

DEBUGROADREGEN

Description

Regenerate all roads based on the road schematic

Usage

/plot debugroadregen

Aliases

[ debugroadregen ]

Permissions

plots.debugroadregen

TRUST

Description

Allow a player to build in a plot

Usage

/plot trust <player>

Required callers

PLAYER

Aliases

[ trust,t ]

Permissions

Primary
  • plots.trust
Other
  • plots.admin.command.trust
  • plots.trust.everyone

DEBUGEXEC

Description

Mutli-purpose debug command

Usage

Primary
  • /plot debugexec
Other
  • /plot debugexec remove-flag <flag>
  • /plot debugexec allcmd <condition> <command>
  • /plot debugexec list-scripts [#]
  • /plot debugexec all <condition> <code>
  • /plot debugexec addcmd <file>
  • /plot debugexec analyze <threshold>

Aliases

[ debugexec,exec,$ ]

Permissions

plots.admin

SETFLAG

Description

Set plot flags

Comments
plot flag set fly true
plot flag remove fly
plot flag remove use 1,3
plot flag add use 2,4
plot flag list

Usage

Primary
  • /plot flag <set|remove|add|list|info> <flag> <value>
Other
  • /plot flag info <flag>
  • /plot flag <set|remove|add|list|info>
  • /plot flag add <flag> <values>
  • /plot flag list
  • /plot flag set <flag> <value>
  • /plot flag remove <flag> [values]

Required callers

PLAYER

Aliases

[ setflag,f,flag,setf ]

Permissions

Primary
  • plots.flag
Other
  • plots.set.flag
  • plots.flag.remove
  • plots.flag.add
  • plots.set.flag.other
  • plots.set.flag.<arg>
  • plots.flag.list
  • plots.set.flag." + args[1].toLowerCase

TARGET

Description

Target a plot with your compass

Usage

/plot target <<plot>|nearest>

Required callers

PLAYER

Aliases

[ target ]

Permissions

plots.target

DEBUGFIXFLAGS

Description

Attempt to fix all flags for a world

Usage

/plot debugfixflags <world>

Required callers

CONSOLE

Aliases

[ debugfixflags ]

Permissions

plots.debugfixflags

MOVE

Description

Move a plot

Usage

Primary
  • /plot move <X;Z>
Other
  • /plot copy <X;Z>

Aliases

[ move,debugmove ]

Permissions

Primary
  • plots.move
Other
  • plots.admin
  • .PERMISSION_ADMIN.s

CONDENSE

Description

Condense a plotworld

Usage

/plot condense

Required callers

CONSOLE

Aliases

[ condense ]

Permissions

plots.admin

COPY

Description

Copy a plot

Usage

/plot copy <X;Z>

Aliases

[ copy,copypaste ]

Permissions

Primary
  • plots.copy
Other
  • plots.admin
  • .PERMISSION_ADMIN.s

CHAT

Description

Toggle plot chat on or off

Usage

/plot chat [on|off]

Aliases

[ chat ]

Permissions

Primary
  • plots.chat
Other
  • plots.chat.color

TRIM

Description

Delete unmodified portions of your plotworld

Comments
Runs the result task with the parameters (viable, nonViable).
@param world The world
@param result (viable = .mcr to trim, nonViable = .mcr keep)
@return

Usage

/plot trim <world> [regenerate]

Required callers

CONSOLE

Aliases

[ trim ]

Permissions

plots.admin

DONE

Description

Mark a plot as done

Usage

/plot done

Required callers

PLAYER

Aliases

[ done,submit ]

Permissions

Primary
  • plots.done
Other
  • plots.admin.command.done

CONTINUE

Description

Continue a plot that was previously marked as done

Usage

/plot continue

Aliases

[ continue ]

Permissions

Primary
  • plots.continue
Other
  • plots.admin.command.continue

BO3

Description

Mark a plot as done

Usage

Primary
  • /plot bo3
Other
  • /plot bo3 export [category] [alias] [-r]
  • /plot bo3 import <file>

Aliases

[ bo3,bo2 ]

Permissions

Primary
  • plots.bo3
Other
  • plots.admin.command.bo3

MIDDLE

Description

Teleports you to the center of the current plot

Comments
@author manuelgu, altered by Citymonstret

Usage

/plot middle

Required callers

PLAYER

Aliases

[ middle,center ]

Permissions

plots.middle

GRANT

Description

``

Usage

/plot grant <check|add> [player]

Aliases

[ grant ]

Permissions

Primary
  • plots.grant
Other
  • plots.grant." + arg
  • plots.grant.<arg>

SETOWNER

Description

Set the plot owner

Usage

/plot setowner <player>

Aliases

[ setowner,owner,so,seto ]

Permissions

Primary
  • plots.set.owner
Other
  • plots.admin.command.setowner

SETDESCRIPTION

Description

Set the plot description

Usage

/plot desc <description>

Aliases

[ setdescription,desc,setdesc,setd,description ]

Permissions

plots.set.desc

SETBIOME

Description

Set the plot biome

Usage

/plot biome [biome]

Aliases

[ setbiome,biome,sb,setb,b ]

Permissions

plots.set.biome

ALIAS

Description

Set the plot name

Usage

/plot alias set <alias>
/plot alias remove <alias>

Aliases

[ setalias,alias,sa,name,rename,setname,seta, nameplot ]

Permissions

plots.alias
NEW: plots.alias.set and plots.alias.remove (The old permission still work!)

SETHOME

Description

Set the plot home

Usage

/plot sethome [none]

Aliases

[ sethome,sh,seth ]

Permissions

plots.set.home

CLUSTER

Description

Manage a plot cluster

Usage

Primary
  • /plot cluster
Other
  • /plot cluster resize <pos1> <pos2>
  • /plot cluster leave [name]
  • /plot cluster info [name]
  • /plot cluster create <name> <id-bot> <id-top>
  • /plot cluster delete [name]
  • /plot cluster list
  • /plot cluster invite <player>
  • /plot cluster sethome
  • /plot cluster helpers <add|remove> <player>
  • /plot cluster tp <name>
  • /plot cluster kick <player>

Aliases

[ cluster,clusters ]

Permissions

Primary
  • plots.cluster
Other
  • plots.cluster.delete.other
  • plots.cluster.kick
  • plots.cluster.leave
  • plots.cluster.helpers
  • plots.cluster.create
  • plots.cluster.resize
  • plots.cluster.invite.other
  • plots.cluster.invite
  • plots.cluster.tp
  • plots.cluster.<#>
  • plots.cluster.resize.expand
  • plots.cluster.info
  • plots.cluster.sethome.other
  • plots.cluster.resize.other
  • plots.cluster.tp.other
  • plots.cluster.kick.other
  • plots.cluster.create.other
  • plots.cluster.list
  • plots.cluster.delete
  • plots.cluster.resize.shrink
  • plots.cluster.sethome

TOGGLE

Description

Toggle per user settings

Usage

/plot toggle [worldedit|chat|chatspy|titles|time]

Aliases

[ toggle,attribute ]

Permissions

plots.use

HELP

Description

Get this help menu

Usage

/plot help help [category|#]

Aliases

[ help,he,? ]

Permissions

plots.use

WEANYWHERE

Description

Force bypass of WorldEdit

Usage

/plot weanywhere

Aliases

[ weanywhere,wea ]

Permissions

plots.worldedit.bypass

Visit the rendered wiki: https://intellectualsites.github.io/PlotSquared-Documentation/

Spigot Downloads Spigot Rating Discord

Home

About

Changelog

Installation

Commands / Perms / Flags

API documentation

Customization

» Configuration Files
» World optimization
» Schematics

Clone this wiki locally