Getting Started

Installation


This plugin requires worldguard, make sure it is installed and enabled.


Although not required, the following plugins will add more features:

  • RespawnBlocks: unlock new blocks and decrease their respawn duration with upgrades.

  • MythicMobs: unlock custom mobs, decrease their respawn time or improve their level with upgrades.


Create a profile

A resource zone is managed by a profile. First you need to create one and then you can add upgrades.


/rz profile create <name>


Add upgrades

You can add multiple type of upgrades to a profile, each upgrade also has a price to unlock it. Upgrades with a price of 0 will be automatically unlocked.


Expansion

Each profile needs at least one expansion. This will enable a region for your profile.

/rz profile upgrade add expansion <profile> <name> <region> <price>

Hint: you can put <name> between “quotes” to add spaces.


Block

If you have RespawnBlocks enabled you can add a block upgrade which unlocks the block.

/rz profile upgrade add block <profile> <name> <type> <duration> <price>


Mob

If you have MythicMobs enabled you can only use their mobs, if not the plugin will fallback to vanilla mobs.

/rz profile upgrade add mob <profile> <name> <mob> <duration> <price>


Mob spawn

Before mobs will spawn, you must define spawn locations. Only spawns in an unlocked expansion upgrade will be active.

/rz profile upgrade spawn add <profile> <upgrade>

Each upgrade has a unique id, for <upgrade> you must enter the id of a mob upgrade.


Time

A time upgrade can be used to decrease a block or mob respawn duration, or both.

/rz profile upgrade add time <profile> <name> <upgrade> <duration> <price>


To decrease the time of ALL mob and block upgrades remove the <upgrade> parameter.

/rz profile upgrade add time <profile> <name> <duration> <price>


Level

A level upgrade will improve a mob upgrade. In the case of MythicMobs, this will improve the mob level. For vanilla mobs this will multiply the amount of dropped experience.

/rz profile upgrade add level <profile> <name> <upgrade> <levels> <price>

You must enter a mob upgrade id for the <upgrade> parameter.



Upgrade dependencies

You can make upgrades depend on other upgrades. This is useful if you want a linear upgrade path. For example, you can only unlock iron ore after you’ve unlocked coal ore, and you can only unlock gold ore after you’ve already unlocked iron ore.


To make <upgrade1> depend on <upgrade2>:

/rz profile upgrade dependency add <upgrade1> <upgrade2>

You must enter the upgrade ids for each upgrade parameter.


Hint: upgrades with price 0 will automatically unlock when all their dependencies are also unlocked.


Profile information

With the following command you can view all upgrades in a profile and their dependencies. The color green indicates that the upgrade is unlocked while red indicates that the upgrade is not.

/rz profile info <profile>


Profile menu

Players can view unlocked upgrades and buy available upgrades in the upgrade menu. This menu can be opened with:

/rz profile menu <profile>