View source for Locating Specific Folders/en

'''Locating Specific Folders''' maps where DragonMineZ keeps its editable data. The files are split across a few different roots, depending on '''who owns the data''' and '''when it is read'''. Knowing which root you need saves a lot of confusion, especially since some folders only appear after you have run the server or the client at least once.

== Mod config folder ==
<code>config/dragonminez/</code> holds the mod config. It belongs to the game instance, not to a world, and it is generated the first time DragonMineZ starts. This is where you tune balance and stats, and add custom races, forms and entities. Except for the two client-only files marked below, the server sends every file in this folder to joining clients (see [[Special:MyLanguage/Reloading and Updating Changes|Reloading and Updating Changes]]).

{| class="wikitable"
! Path !! Purpose
|-
| <code>config/dragonminez/general-server.json</code> || Server-wide gameplay toggles (see [[Special:MyLanguage/General Server Config|General Server Config]]).
|-
| <code>config/dragonminez/general-user.json</code> || '''Client only.''' Personal client settings, never sent by the server (see [[Special:MyLanguage/General User Config|General User Config]]).
|-
| <code>config/dragonminez/hud_layout.json</code> || '''Client only.''' HUD style and element layout (see [[Special:MyLanguage/HUD|HUD]]).
|-
| <code>config/dragonminez/radial_layout.json</code> || Client-side order of the entries in the radial menus, saved when you reorder them.
|-
| <code>config/dragonminez/combat.json</code> || Combat tuning values (see [[Special:MyLanguage/Combat Config|Combat Config]]).
|-
| <code>config/dragonminez/skills.json</code> || Skill costs, cooldowns and eligibility, and the skills each race and master offers; both live in this one file (see [[Special:MyLanguage/Skills Config|Skills Config]]).
|-
| <code>config/dragonminez/training.json</code> || Tuning of the TP training minigames (see [[Special:MyLanguage/Training Points and Mastery|Training Points and Mastery]]).
|-
| <code>config/dragonminez/techniques.json</code> || Ki attack and strike attack tuning (see [[Special:MyLanguage/Skills Config|Skills Config]]).
|-
| <code>config/dragonminez/entities.json</code> || Base stats of each entity and the saga transformation defaults (see [[Special:MyLanguage/Entities Config|Entities Config]]).
|-
| <code>config/dragonminez/races/<race>/character.json</code> || Race identity and appearance defaults (see [[Special:MyLanguage/Custom Races|Custom Races]]).
|-
| <code>config/dragonminez/races/<race>/stats.json</code> || Race base stats and scaling for each class.
|-
| <code>config/dragonminez/races/<race>/forms/*.json</code> || Forms that belong only to that race.
|-
| <code>config/dragonminez/forms/*.json</code> || Shared stack forms, layered on top of a race's own forms (see [[Special:MyLanguage/Custom Forms|Custom Forms]]).
|-
| <code>config/dragonminez/raids/*.json</code> || Raid definitions (see [[Special:MyLanguage/Raids|Raids]]).
|-
| <code>config/dragonminez/tournaments/*.json</code> || Tournament definitions (see [[Special:MyLanguage/Tournaments|Tournaments]]).
|-
| <code>config/dragonminez/oldBackup/</code> || Copies of the config files DragonMineZ upgraded or regenerated, in the same relative layout (for example <code>oldBackup/races/saiyan/stats.json</code>). DragonMineZ never reads them back.
|}

The default races generated here are <code>human</code>, <code>saiyan</code>, <code>namekian</code>, <code>frostdemon</code>, <code>bioandroid</code>, <code>majin</code> and <code>glind</code>. Any other folder under <code>races/</code> is loaded as a custom race.

Source: <code>ConfigManager.java</code> (<code>loadGeneralConfigs</code>, <code>loadAllRaces</code>, <code>createOrLoadStackForms</code>, <code>loadRaids</code>, <code>loadTournaments</code>).

== World save folder ==
<code><world save>/dragonminez/</code> lives inside the world save, so its content belongs to one world, not to the whole instance. This is why quest and saga changes don't show up until you edit the right save folder:
* Singleplayer: <code>saves/<world>/dragonminez/</code>
* Server: <code><server>/<level-name>/dragonminez/</code>
* Development environment: <code>run/saves/<world>/dragonminez/</code>

{| class="wikitable"
! Path !! Purpose
|-
| <code>dragonminez/sagas/</code> || Saga manifests (the <code>questFolder</code> pointer and the saga metadata).
|-
| <code>dragonminez/quests/<questFolder>/</code> || Quest files for one saga, loaded in alphabetical order (<code>01_...json</code>, <code>02_...json</code>, ...).
|-
| <code>dragonminez/sidequests/</code> || Standalone side quests, loaded when side quests are enabled.
|-
| <code>dragonminez/wishes/*.json</code> || Wish list of each dragon (<code>shenron.json</code>, <code>porunga.json</code>, ...; see [[Special:MyLanguage/Custom Wishes|Custom Wishes]]).
|-
| <code>dragonminez/dialogues/*.json</code> || NPC dialogue trees (see [[Special:MyLanguage/NPC Dialogue|NPC Dialogue]]). An <code>_example.json</code> is written the first time; files whose NPC id starts with <code>_</code> are not loaded.
|-
| <code>dragonminez/npcs/placements.json</code> || Spawn positions of master and trainer NPCs (see [[Special:MyLanguage/NPC Placement and Alignment|NPC Placement and Alignment]]).
|-
| <code>dragonminez/npcs/alignment_rules.json</code> || Alignment and hostility thresholds of each NPC (see [[Special:MyLanguage/NPC Placement and Alignment|NPC Placement and Alignment]]).
|-
| <code>dragonminez/playerdata_json/<uuid>.json</code> || Player save data, only used when <code>storageType</code> is <code>JSON</code>.
|-
| <code>dragonminez/oldBackup/</code> || Copies of default quest, saga and side quest files taken before DragonMineZ upgraded them, in the same relative layout.
|-
| <code>dragonminez/quest_update_report.txt</code> || Summary of the last upgrade of the quest defaults: values updated, and conflicts kept as your edits.
|}

Source: <code>QuestRegistry.loadAll(server)</code>, <code>WishManager.loadWishes(server)</code>, <code>DialogueRegistry.loadAll(server)</code>.

=== Default story files ===
{{Config|General Server Config|gameplay}}
DragonMineZ writes its default saga, quest and side quest files only when they are missing and the default-generation toggles are on in <code>general-server.json</code> (<code>storyModeEnabled</code> and <code>createDefaultSagas</code> for sagas and saga quests, <code>createDefaultSideQuests</code> for side quests). With <code>autoUpdateQuests</code> on (the default), the files DragonMineZ generated are upgraded in place when a new DragonMineZ version changes them: your edits are kept, and a copy goes to <code>dragonminez/oldBackup/</code> first. Files you created yourself are never touched. See [[Special:MyLanguage/Reloading and Updating Changes|Reloading and Updating Changes]].

=== World data files ===
Some DragonMineZ state is stored as vanilla "saved data": <code>.dat</code> files in the world's <code>data/</code> folder, or in a dimension's own <code>data/</code> folder. These files are binary and not meant to be edited by hand: <code>dragon_balls_data</code> (Dragon Ball positions), <code>dragonminez_mutants</code>, <code>dragonminez_parties</code>, <code>dragonminez_pothala_pairs</code>, <code>dragonminez_raids</code>, <code>dragonminez_raid_sites</code>, <code>dragonminez_structure_plan</code>, <code>dragonminez_worldbosses</code>, <code>dragonminez_npc_placements</code>, <code>dragonminez_tournaments</code> and <code>dragonminez_otherworld_tournament</code>.

== Dragon Ball pack folder ==
<code><game dir>/dragonballs/</code> sits next to your worlds and instance (not inside the world save). It holds external, distributable Dragon Ball definitions: ball sets, radars, dragons and their wishes. Each add-on pack can be a plain folder or a <code>.zip</code> file. DragonMineZ also checks a <code>dragonballs</code> folder in the current working directory and in the parent of the game directory. The packs are loaded by <code>DragonBallPackManager</code>; see [[Special:MyLanguage/Custom Wishes|Custom Wishes]].

== Rhythm chart cache ==
<code><game dir>/dragonminez/rhythm_charts/</code> is created on the client by the Rhythm training minigame for the charts it generates from music. It is a cache, not configuration.

== Datapacks ==
Some systems are plain Forge or vanilla reload listeners. They follow the normal datapack rules (<code>data/<namespace>/...</code>) instead of living in <code>config/</code> or in the world save:
* <code>spacepod/*.json</code>: the [[Special:MyLanguage/Space Pod|Space Pod]] destination list (see [[Special:MyLanguage/Space Pod Destinations|Space Pod Destinations]]).
* <code>weapon_attributes/*.json</code>: weapon attribute definitions (see [[Special:MyLanguage/Weapon Attributes|Weapon Attributes]]).
* <code>structure_npcs/*.json</code>: NPCs placed inside DragonMineZ structures (see [[Special:MyLanguage/NPC Placement and Alignment#Structure NPCs|NPC Placement and Alignment]]).
* <code>rhythm_charts/*.json</code>: charts for the Rhythm training minigame.
These are picked up by the vanilla <code>/reload</code>, not by <code>/dmzreload</code>. Dragon Ball and wish definitions are '''not''' read from datapacks: use an add-on pack in <code><game dir>/dragonballs/</code> or the world's <code>dragonminez/wishes/</code> folder instead. See [[Special:MyLanguage/Reloading and Updating Changes|Reloading and Updating Changes]] for the full breakdown.

== Resource pack assets ==
Models, textures and animations referenced by config (the <code>customModel</code> fields) live under the normal resource pack namespace, for example:
* <code>assets/dragonminez/geo/entity/races/</code>
* <code>assets/dragonminez/lang/en_us.json</code> (the source language file)
These need a resource reload ({{Key|F3}} + {{Key|T}} on the client) or a restart. See [[Special:MyLanguage/Reloading and Updating Changes|Reloading and Updating Changes]] and [[Special:MyLanguage/Custom Models and Assets|Custom Models and Assets]].

== Quick decision guide ==
* Tuning stats, damage or costs, or adding a race, form, entity or raid: <code>config/dragonminez/</code>
* Adding or editing story content, wishes, dialogue or NPC placement for '''this world''': <code><world save>/dragonminez/</code>
* Shipping a distributable Dragon Ball pack: <code><game dir>/dragonballs/</code>
* Space Pod destinations, weapon attributes, rhythm charts: a datapack
* Adding a model, texture or animation: <code>assets/dragonminez/...</code> in a resource pack

{{Navbox Modding}}