WorldGuard ${version}

Thanks for choosing WorldGuard!

First Steps

Now, to begin, you want to:

  1. Install the plugin: Copy WorldGuard.jar into your Bukkit server's "plugins" directory. If the folder doesn't exist, create it.
  2. Change the configuration: Run your server once (with WorldGuard) to generate the default configuration files:
    • Global configuration: A config.yml file is generated inside "plugins/WorldGuard" containing global settings that affect all worlds. There is currently only one applicable setting in this file.
    • World configurations: For each world, a config.yml will be generated inside "plugins/WorldGuard/worlds/<world>/config.yml". Edit this file to disable fire and change other world-specific settings. Each world's configuration is entirely separate from one another
  3. Use /wg reload in the console to reload the configuration.
  4. Setup the blacklist Optional: For each world folder (see above), there is a blacklist.txt file that is generated. See the wiki for information about WorldGuard's blacklist.
  5. Check out the spreadsheet: Sadly WorldGuard is not 100% complete. It's nearly there, but documentation is also currently lacking. Be sure to read the information on the checklist.

Gotcha: You need to have WorldEdit installed! It's used by WorldGuard in a number of places. If you don't want to install the plugin, that's okay — just put WorldEdit.jar into your Bukkit root folder (outside of plugins/) and WorldGuard will still be able use it.

Be sure to:

Contributing

WorldGuard is entirely open source! You can download all of the plugin code to learn from it, modify it for your own self, or even contribute back!

The code is covered under the GNU General Public License v3.

Maven information: ${groupId}/${artifactId}/${version}