For the complete documentation index, see llms.txt. This page is also available as Markdown.

Configuration Workflow

Drako Dungeons loads one validated snapshot from the entire configuration tree. A change in one file can therefore be checked against another file before anything becomes live.

Editing rules

  • Keep schema-version: 1 in every managed YAML file.

  • Use spaces, not tab characters.

  • Keep IDs lowercase and stable. Use underscores for multi-word IDs.

  • Use Bukkit/Paper enum names such as ZOMBIE, DIAMOND_SWORD, or END_ROD.

  • Menu slots are 1-based. The sword hotbar slot and companion hotbar slot are 0-based.

  • Currency references must exist in content/currencies.yml.

  • Zone stage numbers must be consecutive, starting at 1.

  • MiniMessage and familiar & color codes are supported in player-facing text.

  • Do not rename placeholders or fixed YAML keys.

Safe hot reload

Use this sequence after changing YAML:

/dga validate
/dga reload

/dga validate parses and cross-checks the candidate without changing the live server. /dga reload prepares the full candidate, publishes it, and refreshes active systems through configured tick budgets.

If validation fails, correct the path reported in chat or console and run validation again. The previous live generation remains active.

Changes that should use a restart

Use a full restart for:

  • replacing the plugin JAR;

  • installing or removing PlaceholderAPI or FastAsyncWorldEdit;

  • changing the packet entity ID starting range;

  • recovering from an incomplete reload publication;

  • restoring dungeons.db from a backup.

Configuration ownership

Directory
Purpose

settings/

Global engine, progression, visuals, setup defaults, and spawn positions

content/

Reusable gameplay catalogues and balance

zones/

World-specific areas, mobs, stages, and rewards

menus/

Inventory titles, sizes, slots, materials, names, and lore

language/messages/

Chat, action-bar, item, setup, and menu wording

language/sounds.yml

Event sound, category, volume, pitch, and enabled state

Development resets

This plugin is currently built around a clean current schema. To intentionally reset during development:

1

Stop the server

2

Back up anything you may need later

3

Delete the plugins/DrakoDungeons/ data directory

4

Start the server to generate a fresh baseline

Last updated