Articles on: Plugin Setup

How to install and use WorldGuard [Java]

In this article, we'll learn how to install WorldGuard. Using this plugin, you can specify "regions" ( areas in the game ) and customize what you can do within the region. It's a very useful plugin to protect areas, customize gameplay experience in certain areas, and so on. Let's dive in!

Installation



To start, download the latest version of the plugin from here.
Then, drag-and-drop the jar file into the /home/container/plugins folder, on WitherPanel. Lastly, reboot the server and it should now run.

WorldGuard has a dependency of WorldEdit. Make sure you have worldedit installed, otherwise it will not work!

Configuring the plugin



Each world will have a config file, for example, worlds/world/config.yml . Your normal config.yml will be at plugins/WorldGuard/config.yml

In your config file, you'll have options to tweak a lot of the gameplay settings, such as physics ( sand falling, vines etc. ), ignition ( tnt, fires, etc. ), mobs, players damage, turtle eggs, weather & dynamics. Each config option is explained in their documentation

Blacklist configuration



In your world's folder, you'll have a blacklist.yml file. In that, you can stop certain actions. An example of a blacklist file is:

# Deny lava buckets
[lavabucket]
ignore-groups=admins,mods
on-use=deny,tell
message=Sorry, you can't use lava buckets!

# Deny some ore
[goldore,ironore]
ignore-groups=admins
on-break=deny,tell,notify

# No TNT!
[tnt]
ignore-groups=admins
on-place=deny,notify,kick


This would prevent users from using lava buckets other than admins/mods ( groups are specified according to what you set them ), denying mining ores, etc. There's full feature demonstration at this link

Setting up a region



In order to setup a region, we'll first proceed to open our wand in WorldEdit, with //wand. Then, we will select two corners where we want to specify a region.

Make sure your corners have height difference, as worldguard will take into account the height as well ( i.e. your regions won't be protected up to build height unless you make sure a corner is chosen at build height )

Then, define your region by running the command /region define <name>. ( For example, /region define region1 )
Your region should now be setup, and you can start customizing what's allowed/not allowed within this region. When you run the command /region flags <name>, a list of configurable options in the chat will appear. They are clickable items ( true/false or setting a sentence/phrase ), so interact with the settings to enable/disable the settings that you want



There's a lot of flags to go through, so take your time to navigate between the pages. A full list of explanations of each flag is here
You can also define priorities, inherit region properties from another, and so on. See here on how to do so

A very helpful list of common scenarios ( example situations where worldguard would work best ) is outlined here

As usual, the documentation for any plugin is a great place to go to if you want to dive deeper into the plugin and it's working.

Article made by vijaypondini#0001 ( ID 631466030023049217 )

Updated on: 14/06/2022

Was this article helpful?

Share your feedback

Cancel

Thank you!