Skip to main content

Getting Started

This guide walks you through setting up the Graveyard plugin on your Hytale server.

1. Install the Plugin​

Place the KyuubiSoftGraveyard.jar file into your server's mods/ directory. No other mods required.

server/
  mods/
    KyuubiSoftGraveyard.jar

Optional: Install VaultUnlocked if you want players to buy premium designs and particles with in-game currency. Without it, premium items are unlocked via admin commands only.

Start the server. On first launch the plugin creates its data folder with default config, database, and template files.

2. Verify First Launch​

After the server starts, check the console for:

[Graveyard] Setting up...
[Graveyard] i18n loaded: [de-DE, en-US]
[Graveyard] Using SQLite database: .../graveyard.db
[Graveyard] Interactions registered
[Graveyard] Setup complete
[Graveyard] Started (0 gravestones loaded)

3. Folder Structure​

After the first launch, the plugin creates:

mods/kyuubisoft_graveyard/
  config/
    graveyard.json          — Main configuration
  custom-items/
    _template.json          — Template for custom gravestone designs
  images/
    gravestone_bg.png       — Loot UI background (replace to customize)
  avatar-cache/             — Cached player avatars from HyVatar
  i18n/                     — Language overrides (optional)
  graveyard.db              — SQLite database

4. Test the System​

  1. Join the server in Adventure or Survival mode
  2. Die (fall damage, /kill, etc.)
  3. A gravestone spawns at your death location
  4. Your items are stored in the gravestone
  5. Walk to the gravestone and press F
  6. The loot UI opens — click Loot All to recover your items

5. Open the Menu​

Use /ksgraveyard menu (or /grave menu) to open the Graveyard UI:

  • Gravestones — View your active gravestones with coordinates
  • Designs — Select your gravestone appearance
  • Particles — Select particle effects (if enabled)
  • Statistics — View your death statistics

6. Admin Setup​

Give Designs to Players​

/ksgraveyard design_give <player> royal
/ksgraveyard design_give <player> haunted
/ksgraveyard design_give <player> ancient

Give Particle Effects​

/ksgraveyard particle_give <player> golden_glow
/ksgraveyard particle_give <player> ghost_smoke
/ksgraveyard particle_give <player> arcane_pulse

Customize the Background Image​

Replace images/gravestone_bg.png with your own 350x497 PNG image. Restart the server.

Next Steps​