User Tools

Site Tools


rpd:mods

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Last revisionBoth sides next revision
rpd:mods [2019/03/19 19:36] mikerpd:mods [2020/11/15 12:34] – [How-to create custom mod] mike
Line 1: Line 1:
 ====== Modding ====== ====== Modding ======
 +
 +=====How-to install custom mod =====
 +
 +Mods are typically packed in zip archives (sometime file extension changed to something like zipp if this is the case rename it to plain zip)
 +
 +To install mod on Remixed Dungeon manually:
 +
 +  * unpack mod archive to **Android/data/com.nyrds.pixeldungeon.ml/files/**
 +  * done.
 +
 +
 +=====How-to create custom mod =====
 +
 +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"). 
 +
 +Don't forget to add at least minimal [[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/** . 
  
  
Line 5: Line 27:
   * Every PD flavors source has assets folder [[https://github.com/watabou/pixel-dungeon/tree/master/assets|vanilla for example]]   * Every PD flavors source has assets folder [[https://github.com/watabou/pixel-dungeon/tree/master/assets|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)   * 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 [[https://github.com/NYRDS/pixel-dungeon-remix/tree/master/PixelDungeon/src/main/assets|assets]] contains not only graphics & music but also data such as Dungeon structure, levels description, animation sequences and so on.+  * In Remixed [[https://github.com/NYRDS/remixed-dungeon/tree/master/RemixedDungeon/src/main/assets|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.+Each mod is resource overlay, that is they replace game assets such as textures, sounds, json configuration files and lua scripts while leaving java code intact.
  
-The simplest way to get a better view at Remixed view is to download one of the bundled mods and examine its structure. [[https://github.com/NYRDS/Maze-RPD-MOD|Maze]] is good to start from.+The simplest way to get a better view at Remixed is to download one of the bundled mods and examine its structure. [[https://github.com/NYRDS/Maze-RPD-MOD|Maze]] is good to start from.
  
 =====  Brief features list ===== =====  Brief features list =====
Line 38: Line 60:
   * Create custom mobs with unique abilities   * Create custom mobs with unique abilities
   * Create custom spells   * Create custom spells
-  * Create custom items (this feature is pretty limited for now)+  * Create custom items 
 +  * Create custom buffs
   * Create custom AI for mobs and NPC's   * Create custom AI for mobs and NPC's
  
-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. You can check how other mods are structured, to get a better idea.
rpd/mods.txt · Last modified: 2022/02/04 14:12 by mikhael_danilov