Skip to content

Dungeon Settings

fnar edited this page May 28, 2021 · 43 revisions

Add customization files to _config/roguelike_dungeons/settings/*.

Examples

See the examples here: https://github.com/fnar/minecraft-roguelike-settings

Settings files can have any name, though the file extension .json is recommended to make the file easier to edit in tools like IntelliJ, VSCode, Atom, or even the infamous Notepad++.

Structure

  • Object
    • "name" : String - required - "[domain:]path" if no domain is specified it is set to "default". See Name
    • "requires" : Array of Strings - a list of mod names as strings that this DungeonSetting depends on.
    • "inherit" : Array - a list of other settings by name. See Inherit
    • "overrides" : Array - Overrides the specified settings instead of merging. see Overrides
    • "criteria" : Object - see Criteria
    • "exclusive" : Boolean - (default: false) - If selected, the dungeon will only use these settings and is a candidate for random generation. See Exclusive
    • "filters" : Array - see filters
    • "lootRules" : Array - see Loot Rules
    • "lootTables" : Array - see Loot Tables
    • "layouts" : Array - see Layout
    • "numRooms" : Array - see num_rooms
    • "scatter" : Array - see scatter
    • "rooms" : Array - see rooms
    • "segments" : Array - see segments
    • "spawners" : Array - see spawners
    • "themes" : Array - see themes
    • "tower" : Object - see Tower

Directory Structure

Roguelike Dungeons will load files inside of subdirectories recursively. This enables settings files to be be organized by concern, e.g. loot/, or undead/.

Configurations should ideally be namespaced via a directory structure, both to make separation and updating older packs easy.
For example, packs you download from me will have namespaces like

  • fnar/vanilla/loot/ to contain loot settings for vanilla loot made by me.
  • fnar/modded/ebwizardry/loot/ to contain loot settings for modded loot from Electroblob's Wizardry made by me.
  • fnar/modded/ice_and_fire/spawners/ to contain spawners for modded entity spawners from Ice and Fire made by me.
  • fnar/modded/lycanites_mobs/dungeons/ to contain dungeon settings built around Lycanite's Mobs made by me.

Your loot settings should contain a similar directory structure, e.g.

  • greymerk/vanilla/themes/
  • lycanite/modded/lycanites_mobs/dungeons/
  • dreams/modded/roguelike_adventures_and_dungeons/loot/
  • adam/modded/mc_eternal/dungeons/