Skip to content

Configuration.md

Jump to bottom
Fragmer2 edited this page Feb 3, 2026 · 4 revisions

⚙️ Configuration Guide

Configuration File Location

/plugins/SpawnChestPlugin/config.yml

Auto-Generation

The config file is created automatically on first run with all default values.

Language Settings

language

Type: String
Default: "en"
Options: en, ru, ua, es, de, fr, zh, pt, pl, it

Description: Plugin language for all messages

language: "en"

Change to Russian:

language: "ru"

Reload: /reloadchestconfig

Spawn Settings

settings.spawn-interval-seconds

Type: Integer
Default: 600 (10 minutes)
Range: 60 - 86400

Description: Time between chest spawns in seconds

settings:
  spawn-interval-seconds: 600

Examples:

spawn-interval-seconds: 300   # 5 minutes
spawn-interval-seconds: 1800  # 30 minutes
spawn-interval-seconds: 3600  # 1 hour

Live change: /setchesttimer 300

settings.enabled-worlds

Type: List
Default: Empty (all worlds)

Description: Worlds where chests can spawn. Empty = all worlds.

settings:
  enabled-worlds:
    - "world"
    - "world_nether"
    - "world_the_end"

Disable nether/end:

settings:
  enabled-worlds:
    - "world"

All worlds:

settings:
  enabled-worlds: []

settings.chest-disappear-minutes

Type: Integer
Default: 30
Range: 0 (never) - 1440

Description: Minutes until unopened chest despawns. 0 = never.

settings:
  chest-disappear-minutes: 30

Never despawn:

settings:
  chest-disappear-minutes: 0

Spawn Zone Settings

settings.spawn-zone.min-distance

Type: Integer
Default: 400

Description: Minimum distance from 0,0 (spawn)

settings:
  spawn-zone:
    min-distance: 400

settings.spawn-zone.max-distance

Type: Integer
Default: 2000

Description: Maximum distance from 0,0

settings:
  spawn-zone:
    max-distance: 2000

Small area (testing):

min-distance: 100
max-distance: 500

Large area (big server):

min-distance: 1000
max-distance: 10000

settings.spawn-zone.min-distance-from-center

Type: Integer
Default: 100

Description: Absolute minimum from 0,0 (safety zone)

settings:
  spawn-zone:
    min-distance-from-center: 100

Purpose: Prevents chests spawning at exact spawn point

settings.spawn-zone.min-height

Type: Integer
Default: 50

Description: Minimum Y level for chest spawn

settings:
  spawn-zone:
    min-height: 50

settings.spawn-zone.max-height

Type: Integer
Default: 200

Description: Maximum Y level for chest spawn

settings:
  spawn-zone:
    max-height: 200

Only surface (no caves):

min-height: 60
max-height: 100

settings.spawn-zone.bury-in-ground

Type: Boolean
Default: false

Description: Chest replaces ground block (buried) vs placed on top

settings:
  spawn-zone:
    bury-in-ground: false

Buried chest:

bury-in-ground: true

Chest Tier Chances

settings.chest-chances.common

Type: Decimal
Default: 0.50 (50%)

Description: Probability of Common chest spawning

settings:
  chest-chances:
    common: 0.50

settings.chest-chances.rare

Type: Decimal
Default: 0.35 (35%)

Description: Probability of Rare chest spawning

settings:
  chest-chances:
    rare: 0.35

settings.chest-chances.legendary

Type: Decimal
Default: 0.15 (15%)

Description: Probability of Legendary chest spawning

settings:
  chest-chances:
    legendary: 0.15

Must total: Can be any sum (plugin auto-calculates)

Examples:

# More legendary
common: 0.30
rare: 0.30
legendary: 0.40

# Rare only
common: 0.00
rare: 1.00
legendary: 0.00

# Equal chance
common: 0.33
rare: 0.33
legendary: 0.34

Feature Toggles

features.guardians.enabled

Type: Boolean
Default: true

Description: Spawn guardian mobs to protect chests

features:
  guardians:
    enabled: true

Command: /togglefeature guardians

features.guardians.common-count

Type: Integer
Default: 2

Description: Number of guardians for Common chest

features:
  guardians:
    common-count: 2

features.guardians.rare-count

Type: Integer
Default: 3

Description: Number of guardians for Rare chest

features:
  guardians:
    rare-count: 3

features.guardians.legendary-count

Type: Integer
Default: 5

Description: Number of guardians for Legendary chest

features:
  guardians:
    legendary-count: 5

features.effects.particles

Type: Boolean
Default: true

Description: Particle effects around chests

features:
  effects:
    particles: true

Command: /togglefeature particles

features.effects.sounds

Type: Boolean
Default: true

Description: Sound effects for abilities and chests

features:
  effects:
    sounds: true

Command: /togglefeature sounds

features.effects.lightning-on-legendary

Type: Boolean
Default: true

Description: Lightning strike when Legendary chest spawns

features:
  effects:
    lightning-on-legendary: true

features.effects.chest-beacon-beam

Type: Boolean
Default: true

Description: Vertical beam effect above chest

features:
  effects:
    chest-beacon-beam: true

features.broadcasts.chest-spawn-announcement

Type: Boolean
Default: true

Description: Broadcast message when chest spawns

features:
  broadcasts:
    chest-spawn-announcement: true

Message example:

🎁 Legendary Chest has spawned at: X: 825 Y: 64 Z: -1456

features.broadcasts.title-on-spawn

Type: Boolean
Default: true

Description: Title notification on screen

features:
  broadcasts:
    title-on-spawn: true

features.broadcasts.countdown-warnings

Type: Boolean
Default: true

Description: Warnings before chest spawns (10 min, 5 min, etc.)

features:
  broadcasts:
    countdown-warnings: true

features.broadcasts.resurrection-announcement

Type: Boolean
Default: true

Description: Broadcast when Phoenix Feather resurrects player

features:
  broadcasts:
    resurrection-announcement: true

features.broadcasts.achievement-announcement

Type: Boolean
Default: true

Description: Broadcast when player unlocks achievement

features:
  broadcasts:
    achievement-announcement: true

Ability Settings

abilities.pvp-protection

Type: Boolean
Default: true

Description: Legendary items don't work on players

abilities:
  pvp-protection: true

False = items work in PvP

abilities.show-cooldown-messages

Type: Boolean
Default: true

Description: Show "recharging..." messages

abilities:
  show-cooldown-messages: true

abilities.show-activation-messages

Type: Boolean
Default: true

Description: Show "activated!" messages

abilities:
  show-activation-messages: true

Legendary Items

legendary-items.enabled

Type: Boolean
Default: true

Description: Master toggle for ALL legendary items

legendary-items:
  enabled: true

Command: /togglelegendary

Individual Item Settings

Each legendary item has these settings:

legendary-items:
  dragon-slayer-sword:
    enabled: true
    bonus-damage: 4.0
    cooldown-ms: 3000
    fire-duration-ticks: 100
    drop-in-chests: true

enabled

Type: Boolean
Default: true
Description: Enable/disable this specific item

drop-in-chests

Type: Boolean
Default: true
Description: Can spawn in chests

cooldown-ms

Type: Integer
Unit: Milliseconds
Description: Cooldown between ability uses

Examples:

cooldown-ms: 1000   # 1 second
cooldown-ms: 5000   # 5 seconds
cooldown-ms: 30000  # 30 seconds

Dragon Slayer Sword

legendary-items:
  dragon-slayer-sword:
    enabled: true
    bonus-damage: 4.0        # Extra damage on hit
    cooldown-ms: 3000        # 3 second cooldown
    fire-duration-ticks: 100 # 5 seconds of fire
    drop-in-chests: true

Master Pickaxe

legendary-items:
  master-pickaxe:
    enabled: true
    cooldown-ms: 1000
    auto-smelt: true          # Iron ore → ingot
    double-drop-chance: 0.5   # 50% chance for 2x
    drop-in-chests: true

Titan Axe

legendary-items:
  titan-axe:
    enabled: true
    bonus-damage: 3.0
    combat-cooldown-ms: 4000  # Combat mode
    tree-cooldown-ms: 6000    # Tree felling mode
    tree-felling: true        # Enable tree ability
    drop-in-chests: true

Guardian Bow

legendary-items:
  guardian-bow:
    enabled: true
    cooldown-ms: 2000
    double-shot: true         # Fire 2 arrows
    homing-arrows: true       # Arrows track targets
    homing-range: 5.0         # 5 block radius
    drop-in-chests: true

Void Shovel

legendary-items:
  void-shovel:
    enabled: true
    cooldown-ms: 5000
    area-dig-enabled: true    # 3x3 digging
    area-size: 3              # 3x3 area
    auto-collect: true        # Items to inventory
    drop-in-chests: true

Storm Hammer

legendary-items:
  storm-hammer:
    enabled: true
    bonus-damage: 5.0
    area-damage: true         # Enable AOE
    area-damage-amount: 4.0   # 4 damage to nearby
    area-damage-radius: 3.0   # 3 block radius
    lightning-effect: true    # Visual lightning
    cooldown-ms: 8000
    drop-in-chests: true

Poseidon's Trident

legendary-items:
  poseidon-trident:
    enabled: true
    rain-radius: 5            # Rain particle radius
    lightning-on-hit: true    # Lightning when hitting
    lightning-damage: 6.0
    cooldown-ms: 10000
    drop-in-chests: true

Phoenix Feather

legendary-items:
  phoenix-feather:
    enabled: true
    resurrection: true             # Auto-revive on death
    fire-immunity-passive: true    # Fire resist while holding
    full-heal-on-resurrect: true   # Full HP on revive
    cooldown-ms: 300000            # 5 minutes (not used)
    drop-in-chests: true

Wisdom Book

legendary-items:
  wisdom-book:
    enabled: true
    drop-in-chests: true

Note: No configurable settings (fixed enchantment list)

Summoner Apple

summoner-apple:
  enabled: true
  drop-in-chests: true
  drop-chance: 0.05  # 5% in legendary chests

Custom Potions

custom-potions:
  enabled: true
  
  potions:
    strength-3:
      enabled: true
      duration-seconds: 120      # 2 minutes
      drop-in-rare: true
      drop-in-legendary: true
    
    haste-2:
      enabled: true
      duration-seconds: 180      # 3 minutes
      drop-in-rare: true
      drop-in-legendary: true
    
    luck-2:
      enabled: true
      duration-seconds: 300      # 5 minutes
      drop-in-rare: false
      drop-in-legendary: true
    
    dolphins-grace:
      enabled: true
      duration-seconds: 180
      drop-in-rare: true
      drop-in-legendary: true
    
    turtle-master-extended:
      enabled: true
      drop-in-rare: false
      drop-in-legendary: true
    
    wither-resistance:
      enabled: true
      drop-in-rare: false
      drop-in-legendary: true

Loot Categories

loot.basic-items.enabled

Type: Boolean
Default: true

loot:
  basic-items:
    enabled: true
    common-count: 3
    rare-count: 5
    legendary-count: 8

loot.weapons-and-armor.enabled

Type: Boolean
Default: true

loot:
  weapons-and-armor:
    enabled: true
    enchant-in-rare: true
    enchant-in-legendary: true

loot.tools.enabled

Type: Boolean
Default: true

loot:
  tools:
    enabled: true
    enchant-chance: 0.7  # 70%

loot.potions.enabled

Type: Boolean
Default: true

loot:
  potions:
    enabled: true

loot.food.enabled

Type: Boolean
Default: true

loot:
  food:
    enabled: true

loot.unique-items.enabled

Type: Boolean
Default: true

Description: Beacons, Elytras, Conduits, etc.

loot:
  unique-items:
    enabled: true

Enchantments

enchantments:
  common-max-level: 3
  rare-max-level: 5
  legendary-max-level: 6

Description: Maximum enchantment levels for each tier

Statistics

statistics:
  enabled: true
  
  achievements:
    enabled: true
    
    list:
      first-chest:
        xp-reward: 100
      
      treasure-hunter:
        xp-reward: 500
      
      chest-master:
        xp-reward: 1000
      
      legendary-finder:
        xp-reward: 2000
      
      guardian-slayer:
        xp-reward: 1500

Proximity Sounds

proximity-sounds:
  enabled: true
  sound: "BLOCK_NOTE_BLOCK_CHIME"
  max-distance: 50
  min-distance: 5
  interval-ticks: 40  # Every 2 seconds

Description: Sound plays near unopened chests

Configuration Examples

Beginner-Friendly Server

settings:
  spawn-interval-seconds: 300  # 5 min (frequent)
  chest-chances:
    common: 0.70
    rare: 0.25
    legendary: 0.05

features:
  guardians:
    enabled: false  # No guardians
    
legendary-items:
  enabled: true  # Keep items enabled

abilities:
  pvp-protection: true  # Safe PvP

Hardcore Server

settings:
  spawn-interval-seconds: 3600  # 1 hour (rare)
  chest-disappear-minutes: 10   # Fast despawn
  
  chest-chances:
    common: 0.10
    rare: 0.30
    legendary: 0.60  # Mostly legendary
    
features:
  guardians:
    enabled: true
    common-count: 5
    rare-count: 10
    legendary-count: 20  # Army of guardians
    
legendary-items:
  dragon-slayer-sword:
    bonus-damage: 10.0  # Very strong
    cooldown-ms: 10000  # Long cooldown
    
abilities:
  pvp-protection: false  # PvP enabled

Event Server

settings:
  spawn-interval-seconds: 120  # 2 minutes (spam)
  chest-disappear-minutes: 5   # Quick despawn
  
  chest-chances:
    common: 0.00
    rare: 0.00
    legendary: 1.00  # Only legendary
    
summoner-apple:
  enabled: true
  drop-chance: 0.5  # 50% chance

features:
  broadcasts:
    title-on-spawn: true
    chest-spawn-announcement: true

Validation

After editing config:

  1. Save file
  2. Run: /reloadchestconfig
  3. Check console for errors
  4. Test: /chestnow

Common errors:

  • Invalid YAML syntax (indentation)
  • Typos in material names
  • Invalid number ranges
  • Missing quotes on strings

Backup

Before major changes:

cp config.yml config.yml.backup

Restore:

cp config.yml.backup config.yml

Reset to Defaults

  1. Stop server
  2. Delete config.yml
  3. Start server (auto-generates default)

Clone this wiki locally