FuzzyBot: Updating to match new version of source page

2026-10-13T05:59:38Z

Updating to match new version of source page

New page

'''Developer Scope and Prerequisites''' explains who the modding and add-on pages are written for, the two ways to extend DragonMineZ, and the folders and tools you need before you start. Run DragonMineZ once first, so that its config files exist.

== Intended audience ==
The modding and add-on pages are written for:
* People who can edit JSON and resource pack assets.
* People who can run Minecraft Forge development environments.
* People who want to contribute DMZ-compatible content.
They don't cover general player walkthroughs, lore or survival progression. For those, start with the [[Special:MyLanguage/Beginner's Guide|Beginner's Guide]].

== Two ways to extend DMZ ==

{| class="wikitable"
! Approach !! What you need !! Where to start
|-
| '''Data add-ons''' (configs, races, forms, quests, wishes, Dragon Ball packs, resource packs) || A text editor and a DMZ instance || This page, then the JSON pages linked below and in [[Special:MyLanguage/Modding|Modding]]
|-
| '''Code add-ons''' (your own Forge mod that hooks DMZ events and APIs) || A Forge 1.20.1 development environment || {{L|Add-on Getting Started}}
|}

== Baseline setup ==
{{See also|Configuration|General Server Config|General User Config|Entities Config}}
# Run DMZ once so the config files are generated.
# Use <code>config/dragonminez</code> as the config root of your local development instances.
# Race configuration lives in <code>config/dragonminez/races/<race_name>/</code> (<code>character.json</code>, <code>stats.json</code> and a <code>forms/</code> folder). See [[Special:MyLanguage/Custom Races|Custom Races]].
# Shared stack forms live in <code>config/dragonminez/forms/</code>. See [[Special:MyLanguage/Custom Forms|Custom Forms]].
# Entity attributes are configured in <code>config/dragonminez/entities.json</code>.
# General server settings are in <code>config/dragonminez/general-server.json</code>.
# General user (client) settings are in <code>config/dragonminez/general-user.json</code>.
# Combat, training, skills and ki techniques are configured in <code>config/dragonminez/combat.json</code>, <code>config/dragonminez/training.json</code>, <code>config/dragonminez/skills.json</code> and <code>config/dragonminez/techniques.json</code>.
# Raid and tournament definitions live in <code>config/dragonminez/raids/</code> and <code>config/dragonminez/tournaments/</code>, one JSON file per raid or tournament; extra files you add are loaded too.
# The client-only HUD layout, written by the in-game HUD editor, is <code>config/dragonminez/hud_layout.json</code>.

Every config file except <code>general-user.json</code> and <code>hud_layout.json</code> is sent from the server to each client on login, so clients always use the server's values.

Outdated or broken config files are not silently thrown away: DMZ moves the old file into <code>config/dragonminez/oldBackup/</code> (same relative path) and merges your edits into the new defaults. See [[Special:MyLanguage/How to JSON|How to JSON]] and [[Special:MyLanguage/Reloading and Updating Changes|Reloading and Updating Changes]].

=== World save data ===
Some systems live inside the world folder instead of <code>config/</code>:

{| class="wikitable"
! Folder !! Contents !! Page
|-
| <code><world>/dragonminez/sagas/</code>, <code>quests/</code>, <code>sidequests/</code> || Story sagas, saga quests and side quests || {{L|Custom Quests}}
|-
| <code><world>/dragonminez/wishes/</code> || Per-world wish overrides (one file per dragon) || {{L|Custom Wishes}}
|-
| <code><world>/dragonminez/dialogues/</code> || NPC dialogue files || {{L|NPC Dialogue}}
|-
| <code><world>/dragonminez/npcs/</code> || NPC placements (<code>placements.json</code>) and alignment rules (<code>alignment_rules.json</code>) || {{L|NPC Placement and Alignment}}
|-
| <code><world>/dragonminez/playerdata_json/</code> || Player data when the <code>JSON</code> storage backend is selected || {{L|General Server Config}}
|}

Dragon Ball add-on packs (folders or <code>.zip</code> files) go in the <code>dragonballs</code> folder of the game directory; see [[Special:MyLanguage/Custom Wishes|Custom Wishes]]. Not sure where a folder is on your machine? See [[Special:MyLanguage/Locating Specific Folders|Locating Specific Folders]].

== Reload workflow ==
After changing JSON config files, you can reload them in game with <code>/dmzreload [all|config|story|wishes]</code> (no argument means <code>all</code>). The command's source is <code>src/main/java/com/dragonminez/server/commands/ReloadCommand.java</code>. See [[Special:MyLanguage/Commands|Commands]] and [[Special:MyLanguage/Reloading and Updating Changes|Reloading and Updating Changes]] for what each section reloads.

Resource pack changes (models and textures) normally need a resource reload or a restart.

=== Finding JSON mistakes ===
{{Config|General Server Config|developer.reportJsonProblemsInChat}}
When a config, quest or wish file fails to load, DMZ records the file, the line and column, and the JSON path of the problem. The report is printed to the server log and shown in chat to players when they log in. Server owners can turn the chat message off with <code>developer.reportJsonProblemsInChat = false</code> in <code>general-server.json</code>.

== Translations ==
All in-game text uses translation keys. The English source file is <code>assets/dragonminez/lang/en_us.json</code>; community translations are managed on Crowdin (see [[Special:MyLanguage/Contributing|Contributing]]).

DragonMineZ automatically downloads the latest Crowdin translation for the game language you selected (every language except <code>en_us</code>), so translation fixes reach players without a mod update. To turn this off (for example, to test your own language file), start the game with the JVM argument <code>-Ddmz.crowdin.enabled=false</code>.

When a translation key is missing, some DMZ screens fall back to a readable version of the id (for example, quest texts and form names are turned into title-cased words). For proper names and other languages, ship your own keys in a resource pack under <code>assets/<namespace>/lang/<locale>.json</code> and use those keys in your JSON (for example, a form's name uses <code>race.dragonminez.<race>.form.<group>.<form></code>).

{{Navbox Add-ons}}

Developer Scope and Prerequisites/en - Revision history

FuzzyBot: Updating to match new version of source page