WorldGuard

From Nitradopedia EN
Jump to: navigation, search
WorldGuard
Pluginlogo-WorldGuard.png
Servermod: Bukkit‎
Category: Protection
Developer: sk89q
Developer Website: sk89q.com/
Description: Enables you to protect the world and regions
Features: Provides a lot of configuration possibilities
Download: Link

This is a plugin for Bukkit and serves to protected your world (multiple worlds possible!). There are endless configuration possiblities, e.g. prevent fire outbreaks, stop creepers from exploding, protect build regions, ... .

Alternatives
Indirect, but not in the same extend. Therefore this plugins is recommended due to its functions and qualities.

More information


Installation

Important, before you install WorldGuard, WorldEdit  must be installed! [WorldEdit].


Schritt 1 - Download WorldGuard
Firstly, download the latest Version of WorldGuard.


Schritt 2 - Extract WorldGuard
Now you need to extract the .zip file. After a successful extraction, you can find 4 files. "blacklist_table.sql", "LICENSE.txt", "README.html", "WorldGuard.jar".


Schritt 3 - Install WorldGuard
Stop your server. After the server was stopped, move the "WorldGuard.jar" into the plugins folder. Start your server again. A folder called "WorldGuard" (in the plugins folder) should be created. In the folder you can find the file "config.yml" and a folder "worlds". The fodler "worlds" contains at least one folder named after your world. If you have multiple worlds, there will be multiple folders. Every folder contains "blacklist.txt", "config.yml" and "regions.yml".


Installation complete


Global Configuration

File /minecraftbukkit/plugins/WorldGuard/config.yml
Everything entered here, will take on all worlds. Should a world have a "config.yml", the world-specific one will override the global one.

For information on what each option does in detail, please look here

World-specific Configuration

File/minecraftbukkit/plugins/WorldGuard/[WORLD]/config.yml
The settings are the same as in the global config. For example, you can disable mob damage in only one specific world.

Blacklist.txt

Information

File /minecraftbukkit/plugins/WorldGuard/[WORLD]/blacklist.txt
Every world has a blacklist.txt. In this blacklist you can deny the following:

  • Prevents certain groups from breaking a specific block (e.g. Stone)
  • Prevents certain groups from using a specific to break a block
  • Prevents certain groups from placing a specific block
  • Prevents certain groups from using a specific item (e.g. Flint and Steel, Buckets, TNT, etc.)
  • Prevents certain groups from interacting with a specific item (e.g. Chests, Furnaces, Buttons, etc.)
  • Allows certain groups to drop a specific items
  • Allows certain groups to pick up a specific items
  • Prevents certain groups from eating a specific food (e.g. Cookies, Apples, etc.)

Sample Configuration

[ITEM-ID]            | Item-ID, see http://wiki.nitrado.net/index.php/ItemID
on-place=deny        | Option = Action (see below)

This is the smallest config possible
Another one:

[ITEM-ID]            | Item-ID, see http://wiki.nitrado.net/index.php/ItemID
ignore-groups=Gruppe | Which groups should be ignored = Groupname
on-place=deny        | Option = Action (see below)
message=Text         | Message sent to player

Options and Actions

Options

Possible Options are:

ignore-groups=
ignore-perms=
comment=
message=
on-break=
on-destroy-with=
on-place=
on-use=
on-interact=
on-drop=
on-acquire=


Actions

Actions can be defined after the equals sign (=) E.g. on-use=deny
Possible Actions are:

deny
notify
log
tell
kick

Sample Config

Example 1

# No TNT!
[46]
ignore-groups=Admin
on-place=deny,tell,notify
on-break=deny,tell,notify
on-acquire=deny,tell,notify
on-drop=deny,tell,notify
message=TNT is forbidden!

Here TNT is prohibited, it is not possible to place, break, drop or pick up. The player gets the message "TNT is forbidden!".

Example 2

# No Flint and Steel!
[259]
ignore-groups=Admin
on-use=deny,tell
message=Flint and Steel is forbidden!

Here Flint and Steel is prohibited to use and the player gets the message "Flint and Steel is forbidden!".
More information about Blacklist

Permission-Nodes

How Permission-Nodes can be used, can be read here -> Permissions

worldguard.god
worldguard.god.other
worldguard.ungod
worldguard.ungod.other
worldguard.heal
worldguard.heal.other
worldguard.slay
worldguard.slay.other
worldguard.locate
worldguard.stack
worldguard.region.define
worldguard.region.redefine
worldguard.region.claim
worldguard.region.select
worldguard.region.info
worldguard.region.list
worldguard.region.flag
worldguard.region.setpriority
worldguard.region.setparent
worldguard.region.remove
worldguard.region.addmember
worldguard.region.addowner
worldguard.region.removemember
worldguard.region.removeowner
worldguard.fire-toggle.stop
worldguard.reload
worldguard.report



<spoiler text="Example for Permissions">

groups:
  Owner:
    permissions:
    - worldguard.*
  Admins:
    permissions:
    - worldguard.*
  Moderator:
    permissions:
    - worldguard.god
    - worldguard.god.other
    - worldguard.ungod
    - worldguard.ungod.other
    - worldguard.heal
    - worldguard.heal.other
    - worldguard.slay
    - worldguard.slay.other
    - worldguard.locate
    - worldguard.region.info
    - worldguard.region.list
    - worldguard.reload
    - worldguard.report
  Supporter:
    permissions:
    - worldguard.heal
    - worldguard.slay.other
    - worldguard.region.info  
  VIP:
    permissions:
    - worldguard.heal  
  Player:
    permissions:
  Guest:
    permissions:
  
users:

</spoiler>


More information about WorldGuard Permissions

Usage

Define Regions

To protect your building you need to create a region first.

  1. Type //wand, to get the selction tool for WorldEdit.
  2. Now you select the region you want to protect. This works with right and left clicks.
    WorldEdit-Cuboid.png
  3. Having selected a region, you can type /region define [ID] to create the region.



A detailed tutorial about how to select a region can be found here -> WorldEdit

Define Parents

You got a protected city? But your members should be able to build on their plot in your city? Heres how::

You got the regions "City", "Plot1" and "Plot2". The players are not allowed to build in your city. In order that the player can build on his plot, you need to type /region setparent Plot1 City. "City" is the "parent" and "Plot1" the child.
Make sure, that the parent is the second attribute, so /region setparent <Child> <Parent>


More information


Flags

Explanation

Flags are specific settings for regions. You can adjust them for every region individually. If you want to select the whole world, use "__global__" as region.

How to use Flags

To apply flags you need to define a region.
The command to set flags is:
/region flag [ID] [FLAG] [SETTING]
Possible flags can be found below

Examples

/region flag Townhall build deny
You are now unable to build in the region Townhall.
/region flag Townhall tnt deny TNT won't explode in the Townhall.
/region flag Townhall greeting Welcome to the Townhall! If you enter the Townhall, you get the message Welcome to the Townhall!.

Settings

passthrough
build
pvp
mob-damage
mob-spawning
creeper-explosion
ghast-fireball
sleep
tnt
ligther
fire-spread
lava-fire
lightning
chest-access
water-flow
lava-flow
use
vehicle-place
snow-fall
leaf-decay
greeting
farewell
notify-enter
notify-leave
deny-spawn
heal-delay
heal-amount
allowed-cmds
blocked-cmds
spawn
spawn-group
entry
entry-group
exit
exit-group


More information

About this Article

This tutorial is based on plugin version : 5.0.0
This tutorial was translated by: Facekuli This tutorial was translated on: 17.02.2014
This tutorial was originally created by: StClaus This tutorial was originally created on: 28.08.2011
Last updated by: Facekuli Last update on: 17.02.2014