SinceDungeon Documentation

Editor

SinceDungeon includes an in-game editor for admins.

/dungeon editor

Permission:

SinceDungeon.admin

What the Editor Is For

The editor is designed to reduce manual YAML work for common dungeon setup tasks:

  • Create and adjust dungeon actions.
  • Configure action parameters.
  • Edit locations, radius values, sounds, particles, and action metadata.
  • Use registered Core and Premium actions.
  • Save changes back into dungeon configuration files.

The main editor menu lists dungeon YAML files from:

plugins/SinceDungeon/dungeons/

Main menu actions:

  • Left click a dungeon file to edit it.
  • Shift right click a dungeon file to delete it.
  • Click Create New Dungeon to create a new YAML file.

Dungeon menu sections:

  • World Template
  • Public Status
  • Entry Conditions
  • Gameplay Settings
  • Rewards
  • Stages
  • Advanced YAML
  • Save
  • Delete Dungeon

Editor Limits

Configured in settings/menus.yml:

editor:
  nav-item: "ARROW"
  limits:
    max-locations: 50
    max-mob-amount: 200
    max-radius: 100.0

These limits protect admins from accidentally creating huge action lists, oversized radii, or excessive mob counts.

Action Defaults

The editor uses defaults from:

action-defaults:

Core defaults are in the Core settings files. Premium defaults are in Premium config.yml.

Example:

action-defaults:
  spawn_wave:
    mob: "ZOMBIE"
    amount: 1
    scale_with_party: false
    time_limit: -1
    time_penalty: 1

Premium Editor Extensions

When Premium is installed, it registers extra action types into the same action registry. They become available to the editor through the API registration layer.

Premium actions include:

  • BUFF
  • ESCORT_NPC
  • BRANCHING_PATH
  • LEVER_PUZZLE
  • CHECKPOINT
  • DAMAGE_ZONE
  • JUMP_STAGE
  • CINEMATIC_DIALOGUE
  • PROJECTILE_TRAP
  • DEFEND_CORE
  • GIVE_ITEM
  • PLAY_SOUND

Advanced YAML Menu

The Advanced YAML editor exists for full control over dungeon files. It lists every leaf YAML path and allows:

  • Left click: edit value through chat.
  • Right click on boolean fields: toggle.
  • Right click on location fields: set current player position.
  • Shift right click: delete the path.
  • List fields: open the list editor.
  • Add YAML path: create or overwrite a raw path.

Add path format:

path=value

Examples:

settings.max-players=8
settings.cooldown-seconds=3600
stages.2.actions.wave.amount=12
stages.2.actions.wave.scale_with_party=true

Use Advanced YAML for new fields, custom extension fields, or data that does not yet have a dedicated GUI button.

Input Mode

When the editor asks for chat input:

  • Type the value in chat.
  • Type cancel to abort.
  • For locations, type here to use your current position.
  • For block positions, right-click a block while in location input mode.

When to Edit YAML Manually

Manual YAML editing is still useful for:

  • Complex boss phases.
  • Large reward pools.
  • Stage command hooks.
  • Conditions.
  • Premium affix assignment.
  • Webhook, database, Redis, and cross-server settings.