Skip to content

Installation.md

Jump to bottom
Fragmer2 edited this page Apr 8, 2026 · 6 revisions

Installation Guide

Requirements

   
Minecraft Java Edition 1.18 or newer (including 26.1 / 26.1.1)
Server software Spigot · Paper · Purpur · Pufferfish · Folia
Java 17 or newer

Step 1 — Download

Get the latest SpawnChestPlugin-X.X.X.jar from any of these:

Step 2 — Install

  1. Stop the server
  2. Copy the JAR into your plugins/ folder
  3. Start the server

Step 3 — First Launch

On first start the plugin generates all its files automatically:

plugins/SpawnChestPlugin/
├── config.yml          Main configuration
├── custom_loot.yml     Custom loot tables (managed by GUI)
├── timer.txt           Spawn timer state
├── statistics.yml      Player statistics
└── lang/
    ├── en.yml
    ├── ru.yml
    ├── ua.yml
    ├── es.yml
    ├── de.yml
    ├── fr.yml
    ├── zh.yml
    ├── pt.yml
    ├── pl.yml
    └── it.yml

Step 4 — Configure

Open plugins/SpawnChestPlugin/config.yml and set the basics:

language: en    # en  ru  ua  es  de  fr  zh  pt  pl  it

settings:
spawn-interval-seconds: 14400   # 4 hours between chests
chest-count-per-interval: 1     # how many chests per spawn
chest-disappear-minutes: 30


spawn-zone:
min-distance: 400
max-distance: 2000


enabled-worlds:
- "world"

Step 5 — Apply Changes

/reloadchestconfig

Step 6 — Test

/chestnow          # spawn a chest immediately
/testchestzone     # preview 5 random spawn coordinates
/nextchest         # check time until next scheduled spawn

Step 7 — Set Up Custom Loot (Optional)

/putintothechest

Drag items into the GUI, set the drop rate, and click Save. No YAML editing required.

Verification Checklist

  1. Console shows [SpawnChest] SpawnChestPlugin v4.4 enabled.
  2. /chestnow spawns a chest
  3. Chest contains loot when opened
  4. /nextchest shows a countdown

Updating

  1. Stop the server
  2. Back up plugins/SpawnChestPlugin/
  3. Replace the old JAR with the new one
  4. Start the server

Config files are always preserved between updates. New config keys are added automatically with their defaults on first run after an update.

Recommended Optional Setup

LuckPerms — notification permissions

On servers where all permissions are denied by default, grant the notify nodes to the default group so players see chest announcements:

/lp group default permission set spawnchest.notify.spawn true
/lp group default permission set spawnchest.notify.coordinates true
/lp group default permission set spawnchest.notify.countdown true
/lp group default permission set spawnchest.notify.disappear true
/lp group default permission set spawnchest.notify.bossbar true

BossBar

Disabled by default. Enable in config and restart or reload:

features:
  bossbar:
    enabled: true

Protection plugins (WorldGuard, GriefPrevention, GriefDefender, Lands)

No setup needed — the plugin detects them automatically at startup and skips claimed/protected locations when searching for spawn coordinates.

Troubleshooting

Chest doesn't spawn with /chestnow

  • Check console for errors
  • Run /testchestzone to verify zone coordinates look valid
  • Make sure your world is listed in enabled-worlds

Plugin fails to load

  • Java version? Run java -version in terminal — must be 17+
  • Re-download the JAR in case it's corrupted

Players don't see announcements

  • Grant spawnchest.notify.spawn to the default group (see LuckPerms section above)

Next Steps

# Installation Guide

Requirements
Minecraft Java Edition 1.18 or newer (including 26.1 / 26.1.1)
Server software Spigot · Paper · Purpur · Pufferfish · Folia
Java 17 or newer

Step 1 — Download

Get the latest SpawnChestPlugin-X.X.X.jar from any of these:

Step 2 — Install

  1. Stop the server
  2. Copy the JAR into your plugins/ folder
  3. Start the server

Step 3 — First Launch

On first start the plugin generates all its files automatically:

plugins/SpawnChestPlugin/
├── config.yml          Main configuration
├── custom_loot.yml     Custom loot tables (managed by GUI)
├── timer.txt           Spawn timer state
├── statistics.yml      Player statistics
└── lang/
    ├── en.yml
    ├── ru.yml
    ├── ua.yml
    ├── es.yml
    ├── de.yml
    ├── fr.yml
    ├── zh.yml
    ├── pt.yml
    ├── pl.yml
    └── it.yml

Step 4 — Configure

Open plugins/SpawnChestPlugin/config.yml and set the basics:

language: en    # en  ru  ua  es  de  fr  zh  pt  pl  it

settings:
  spawn-interval-seconds: 14400   # 4 hours between chests
  chest-count-per-interval: 1     # how many chests per spawn
  chest-disappear-minutes: 30

  spawn-zone:
    min-distance: 400
    max-distance: 2000

  enabled-worlds:
    - "world"

Step 5 — Apply Changes

/reloadchestconfig

Step 6 — Test

/chestnow          # spawn a chest immediately
/testchestzone     # preview 5 random spawn coordinates
/nextchest         # check time until next scheduled spawn

Step 7 — Set Up Custom Loot (Optional)

/putintothechest

Drag items into the GUI, set the drop rate, and click Save. No YAML editing required.

Verification Checklist

  1. Console shows [SpawnChest] SpawnChestPlugin v4.4 enabled.
  2. /chestnow spawns a chest
  3. Chest contains loot when opened
  4. /nextchest shows a countdown

Updating

  1. Stop the server
  2. Back up plugins/SpawnChestPlugin/
  3. Replace the old JAR with the new one
  4. Start the server

Config files are always preserved between updates. New config keys are added automatically with their defaults on first run after an update.

Recommended Optional Setup

LuckPerms — notification permissions

On servers where all permissions are denied by default, grant the notify nodes to the default group so players see chest announcements:

/lp group default permission set spawnchest.notify.spawn true
/lp group default permission set spawnchest.notify.coordinates true
/lp group default permission set spawnchest.notify.countdown true
/lp group default permission set spawnchest.notify.disappear true
/lp group default permission set spawnchest.notify.bossbar true

BossBar

Disabled by default. Enable in config and restart or reload:

features:
  bossbar:
    enabled: true

Protection plugins (WorldGuard, GriefPrevention, GriefDefender, Lands)

No setup needed — the plugin detects them automatically at startup and skips claimed/protected locations when searching for spawn coordinates.

Troubleshooting

Chest doesn't spawn with /chestnow

  • Check console for errors
  • Run /testchestzone to verify zone coordinates look valid
  • Make sure your world is listed in enabled-worlds

Plugin fails to load

  • Java version? Run java -version in terminal — must be 17+
  • Re-download the JAR in case it's corrupted

Players don't see announcements

  • Grant spawnchest.notify.spawn to the default group (see LuckPerms section above)

Next Steps

Clone this wiki locally