Table of Contents
Lootable chests are a great way to reward RPG players for exploring your world. They spawn around players in specific regions with randomly generated loot. Loot chests can have tiers; the higher the tier, the better the loot.
The following config samples can be found under MMOCore/loot-chests.yml
General options
These options can be found under the main plugin config file.
loot-chests:
# Time in seconds it takes for a loot chest to
# expire after it was spawned. 600 is 10 minutes.
chest-expire-time: 600
# Interval in seconds before the same player
# spawns two loot chests in ANY region.
player-cooldown: 600
Loot chest regions
MMOCore lets you setup regions where chests can spawn. The first thing you will need to define is the region boundaries just like with WorldGuard regions:
loot-chest-region-id:
# Region boundaries
bounds:
world: world_name_here
x1: 32
x2: -15
z1: -419
z2: -375
The loot-chest-region-id only serves as an internal identifier. It can be anything, just make sure two regions do not share the same ID when editing the configs.
You will then need to define how frequent chests spawn in that region (period is given in seconds, it's set to 120 by default which corresponds to 2 minutes).
loot-chest-region-id:
spawn-period: 120
Every X minutes, the region will look for a random player in that region and spawn a chest nearby. Keep in mind that MMOCore will first filter the players which are still on cooldown: that means no chest will spawn in a specific region, if and only if there are either no player in that region/all the players are on cooldown.
Loot Chest Tiers
Chest tiers directly determine the loot chest drops. Every tier has a set chance to be chosen when a loot chest is spawned in a region.
loot-chest-region-id:
tiers:
# Some tier
normal:
# Particle effect played around a spawned loot chest
effect:
type: OFFSET # Type of particle effect used
particle: FLAME # Particle used to play the effect
period: 60 # Plays the effect every 60 ticks
chance: 0.9
drops:
items:
- 'vanilla{type=DIAMOND} 1 1-10 8'
- 'vanilla{type=GOLD_INGOT} 0.5 1-10 4'
- 'vanilla{type=EMERALD} 0.5 1-10 4'
# Some other tier
rare:
effect:
type: HELIX
particle: FIREWORKS_SPARK
period: 80
chance: 0.1
capacity: 10
drops: drop-table-id
Every tier has its own particle effect that will be displayed around the loot chest block every X ticks (it corresponds to the period option), until it is opened/it expires. A particle effect is defined by its type (the shape or figure the particle will draw) and the particle used (flame, firework, water, etc. particles).
Available particle types are HELIX, OFFSET and GALAXY. Available particle names can be found over the Spigot Javadocs.
chance is the probability for the tier to be chosen when a loot chest is spawned. All of the tier chances should add up to 1 (10% chance is 0.1).
drops is the drop table used to fill the loot chest inventory, along with capacity which is the chest capacity. For more information about how loot table capacity works, please refer to this [wiki section](Drop Tables#capacity-and-drop-item-weight). You can either directly specify a number using capacity: 10 or use a scaling formula instead like this:
capacity:
base: 10 # Base value of 10 capacity
scale: 3 # 3 extra capacity for every player level
spread: 0.1 # +/-10% spread in average
max-spread: 0.3 # Relative offset due to the 'spread' option cannot be greater than 30%
The spread and max-spread options are optional if you're using a scaling formula for the loot capacity.
For the drops option, do note that you can either specify a drop table ID if your drop table is already setup in your drop tables config folder, or an entire config section if you want to define a new drop table specifically for the chest tier.