MiningRewards — Overview

Overview

This guide covers MiningRewards 4.5.0: 20 reward types, creation and editing through the GUI, world and region restrictions, permissions and placed-block protection. The catalogue below keeps the exact Reward_type identifiers used in reward files.

First reward
Run /mr create example_reward. Choose the reward type, select trigger blocks, configure its values, set chance and finish the remaining conditions before saving. Use /mr list to verify the saved reward. Test in Survival on a naturally generated matching block; Creative and player-placed blocks are excluded by default.

The list supports pages and A–Z/Z–A sorting. Preview details appear in item lore with the preview permission. Left-click opens the editor. Shift + right-click arms removal, then repeat to confirm; the remove command deletes directly without this GUI confirmation. Editing does not require recreating the reward, but changing the reward type is not an editor option.

Conditions and activation
A block can match multiple rewards, each with its own chance and restrictions. The GUI accepts 0.01–100%; a file value of 0 never triggers. The per-break cap defaults to 3 successful rewards. Cooldown is checked before the reward loop, so it limits later block breaks rather than reducing the number of rewards on that same break. Cancelled break events and recursive Vein Burst events do not trigger reward processing.

Global DisabledWorlds blocks all rewards in matching worlds. A reward's DisabledWorlds list adds its own restriction. With WorldEdit and WorldGuard available, disabled regions take priority; a nonempty enabled list requires the block to be inside an enabled region. Without the integration or an available region manager, those region restrictions are not enforced. Select existing regions and loaded worlds in the GUI.

All reward types
DROP_ITEM — Drop Item
– Give the player an additional configurable item.
MULTIPLE_DROP — Multiple Drop
– Give multiple copies of the mined block's item.
GIVE_MONEY — Give Money
– Reward the player with server currency through Vault.
GIVE_LEVEL — Give Level
– Grant one or more experience levels.
GIVE_EXPERIENCE — Give Experience
– Grant a configurable amount of direct experience.
SPAWN_BONUS_CHEST — Spawn Bonus Chest
– Spawn a chest containing configured reward items.
GIVE_POTION_EFFECT — Give Potion Effect
– Apply a selected potion effect for a configured duration.
COMMAND — Command
– Execute one or more server commands when the reward activates. Supports placeholders such as %PLAYER% and %BLOCK%.
REPAIR_TOOL — Repair Tool
– Repair the tool used to mine the block.
EXPLOSION_REWARD — Explosion Reward
– Create an explosion at the mined block's location.
RENEW_BLOCK — Renew Block
– Replace the mined block with the same block type.
CYCLE_ORE — Cycle Ore
– Replace the mined block with a randomly selected configured ore.
ENCHANTMENT_REWARD — Enchantment Reward
– Add a selected enchantment and level to the player's mining tool.
GIVE_RANDOM_EFFECT — Give Random Effect
– Give the player one random effect from a configured list.
VEIN_BURST — Vein Burst
– Automatically mine connected ore blocks with configurable radius and block limits.
GOLDEN_APPLE — Golden Apple
– Apply configurable regeneration, absorption and food-related benefits based on the golden apple reward.
ORE_SMELTER — Ore Smelter
– Replace raw ore drops with ingots. Fortune, furnace experience and visual effects can be configured. Supports iron, gold, copper and ancient debris.
PROSPECTOR_PULSE — Prospector Pulse
– Scan loaded terrain for selected ores and show the player a private particle compass. Radius, duration, target ore groups, maximum target count and hidden-only mode are configurable.
MINING_SHIELD — Mining Shield
– Grant a temporary, charge-based shield with configurable charges, duration, damage reduction and visual effects. Repeated activations add charges up to a safety limit and keep the stronger protection.
AUTO_PICKUP — Auto Pickup
– Send the mined block's drops directly to the player's inventory. Optionally collect block experience instantly, choose whether excess items drop at the player or the mined block, and enable pickup effects. Includes dedicated creator and editor settings.

Special reward behaviour
Auto Pickup collects the normal drop event for the activated block, not every future mined block. CollectExperience gives that block's XP immediately; OverflowAtPlayer chooses where excess items fall. Normal drops are forced on for this reward. Other rewards that suppress normal drops can prevent collection, so test combined rewards on the same trigger block.

Mining Shield grants 1–20 charges per activation, lasts 5–600 seconds and reduces damage by 10–100%. Repeated activations combine charges up to 100 and retain the longer expiry and stronger reduction. Each eligible damage event uses one charge. VOID, SUICIDE and KILL causes are excluded. Shields clear on death, logout or plugin disable.

Prospector Pulse scans already loaded terrain: radius 4–24, 1–8 targets and duration 2–30 seconds. HiddenOnly requires enclosed ore blocks. TargetOres selects ore groups. It shows a private particle guide and boss bar, does not mine targets, and reports when nothing is found. A new activation replaces the player's previous pulse.

Vein Burst follows connected blocks of the same material, including diagonal neighbours, within radius 1–8. The effective block limit is the smaller of MaxBlocks and Safety.MaxVeinBurstBlocks and includes the original block. Extra breaks are offered to protection plugins and do not start more MiningRewards chains. It only processes loaded terrain.