Sidebar
This is an old revision of the document!
Table of Contents
Modding
Basic Idea
- All PD flavors source has assets folder vanilla for example
- Remixed can load games resources not only from apk assets but also from external storage ( typically located at Android/data/com.nyrds.pixeldungeon.ml/files/ ), so mod can override some (or all) of it contents (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 one can just provide different data set and it is.
Most simple way to get a better view at Remixed view is to download one of bundled mods and examine it structure. Maze is good to start from)
Brief features list
Maybe it worth to you check Remixed PD mods mechanics? It very far from complete, completely lack documentations, full of bugs, and so on. But at this point it allow do following (without touching java code):
- Replace any sprite
- 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 avaliable yet )
- Create custom bestiary ( mob|level probability )
- Add signs and codexes with arbitary texts
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
Discussion
Gdzie tworzyć mody?
Ok, where do I upload my small mod when I am finished?
Is there a website or a mod uploader?
Here is central mods list:
https://github.com/NYRDS/pixel-dungeon-remix-mods
In short you upload your mod packed to zip somewhere and then if mod is good I add link to it in list.
Or you can redistribute it in any way for manual install
Also, what is the gnoll tomahawk called? I want to give one to a mage but I cant find the type. Is it “GnollTomahawk” “Gnoll_Tomahawk” “Gnolltomahawk” “Gnoll_tomahawk” or something else?
For full list of built-in items please check https://github.com/NYRDS/pixel-dungeon-remix/blob/master/PixelDungeon/src/main/java/com/nyrds/pixeldungeon/items/common/ItemFactory.java
Thank you! I really appreciate it.
GnollTamahawk
How do I edit mob behavior? Is it placed in the assets folder as lua or is built in the app?
Mob behavior is more complex task:
1) You need to create CustomMob check https://github.com/NYRDS/pixel-dungeon-remix/blob/master/PixelDungeon/src/main/assets/mobsDesc/BlackRat.json - for common stats
and
https://github.com/NYRDS/pixel-dungeon-remix/blob/master/PixelDungeon/src/main/assets/mobsDesc/BlackCat.json - for custom ai
2) Then define custom lua behavior to it ( check https://github.com/NYRDS/pixel-dungeon-remix/tree/master/PixelDungeon/src/main/assets/scripts/mobs folder for examples )