This is an old revision of the document!
Table of Contents
Modding
Basic Idea
- Every PD flavors source has assets folder vanilla for example
- Remixed can load game resources not only from apk assets but also from external storage ( typically located at Android/data/com.nyrds.pixeldungeon.ml/files/ ), so mods can override some (or all) of its content (also it must contain version.json file )
- In Remixed assets contains not only graphics & music but also data such as Dungeon structure, levels description, animation sequences and so on.
So anyone can just provide different data set and that's it.
The most simple way to get a better view at Remixed view is to download one of the bundled mods and examine its structure. Maze is good to start from)
Brief features list
Maybe it's worth for you to check Remixed PD mods mechanics. It is far from complete, completely lacks documentation, full of bugs, etc. But at this point, it allows to do the following (without touching the java code):
By just overriding resources you can:
- Replace any sprite, sound or music
Using json configuration files you can:
- Replace any text for any language already in
- Assign file & index for item sprites
- Change animation sequences for mobs ( not all special effects implemented yet )
- Change dungeon structure ( levels graph, kind, size )
- Assign custom level music
- Assign custom music for boss fight
- Add predesigned levels to dungeon ( you can use Tiled to define floor layout, place mobs and items)
- Add random levels ( this feature somewhat similar to YourPD custom maps but no gui available yet )
- Create custom bestiary ( mob|level probability )
- Add signs and codexes with arbitrary texts
With some lua scripts you can:
- Create custom traps
- Create custom level actors
- Create custom mobs with unique abilities
- Create custom spells
- Create custom items (this feature is pretty limited for now )
In order to be able to play your mod (or any other non-official mod), you need to place your modified files in a folder named the way, you want your mod to be named (example: “My mod”). Do not forget to add a version.json file with something like {“version”:1} as content
And place that folder into ”files” directory of the game. Approximate path on typical android system looks like that: Android/data/com.nyrds.pixeldungeon.ml/files/ .
You can check how other mods structured, to get better idea.
Existing mods
For example you can see : ( https://github.com/NYRDS/PD_mini-RPD-MOD )
Gameplay with mods
Since mod can drastically change game difficulty one cannot earn badges while playing in mod.
List of resources
- assets (images, sounds, maps and dungeon layout):
- res (texts):
- example of a level:
- example of a level created with modified Tiled:
- Dungeon layout:
- Bestiary:
Tools
Tiled - map editor
Text editors for android
To edit json configs or lua scripts