Plugins
Overview
There are a variety of plugins that add important or convenient commands. Keep in mind that most of the commands added with our plugins are not important enough to memorize; some plugins might not even add commands at all!
Coreprotect
CoreProtect is our data logging and anti-griefing tool. We use this plugin to rollback areas, check for player actions, and backup the server.
| Command | Description |
|
|
🛡️ 📗 Display a list of commands in-game. |
|
|
🛡️ 📗 Enable the inspector. Type the command again to disable it. You can also use just
. |
|
|
🛡️ 📗 Check for specific actions by a player, in an area, or even in the past set amount of time. |
|
|
🛡️ 📒 Perform a rollback. Uses the same parameters as
. Rollbacks can be used to revert player actions. |
|
|
🛡️ 📒 Perform a restore. Uses the same parameters as
. Restoring can be used to undo rollbacks or to restore player actions. |
|
|
🛡️ 📕 Purge old block data. Useful for freeing up space on your HDD if you don't need the older data. |
|
|
🛡️ 📗 Reloads the configuration file. |
|
|
🛡️ 📗 Displays the plugin status and version information. |
|
|
🛡️ 📗 Console command to pause or resume consumer queue processing. |
| Parameter | Description |
|
|
Specifies a single user or multiple users. |
|
|
Specifies weeks, days, hours, minutes, and/or seconds. Time amounts can be combined, and decimals may be used. |
|
|
Specifies a spherical radius centered at your current location. |
|
|
Specifies an action to check. |
|
|
Specifies a block, item, or entity that the operation must include. |
|
|
Specified a block, item, or entity that the operation must not include. |
|
|
Add a hashtag to the end of your command to perform additional actions. |
Dreamvisitor
Dreamvisitor, created by Bog specifically for the server, has a variety of features. It serves as an all-in-one utility plugin and Discord bot. Below are several commands. You can view them all on the Dreamvisitor wiki.
| Command | Description |
|
|
🛡️ 📗 Send a message to all operators. |
|
|
📗 Toggle whether messages from the Discord chat bridge appear in your chat. This can also be adjusted with
. |
|
|
🛡️ 📕 View or modify the Dreamvisitor configuration. |
|
|
📗 Manage your Dreamvisitor settings. |
|
|
🛡️ 📗 Teleport yourself entities to the hub location. If you have an entity on a lead, the entity will teleport with you below the normal hub location. |
|
|
🛡️ 📗 Swap between two different inventories. |
|
|
🛡️ 📒 Open the item ban list inventory GUI. |
|
|
🛡️ 📗 Remove moon globes from players. |
|
|
🛡️ 📗 Give players moon globes. |
|
|
🛡️ 📕 Kick all players and sets the player limit override to 0. |
|
|
🛡️ 📗 Cancel your current parcel delivery. |
|
|
🛡️ 📗 Add a delivery location.
cannot contain spaces, but underscores will be replaced with spaces when displayed to players.
determines the likelihood of the location being chosen. At 0, it will never be chosen. At 4, it is quite likely to be chosen.
determines only which names will appear on parcels to or from this location. |
|
|
🛡️ 📒 Remove a delivery location. |
|
|
🛡️ 📗 List all mail delivery locations. |
|
|
🛡️ 📗 Give a player a parcel or allow players to deliver parcels to a location within 10 blocks. |
|
|
🛡️ 📗 Create deliveries for players. |
|
|
🛡️ 📗 Cancel deliveries for players. |
|
|
🛡️ 📗 List ongoing deliveries. |
|
|
🛡️ 📗 Allow players to chat even when chat is paused. |
|
|
🛡️ 📕 Suppresses messages from players and the Discord chat bridge. |
|
|
🛡️ 📕 Override the server player limit. |
|
|
🛡️ 📗 Send a message to all other players who can access the radio. |
|
|
🛡️ 📒 Manage players' access to Sandbox Mode. |
|
|
🛡️ 📗 Set a player's last EssentialsX location. If no world is specified, the current world is assumed. If no rotation is specified, none will be applied. If no location is specified, the execution position will be used. |
|
|
🛡️ 📗 Change or reset the server MOTD. |
|
|
🛡️ 📗 Add a player to the soft whitelist. |
|
|
🛡️ 📗 Remove a player from the soft whitelist. |
|
|
🛡️ 📗 List all players on the soft whitelist. |
|
|
🛡️ 📗 Enable the soft whitelist. |
|
|
🛡️ 📗 Disable the soft whitelist. |
|
|
🛡️ 📗 Sync time across all worlds. |
|
|
🛡️ 📗 Send a message to all players with a given tag. |
|
|
🛡️ 📗 Toggle whether PvP is enabled or disabled. |
|
|
🛡️ 📗 Update the roles of a player based on their tribe. |
|
|
🛡️ 📗 Unwax the sign you are looking at. |
|
|
🛡️ 📗 Get details of a player, online or offline. |
|
|
🛡️ 📗 Sends a fake leave message to Discord and hides you from the list command. |
Item Blacklist
/itemblacklist will open a chest-like inventory. Items placed in this container will be saved in their place and players with matching items will have them automatically removed from non-operator player inventories. This removal is permanent. Be cautious of items you add. Items are only removed if the data is an exact match. If you put a potato into the blacklist GUI, potatoes that have been renamed or enchanted will not be removed.
A demonstration of the item blacklist.
Soft Whitelist
The soft whitelist acts as a secondary whitelist that works much like Minecraft's built-in whitelist feature. This allows reducing the allowed players to a specified group while not modifying the main whitelist. Players with the dreamvisitor.nowhitelist permission will always bypass the soft whitelist. Operators will always bypass the soft whitelist.
The soft whitelist persists through restarts.
Sandbox Mode
Sandbox Mode is a feature that allows administrators to safely allow players to use Creative Mode. When a player is put into Sandbox Mode, their inventory is swapped, and they are put into Creative Mode with the following restrictions:
- They cannot access containers.
- They cannot drop items.
- They cannot use spawn eggs.
- They cannot teleport.
A player with the dreamvisitor.sandbox permission — usually an admin — must be online for Sandbox Mode to remain active. If all admins leave, all players in Sandbox Mode will have it removed, restoring their inventories. If players leave the game while in Sandbox Mode, they will remain in Sandbox Mode when they rejoin unless there are no admins. When a Sandboxed player joins, admins will be notified.
Pause Chat
The /pausechat command will stop all incoming chat messages from being broadcasted. It will also block messages from /me and Discord pass-through. You can allow certain players to bypass this with /pausebypass. Players with the dreamvisitor.nopause permission will always bypass chat pause. Operators will always bypass chat pause.
Chat pause will persist through restarts.
Moon Globes
Moon Globes can be created with the moonglobe command.
A player may only have one moon globe at a time. Each moon globe has an origin and a maximum distance. By default, the maximum distance is 256 blocks. If a moon globe (not the player) moves beyond that distance, it will be removed. It will also be removed if the player moves to a different dimension. It will not be removed if the player disconnects, though it will disappear until the player reconnects. Moon globes are not saved, so they will be deleted upon a server shutdown.
Mail System
Players can earn money by delivering mail. Players may interact with a mail terminal to receive a parcel. They will be assigned a location to deliver it to, and they must interact with the terminal at that location without teleportation to get a reward based on the distance.
When a player interacts with a terminal (a command block with the command /parcel terminal @p), Dreamvisitor will choose a random end location with each location weighted by an inherent, preset weight, and the distance from the start location, weighing closer locations higher than further ones. The distance weight can be multiplied using the mailDeliveryLocationSelectionDistanceWeightMultiplier option in config.yml.
The player will be given an enchanted book that they must keep with them until they complete the delivery. The book will be addressed to a random name. There is a 45% chance that the name will be of the tribe associated with the start location, a 45% chance that the name will be of the tribe associated with the end location, and a 10% chance that the name will be of a random tribe. A random lore string will also be chosen from a preset pool. If the player does not have the parcel when they reach the destination location, they delivery will not be completed and they must re-obtain the parcel or cancel the delivery. If a player cancels their deliver while they still have the parcel, they will keep the parcel.
When a player completes a delivery, the parcel will be removed from them, and they will be given a reward based on the distance between the start and end location, multiplied by mailDistanceToRewardMultiplier in config.yml.
Discord Economy
Dreamvisitor has an economy system. Users may purchase items from a shop using currency that can be used.
The shop consists of up to 25 items. Items have an ID, name, description, price, sale percent, quantity, and max allowed quantity. The ID is randomly chosen upon item creation. The name and description are chosen upon creation. The price represent the regular price of the item. It must not be negative. The sale percent is a number form 0 to 100 that represents the percent removed from the price. The quantity represents the number of items available in the shop (or infinity if -1). If the item is purchased, the quantity will be reduced by one. When at zero, the item can no longer be purchased. Max allowed quantity represents the maximum number of the item a user can hold in their inventory.
Items also have the following flags:
- enabled - Whether the item appears in the shop and can be purchased.
- giftingEnabled - Whether the item can be transferred by one user to another.
- useDisabled - Whether the item can be used.
- useOnPurchase - Whether the item is automatically used when purchased. Does not override useDisabled.
Items can do the any of following on use:
- Add roles
- Remove roles
- Add parent groups (requires LuckPerms)
- Remove parent groups (requires LuckPerms)
- Execute commands via the console
Users can gain currency by claiming daily rewards and working.
Users can claim a daily reward every 24 hours. If they claim their reward before 48 hours after their last, they can build a streak. The daily reward is configured by dailyBaseAmount and the steak multiplier is configured by dailyStreakMultiplier in config.yml.
Users can work once every hour. The work reward is configured by workReward.
EssentialsX
EssentialsX is the most comprehensive general-purpose plugin available. It provides teleportation, moderation tools, gameplay enhancements, homes, warps, sign shops, kits, and everything in between. Being a general-purpose plugin, it doesn't excel at any specific feature or function, but its versatility means there are a lot of commands to consider. Here are the most important for an admin:
| Command | Description |
|
|
🛡️ 📗 Edits a sign that the player is looking at. |
|
|
📗 Blocks receiving all private messages. |
|
|
📗 Mutes or unmutes a player. |
|
|
🛡️ 📗 Change the mob type of a spawner. |
|
|
🛡️ 📒 Assigns a command to the item in hand. Use
as the command to make a chat macro. Use
to append multiple commands. Use
to remove a single command. Use
to list all power tools Use
to remove all power tools. |
|
|
🛡️ 📗 Reports memory, uptime and tick info. |
|
|
🛡️ 📗 Lets you see inside an ender chest. |
|
|
🛡️ 📗 Enables or disables all current powertools. |
|
|
🛡️ 📗 Change your walk or fly speed. |
|
|
🛡️ 📗 Displays player information. |
|
|
🛡️ 📗 Opens a portable disposal menu. |
|
|
🛡️ 📗 Condenses items into more compact blocks. |
|
|
🛡️ 📗 Allows reopening and editing of sealed books. |
|
|
📗 Manages inter-player, intra-server mail. |
|
|
🛡️ 📗 Adjust a player's weather. |
|
|
📗 Toggles ignoring other players. |
|
|
📗 Lists the players nearby or around a player. |
|
|
🛡️ 📗 See and/or edit the inventory of other players. |
|
|
🛡️ 📗 Toggles if you can see msg/mail commands in chat. |
|
|
🛡️ 📗 Adjust player's client time. Add @ prefix to fix. |
|
|
📗 Teleport to your home. |
|
|
🛡️ 📗 Hide yourself from other players. |
|
|
🛡️ 📗 Enables your godly powers. |
|
|
🛡️ 📗 Get the player head item with your skin or a skin of a specified player, or change the skin of the head you're holding. |
|
|
🛡️ 📗 Broadcasts a message to the entire server. |
|
|
🛡️ 📗 Searches for an item. |
|
|
🛡️ 📗 Edit the lore of an item. |
|
|
🛡️ 📗 Renames the item you're currently holding. Leave
empty to reset. You can add in color codes when you have permission to. |
|
|
🛡️ 📒 Manages a player's economy. |
|
|
🛡️ 📗 Satisfy the hunger of a specified player. |
|
|
🛡️ 📗 Heals you or the given player. |
|
|
🛡️ 📗 Change your nickname or that of another player. |
Powertools
/powertool allows you to assign a command to an item. Pressing the attack button (left mouse button by default) will execute the command. The argument {player} will insert the name of a clicked player. There are five flags you can prepend to the argument that change the behavior of /powertool. c: will create a chat macro. Instead of running a command, the powertool will send a chat message. Use a: to append multiple commands. Use r: to remove a single command from a powertool. Use l: to list all power tools and their commands. Use d: to remove all power tools.
|
Command |
Description |
|
|
Executes 'setblock ~ ~-1 ~ stone' on click. |
|
|
Gives regeneration to a player that you click on. |
|
|
Adds a subsequent command to give saturation to a clicked player |
GriefDefender
GriefDefender is the claim and anti-grief system we use that allows players to claim and protect 2D and 3D land plots.
| Command | Description |
|
|
📒 📕 Abandon a specific claim, or all of your owned claims. |
|
|
🛡️ 📕 Abandon all claims in the current world or a specified world. |
|
|
📗 Purchases additional claim blocks. |
|
|
📗 View a list of claims for sale. |
|
|
📗 Contracts/shrinks the claim from the direction you are facing. |
|
|
📗 Creates a claim around the player of the given type. |
|
|
📗 Expands the claim in the direction you are facing. |
|
|
📗 Sets a message to display when a player leaves the claim. |
|
|
📗 Sets a message to display when a player enters the claim. |
|
|
📗 Enable/disable greeting and farewell messages on trusted claims. |
|
|
📗 Used to manage GD claims with WorldEdit. |
|
|
📗 Toggles 3D claiming on and off. |
|
|
🛡️ 📗 Enables admin claim mode with the claiming tool. |
|
|
📗 Enables basic claim mode with the claiming tool. |
|
|
📗 Enables subdivide claim mode with the claiming tool. |
|
|
📗 Enables town claim mode with the claiming tool. |
|
|
🛡️ 📗 Gets information about a player and their claim blocks. |
|
|
📗 Sell your claim blocks for server money. |
|
|
📗 Puts your claim up for sale at the set price. To disable sale, set the price to -1 or set ForSale setting in /claiminfo to false. |
|
|
📗 Transfers the player's claim blocks to another player. |
|
|
📗 Teleports the player to a safe location if they are stuck and unable to build. |
|
|
📗 View and manage claim permissions for this claim or all claims you own. |
|
|
📗 Revoke a player or group's access to this claim or all claims you own. |
Claim Types
- Basic: Default claim type used for users.
- Town: Can house other basic claims, similarly to how basic or admin claims can house subdivisions.
- Admin: Has no size restrictions, does not cost anything to create, can be created around any existing claim, can be rented, and are only manageable by administrators.
- Wilderness: The default claim around the world that is not owned by any player.
- Subdivision: Used to subdivide top level claims such as basic/admin/town into smaller areas.
Trust Types
- Resident: Player/group can create (sub?)claims. Includes Accessor trust.
- Accessor: Player/group can enter your claim and use your bed.
- Container: Player/group can access containers, crops, animals, beds, buttons, and levers in your claim.
- Builder: Player/group can build in your claim.
- Manager: Player/group can do all of the above and use this command.
LuckPerms
LuckPerms is a permissions plugin for Minecraft servers. It allows server admins to control what features players can use by creating groups and assigning permissions.
| Command | Description |
|
|
🛡️ 📗 Provides a link to a web editor. This editor is used to manage permissions. |
SignShop
SignShop is an economy-dependent plugin that allows players to exchange goods with an installed economy plugin (for us, this is Vault). As there are few, if any, commands to know for SignShop usage, below is a table of sign types available with SignShop instead.
| Sign | Description |
|
/
|
Buy / sell an item from the shop chest for the price specified on the 4th line. |
|
|
Trades one set of items for another, 2 chests required. |
|
|
Link to another SignShop to split profits, lines 2 and 3 are for the other players, line 4 is for % amounts (e.g. "25/50" for 75% to others). |
|
|
Link to another SignShop to make the shop take/give money to a bank account, The bank account is specified on line 2 of the sign (Note: you must own the bank account for this to work). |
|
|
Gives an item to the shop chest. |
|
|
Donates the item in your hand to the shop chest. |
|
|
Takes the item in your hand and safely decomposes the material. |
|
|
Gives a random item from the selected chest items (not the entire inventory) to the player. |
|
|
Turns a lever on. |
|
|
Turns a lever off. |
|
|
Toggles a lever. |
|
|
Temporarily turns on a lever. |
|
|
Temporarily turns on a lever using items as payment. |
|
|
Allows players to create jukeboxes by placing music discs in a chest. |
|
|
Makes it so only certain permission groups can use the linked SignShop (listed on lines 2, 3, and 4). |
|
|
🛡️ Buy an item from the shop chest, but the owner receives no money. |
|
|
🛡️ Sell an item to the shop chest, and the player receives money, but not from the owner. |
|
|
🛡️ Buy an item from the "shop", money goes to no one, infinite items. |
|
|
🛡️ Sell an item to the "shop", infinite money, item disappears. |
|
|
🛡️ Trades one set of items for another, infinite stock. |
|
|
🛡️ Takes the user's inventory and replaces it with items from a chest, infinite stock. |
|
|
🛡️ Gives the buyer a set of items once (infinite stock), must be reset using ResetKit sign before they can use it again. |
|
|
🛡️ Allows a player to use a Kit sign again. |
|
|
🛡️ Buy the number of XP levels on the third line of the sign. |
|
|
🛡️ Sell the number of XP levels on the third line of the sign. |
|
|
🛡️ Buy an item using raw XP points on the third line of the sign. |
|
|
🛡️ Sell an item using raw XP points on the third line of the sign. |
|
|
🛡️ Gives a random item from the selected chest items with infinite stock. |
|
|
🛡️ Turns the time to day. |
|
|
🛡️ Turns the time to night. |
|
|
🛡️ Turns on rain + thunder. |
|
|
🛡️ Turns off rain + thunder. |
|
|
🛡️ Repairs the current item. |
|
|
🛡️ Fully heals the player. |
|
|
🛡️ Sells the enchantments from the item in the chest. |
|
|
🛡️ Removes enchantments from an item. |
|
|
🛡️ An example of a custom sign for running commands. |
|
|
🛡️ Allows players to run commands on the 2nd and 3rd lines of the sign. |
|
|
🛡️ Allows players to run commands on the 2nd and 3rd lines of the sign as if they typed it themselves. |
|
|
🛡️ Promotes players to the permission group listed on the 2nd line of the sign. |
spark
spark (yes, the s is not capitalized) is a performance monitoring tool.
| Command | Description |
|
|
🛡️ 📗 Used to start, stop, or view information on a profiler. Profilers are used to create digestible information on how well the server is running. |
|
|
🛡️ 📗 Prints information about the servers TPS (ticks per second) rate and CPU usage. |
|
|
🛡️ 📗 Generates a health report for the server, including TPS, CPU, Memory and Disk Usage. |
|
|
🛡️ 📗 Prints information about average (or specific) player ping. |
|
|
🛡️ 📗 Controls the tick monitoring system. |
|
|
🛡️ 📗 Prints information about the servers GC (garbage collection) history. |
|
|
🛡️ 📗 Toggles the GC (garbage collection) monitoring system on or off. |
|
|
🛡️ 📗 Generates a new memory (heap) dump summary and upload it to the viewer. |
|
|
🛡️ 📗 Generates a new heapdump (.hprof snapshot) file and saves to the disk. |
|
|
🛡️ 📗 Prints information about recent activity performed by spark. |
WorldEdit
WorldEdit is a terrain editing plugin that allows operators to move and shape large quantities of blocks. We recommend using WorldEdit CUI for some helpful visual information when using this tool. This guide will cover the most common commands. To find more in-depth information, see the WorldEdit Documentation Hub.
Basic Commands
| Command | Description |
|
|
🛡️ 📗 Gives the player a wand (wooden axe). Left click to select the first desired position, right click to select the second. |
|
|
🛡️ 📗 Reverses a chosen number of WorldEdit commands. Defaults to 1. |
|
|
🛡️ 📗 Reverses a chosen number of
commands. Defaults to 1. |
|
,
|
🛡️ 📗 Sets first and second positions to your current location respectively without the wand. |
|
|
🛡️ 📗 📒 Sets the current selection to the chosen block. |
|
|
🛡️ 📗 📒 Replaces the target block in a selection to the chosen block. |
|
|
🛡️ 📒 Replaces the target block in the radius to the chosen block. |
|
|
🛡️ 📗 Copies all blocks in a selection to the clipboard. |
|
|
🛡️ 📗 Cuts all blocks in a selection to the clipboard. |
|
|
🛡️ 📒 📕 Pastes all blocks in the clipboard relative to the player's position. |
|
|
🛡️ 📗 Clears the clipboard. |
|
|
🛡️ 📗 Rotates the contents of the clipboard with the given angle (multiples of 90). |
|
|
🛡️ 📗 Flips the contents of the clipboard across the given direction or the direction the player is facing. |
|
|
🛡️ 📗 📒 Moves all blocks in the selection to the chosen distance relative to the direction the player is facing. |
Tool Commands
| Command | Description |
|
|
🛡️ 📗 📒 Shifts the selection a given amount. |
|
|
🛡️ 📗 Expands the selection a given amount. |
|
|
🛡️ 📗 Contracts the selection a given amount. |
|
|
🛡️ 📗 Deselects the selection. |
|
|
🛡️ 📗 Counts the number of blocks in a selection. |
|
|
🛡️ 📗 Provides information about the selection. |
|
|
🛡️ 📗 Drains water and lava in the given radius. |
|
|
🛡️ 📗 Levels water or lava in the given radius. |
|
|
🛡️ 📗 📒 Kills mobs in the given radius. |
|
|
🛡️ 📗 Teleports the player up on the y axis the given amount of blocks. |
|
|
🛡️ 📗 Teleports the player through obstacles in the facing direction. |
|
|
🛡️ 📗 Gives the player a debug stick that can be used to easily rotate blocks. |
Generation Commands
| Command | Description |
|
|
🛡️ 📗 Repeats the content of the selection the chosen distance (#) relative to the direction the player is facing. |
|
|
🛡️ 📗 Lists available saved schematics. |
|
|
🛡️ 📗 Loads the chosen schematic into the clipboard. |
|
|
🛡️ 📒 Pastes the schematic currently in the clipboard. |
|
|
🛡️ 📗 Saves the current selection as a schematic with the chosen name. |
|
|
🛡️ 📗 Deletes the chosen saved schematic. |
|
|
🛡️ 📗 Hollows out the object in the selection with the given wall thickness and block. |
|
|
🛡️ 📗 Creates walls around the sides of the selection with the chosen block. |
|
|
🛡️ 📗 Creates a cylinder of the specified size using the chosen block. |
|
|
🛡️ 📗 Creates a hollow cylinder of the specified size using the chosen block. |
|
|
🛡️ 📗 Creates a sphere of the specified size using the chosen block. |
|
|
🛡️ 📗 Creates a hollow sphere of the specified size using the chosen block. |
|
|
🛡️ 📗 Creates a pyramid of the specified size using the chosen block. |
|
|
🛡️ 📗 Creates a hollow pyramid of the specified size using the chosen block. |
|
|
🛡️ 📗 📒 Fills a hole or container with the given block. |
|
|
🛡️ 📗 Generates the specified type of forest in the selected region. |
|
|
🛡️ 📗 Places snow in a given radius. |
Brush Commands
| Command | Description |
|
|
🛡️ 📗 Applies a sphere brush to the held tool. Right click to use the brush. |
|
|
🛡️ 📗 Applies a cylinder brush to the held tool. Unlike the sphere, the cylinder brush has a height parameter along with a radius. |
|
|
🛡️ 📗 Applies a horizontal smoothing brush to the held tool. |
|
|
🛡️ 📗 Applies a deform brush to the held tool. |
|
|
🛡️ 📗 Unbinds the brush from the tool you are currently holding. |
|
|
🛡️ 📗 Applies or removes a mask to the selected brush. The brush will only affect the specified block until the mask is disabled using
again. |
|
|
🛡️ 📗 Sets a global mask for all brushes. The brush will only affect the specified block until the mask is disabled using
again. |
|
|
🛡️ 📗 Allows brush to work underwater. Run
to disable. |
Flags
| Flag | Description |
|
|
Percentage modifier that allows multiple blocks to be included in a command. The given percentage values must add up to 100% and are separated by a comma with no spaces. Exclude percentages for equal distribution. (e.g. /
) |
|
|
Specifies where a directional block should face. |
|
|
Ignore air blocks. |
|
|
Include entities. |
|
|
Include biomes. |
|
|
Excludes everything that isn't a given block. |
|
|
Prefixing any block with an exclamation point will exclude everything that comes after it. (e.g. <code>//replace !dirt stone</code> will replace everything that is not dirt with stone.) |
|
|
Prefixing any block with an asterisk (*) will set the given block in random directions. |
WorldGuard
WorldGuard is a plugin that allows operators to create regions with specific game rules and functions. We recommend using WorldEdit CUI for some helpful visual information when using this tool. This guide will cover the most common commands. To find more in-depth information, see the WorldGuard Documentation Hub.
Basic Commands
| Command | Description |
|
|
🛡️ 📗 Gives the player a wand (wooden axe). Left click to select the first desired position, right click to select the second. |
|
|
🛡️ 📗 Sets first and second positions to your current location respectively without the wand. |
|
|
🛡️ 📗 Creates a new region using the current selection. |
|
|
🛡️ 📒 📕 Deletes the given region. This cannot be undone. |
|
|
🛡️ 📗 Provides information on the given region. Defaults to the region the player is currently inside if no name is specified. Manual selections and changes can be made in this menu. |
|
|
🛡️ 📗 Lists all region flags in the given region. Manual selections can be made in this menu. |
|
|
🛡️ 📗 📒 Allows or denies a specified game rule in the given region. |
|
|
🛡️ 📗 📒 Sets the priority of a given region. Higher number priorities override the permissions of lower number priorities. |
|
|
🛡️ 📗 Sets the message players will receive when an action they attempt is blocked. |
|
|
🛡️ 📗 📒 Blocks specific commands from being used in the given region. Additional commands can be added by separating with a comma (e.g.
). |
Flags
Flags are used to make changes to what can be edited by certain players. Note that there are three default permission groups: non-member, member, and owner. You do not need to set any flags to protect a region. Also note that flags are not player-specific. Setting block-break to deny will prevent pistons, endermen, and any other mechanics that move or remove blocks from doing so because setting that flag denies access to members.
A member is anything inside the region. By default, pistons will work inside the region, but pistons outside the region cannot push blocks inside because they are non-members. Because players are non-members by default, you don't need to set any flags for protection, and it still allows members to function correctly. In specific cases, you may want to disallow any block modification whatsoever. What you want to do is to deny building for all permission groups. This is when you want to set build to deny.
Region groups are powerful, but can be difficult to understand. Keep this in mind: Members are objects that exist/originate within the region. Non-members are objects that do not exist/originate within the region, including all players. Most flags, by default, unset, allow members but deny non-members. Setting a flag to allow or deny applies that setting to both members and non-members.
| Flag | Description |
|
|
📒 This flag is short for passthrough build'. It has nothing to do with movement. If not set (default), then the region protects it area. If set to
, then the region protects its area. If set to
, then the region no longer protects its area. |
|
|
📒 📕 Whether blocks can be mined or placed, whether doors, levers, etc. (but not inventories) can be used, whether entities and blocks can be interacted with, whether player versus player combat is permitted, whether sleeping in a bed is permitted, whether inventories can be accessed, whether vehicles (boats, minecarts) can be placed, etc. This should not be used to protect a region! Regions are automatically protected by the
flag. |
|
|
📗 Everything that involves 'using' a block or entity: Whether doors, levers, etc. (but not inventories) can be used, whether vehicles (including animals) can be mounted, etc. |
|
/
|
📗 Whether blocks can be mined / used. |
|
|
📗 Whether doors, levers, etc. (but not inventories) can be used. |
|
|
📗 Whether players can harm friendly animals (cows, sheep, etc). |
|
|
📗 Whether inventories can be accessed. |
|
|
📗 Whether vehicles (including animals) can be mounted. |
|
|
📗 Whether player versus player combat is permitted. |
|
|
📗 Whether sleeping in a bed is permitted. |
|
|
📗 Whether respawn anchors can be activated. |
|
|
📗 Whether TNT detonation or damage is permitted. |
|
/
|
📗 Whether vehicles (boats, minecarts) can be placed / destroyed. |
|
|
📗 Whether flint and steel can be used. |
|
|
📗 Whether farmland and turtle eggs can be trampled. |
|
|
📗 Whether players with frost walker boots will form ice. |
|
|
📗 Whether items can be rotated within item frames. |
|
|
📗 Whether fireworks can deal damage to entities. |
|
|
📗 Whether anvils can be used. |
|
|
📗 Whether dripleaf can be used. |
WorldGuard Extra Flags provides the following extra flags. Note that most of these flags bypass operators entirely.
| Flag | Description |
|
|
📗 Disables the effects of potion effects while inside. |
|
/
|
📗 Defines the prefix/suffix shown when inside the region. |
|
|
📒 Prevents chunks the region occupies from being unloaded. |
|
/
|
📒 Executes a command as the player when a player enters/exits the region. |
|
/
|
📒 Executes a command as the console when a player enters/exits the region. |
|
|
📗 📒 When set to
, disallows creative flight from the ground. |
|
|
📗 When set to
, stops Frostwalker boots from forming ice on water within the region. |
|
|
📗 Gives players who enter the region a permanent until they leave. |
|
|
📗 When set to
, stops all gliding inside the region. |
|
|
📗 When set to
, stops all damage delivered to players. |
|
|
📗 When set to
, tools will not be damaged by any actions. |
|
|
📗 Players who disconnect in the region will teleport to the given location when joining. |
|
|
📒 When set to
, players always keep experience levels on death. If the
gamerule is set to
and this flag is set to
, the experience will be deleted on death. |
|
|
📒 When set to
, players always keep inventory on death. If the
gamerule is set to
and this flag is set to
, the inventory will be deleted on death. |
|
|
📗 When set to
, nether portals cannot be lit. |
|
|
📒 Plays a sound (from a resource location) repeatedly at a specified interval to players inside the region. This flag may produce errors if it is set incorrectly. Ask a friend to help you set this if you're not sure. |
|
|
📗 Sets the location to respawn players upon death. |
|
/
|
📗 Teleports a player to the give location when they enter/exit the region. |
|
/
|
📗 Players inside the region will inherit this speed while walking/flying. |
|
|
📗 When set to
, stops all WorldEdit operations. |