User Tools

Site Tools


rpd:mods

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.

Place that folder into the ”files” directory of the game. Approximate path on typical android system looks like this : Android/data/com.nyrds.pixeldungeon.ml/files/ .

You can check how other mods are structured, to get a better idea.

Existing mods

Gameplay with mods

Since mod can drastically change the game difficulty, you cannot earn badges while playing the mod.

List of resources

Tools

Tiled - map editor

Text editors for android

To edit json configs or lua scripts

Discussion

Jhian Gabriel M. Muhi, 2018/09/20 15:35

Ok, where do I upload my small mod when I am finished?

Jhian Gabriel M. Muhi, 2018/09/21 13:52

Is there a website or a mod uploader?

mike, 2018/09/21 17:41

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

Jhian Gabriel M. Muhi, 2018/09/20 12:36

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?

Jhian Gabriel M. Muhi, 2018/09/20 13:15

Thank you! I really appreciate it.

mike, 2018/09/20 12:46

GnollTamahawk

Jhian Gabriel M. Muhi, 2018/09/20 12:13

How do I edit mob behavior? Is it placed in the assets folder as lua or is built in the app?

mike, 2018/09/20 12:46, 2018/09/20 13:39

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 )

You could leave a comment if you were logged in.
rpd/mods.txt · Last modified: 2018/12/10 20:19 by kwakone