WorldGuard Documentation

WorldGuard is a plugin used to protect land areas from griefing and to manage Minecraft gameplay features (e.g., disabling fire spread, blocking specific items, or protecting regions from TNT/PVP).

To use WorldGuard, you must have the following dependencies installed on your server:

1. A Bukkit server implementation (such as Paper).
2. The WorldEdit plugin.

If you are developing on WorldGuard, you can generate project files for your preferred IDE using the following Gradle commands:

• IntelliJ IDEA: Generates a module for each folder in the multi-module project.
• Eclipse: Generates an Eclipse project for each folder in the multi-module project.

./gradlew idea
# OR
./gradlew eclipse

WorldGuard uses Gradle for its build process. You do not need to install Gradle manually, as the project includes the gradlew wrapper.

Prerequisites:

• A version of Java greater than or equal to 25 must be installed to bootstrap the process. Gradle will automatically download JDK 25 if it is not present.

Build Commands:

On Windows (PowerShell):

./gradlew build

On Linux, BSD, or Mac OS X:

./gradlew build

After running the build command, the compiled artifacts are located in the build/libs directory of their respective modules.

When using the artifacts, prefer the versions suffixed with -dist, as these include WorldGuard along with all necessary libraries.

Artifact Locations:

• WorldGuard API: worldguard-core/build/libs
• WorldGuard for Bukkit: worldguard-bukkit/build/libs

The /worldguard command (and its alias /wg) provides access to core WorldGuard management functionality via the WorldGuardCommands nested command set.

/wg <subcommand>
# Aliases: /worldguard, /wg
# Subcommands include: WorldGuardCommands

Manually trigger a save of the current region data to the storage files. You can save data for a specific world or for all worlds.

Usage: [world]

Flags:

• -w <world>: Specify the target world.

Aliases:

• save
• write

# Save all worlds
/rg save

# Save a specific world
/rg save -w world_name

Use the firePlaceEvent command (or its alias testplace) to simulate a block placement event for a specific player. This is used for debugging WorldGuard's event handling.

Usage: [player] Permissions: worldguard.debug.event Flags:

• -t
• -s

/ No direct CLI invocation example provided in source, but usage pattern is:
/ [command] [player] [-t] [-s]

Use this command to remove specific owners from a region, or remove all owners at once.

Usage: <id> <owners...>

Flags:

• -a: Remove ALL owners from the region.
• -n: Use name-only locator policy.
• -w <world>: Specify the world where the region exists.

Note: If you do not use the -a flag, you must provide at least one owner name/UUID to remove.

Aliases: removeowner, remowner, ro

removeowner <id> <owners...> [-a] [-n] [-w <world>]

Use the /wg report command to generate a diagnostic report containing system information, configuration details, and (if run by a local player) applicable regions. The report is written to report.txt in the WorldGuard configuration directory.

Flags:

• -p: If you have the worldguard.report.pastebin permission, this flag will also upload the report to Pastebin.

/wg report
/wg report -p

Allows a player to claim a region (typically used in survival/land claim contexts). Note that this command has specific configuration constraints regarding maximum volume and region counts.

Usage: <id>

/rg claim <id>