Description

RegionBoard lets you create scoreboards for specific regions or areas in your world. These scoreboards will track various statistics for everyone within the region, but not outside the region.

For example, you can create a fishing scoreboard around a lake. When players enter the region, the scoreboard will be displayed and if they catch fish, their score will go up. When they leave the region, the scoreboard will disappear.

The plugin also lets you define an auto-reset time for each scoreboard, and a reward (xp points) that the top players may receive just before the scoreboard is reset. With this mechanism, you can create automated mini-arenas or mini-games, or just interesting areas around the spawn of you world.

This plugin only works with WorldGuard at the moment.

Setting up region boards

Setting up a region board involves adding or using existing WorldGuard regions. Once you identified or created the regions with WorldGuard, you may use the in-game commands of the RegionBoard plugin to associate region boards with the regions.

For example, the following steps show how to setup an automated fishing competition around a lake:

Use WorldEdit's wand to select the area of the lake
It is recommended to type //expand vert to select the entire vertical space between the two points
Define a WorldGuard region by typing /region define lake
Add the region board by typing: /regionboard add lake FISH_CAUGHT &cTop_Fisher
Setup a 60 seconds autoreset mechanism for this board by typing: /regionboard autoreset lake 60 10

That’s it! The XP reward in this case will be 10 xp points (please mind the difference between XP points and XP levels).

Note that if you already have WorldGuard regions (e.g. spawn), you don’t need to redefine them. Just use the region board commands.

Supported statistics

DEATHS
MOB_KILLS
PLAYER_KILLS
FISH_CAUGHT
ANIMALS_BRED
TREASURE_FISHED
JUNK_FISHED
MINE_BLOCK(:block_name)
USE_ITEM(:entity_name)
KILL_ENTITY(:entity_name)
ENTITY_KILLED_BY(:entity_name)

By adding the sub-statistic after the main statistic (separated by a colon), you may track specific events, for example:

MINE_BLOCK:DIAMOND_ORE - Tracks the number of diamond ore mined by the player.
USE_ITEM:FLINT_AND_STEEL - Tracks the number of times flint and steel was used by a player.
KILL_ENTITY:CHICKEN - Tracks the number of chickens killed by the player.
ENTITY_KILLED_BY:ZOMBIE - Tracks the number of times a player was killed by a zombie.

The statistic will only be tracked if the associated player is within the region.

Commands

There is one admin command: /regionboard with several options:

/regionboard version - Print the version of the plugin.
/regionboard list - List all region boards.
/regionboard add <region-id> <stat> <display-name> - Add a region board. The region ID must be the ID of a WorldGuard region. The <stat> parameter must be a valid statistic tracked by the plugin (e.g. MOB_KILLS), and the display-name can be a color-coded string, where underscores are used for spaces (e.g. &dTop_Killer).
/regionboard remove <region-id> - Remove a region board (note: this does not remove the WorldGuard region).
/regionboard info <region-id> - Print the info associated with the region.
/regionboard reset <region-id> - Reset all scores tracked by the region.
/regionboard autoreset <region-id> <time-secs> [xp-points] - Start the auto reset mechanism for the region. The XP points parameter is optional.

Permissions

regionboard.admin - Lets you use the RegionBoard plugin admin command (ops only by default)
regionboard.seewinmsg - Lets you see the auto reset winner announcement (everyone by default)

Source Code and API

The source code is available here:

https:github.com/eyalzh/regionboard

The plugin emits three events, which allow expanding and changing the default behaviour of the plugin:

PlayerEntersRegion - Fired when a player enters a region with a board
PlayerLeavesRegion - Fired when a player leaves a region with a board
RegionAutoResetEvent - Fired when a board is being auto reset and a reward is about to be given (cancellable).