Differences

This shows you the differences between two versions of the page.

--- rpd:version_json [2025/12/25 21:04] – list fix Mikhael
+++ rpd:version_json [2025/12/25 21:25] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
+====== version_json ======
+===== Description =====
+**version.json** is a required file for all mods in Remixed Dungeon. It contains metadata about the mod that the game uses to properly load and manage the mod.
+===== File Structure =====
+<code javascript>
+ {
+   "version": 6,
+   "name": "Cool Mod Name",
+   "author": "Proud Mod Developer",
+   "description": "Detailed mod description",
+   "url": "https://wiki.nyrds.net/",
+   "hr_version": "version 6!",
+   "rpd_version": 610
+ }
+</code>
+==== Fields ====
+  * **version** (integer, required) - Machine readable mod version, used for update checks
+  * **name** (string, optional) - Mod name as displayed to the player; defaults to directory name if not specified
+  * **rpd_version** (integer, optional) - Remixed Dungeon version required to run the mod; if not specified, defaults to 0
+  * **author** (string, optional) - Mod developer name as displayed to player; defaults to "Unknown" if not specified
+  * **description** (string, optional) - Mod description as displayed to player; defaults to empty string if not specified
+  * **url** (string, optional) - Clickable link to developer's site; defaults to empty string if not specified
+  * **hr_version** (string, optional) - Human-readable version as displayed to player; defaults to string representation of "version" value if not specified
+===== Mechanics =====
+  * The game checks for the existence of version.json in potential mod directories
+  * Only directories containing a valid version.json file will be loaded as mods
+  * The "rpd_version" field is used to determine compatibility with the current Remixed Dungeon version
+  * A mod is considered compatible if its rpd_version is less than or equal to (current version code % 2000)
+  * The "version" field is used to check if the installed mod is outdated compared to the online version
+===== Content Verification =====
+  * Information source: Java classes [[https://github.com/NYRDS/remixed-dungeon/blob/master/RemixedDungeon/src/main/java/com/nyrds/pixeldungeon/utils/ModDesc.java|ModDesc.java]] and [[https://github.com/NYRDS/remixed-dungeon/blob/master/RemixedDungeon/src/main/java/com/nyrds/util/Mods.java|Mods.java]]
+  * Field definitions and defaults: Extracted from the fromJson() method in ModDesc.java
+  * Compatibility logic: Extracted from the isCompatible() method in ModDesc.java
+  * Last updated: December 2025, source: Remixed Dungeon 1.9.3
+===== Source Code =====
+  * Java: [[https://github.com/NYRDS/remixed-dungeon/blob/master/RemixedDungeon/src/main/java/com/nyrds/pixeldungeon/utils/ModDesc.java|ModDesc.java]]
+  * Java: [[https://github.com/NYRDS/remixed-dungeon/blob/master/RemixedDungeon/src/main/java/com/nyrds/util/Mods.java|Mods.java]]
+===== See Also =====
+  * [[rpd:mods|Mods]] - Overview of modding system
+  * [[rpd:modding_getting_started|Getting Started with Modding]] - Tutorial for creating mods
+  * [[rpd:modding_quick_reference|Modding Quick Reference]] - Reference for mod creation
+{{tag> rpd modding json}}