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
rpd:mods [2017/01/18 21:30] – [Existing mods] mdrovrpd:mods [2022/02/04 14:12] (current) – [Existing mods] mikhael_danilov
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/** . 
 +
 +
 +=====  Basic Idea =====
 +  * 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)
 +  * 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.
 +
 +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 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 =====
  
-Maybe it worth to you check Remixed PD mods mechanicsIt 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):+Maybe it'worth for you to check Remixed PD mods mechanicsIt is far from complete, completely lacks documentation, full of bugs, etc. But at this pointit 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 sprite 
   * Replace any text for any language already in   * Replace any text for any language already in
   * Assign file & index for item sprites   * Assign file & index for item sprites
Line 13: Line 50:
   * Assign custom music for boss fight   * Assign custom music for boss fight
   * Add predesigned levels to dungeon ( you can use [[Tiled]] to define floor layout, place mobs and items)   * 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 )+  * Add random levels ( this feature somewhat similar to YourPD custom maps but no gui available yet )
   * Create custom bestiary ( mob|level probability )   * Create custom bestiary ( mob|level probability )
-  * Add signs and codexes with arbitary texts+  * 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 
 +  * Create custom buffs 
 +  * Create custom AI for mobs and NPC'
 + 
 + 
 +You can check how other mods are structured, to get a better idea.
  
 ==== Existing mods ==== ==== Existing mods ====
  
-If you interested just check assets folder in source ( https://github.com/NYRDS/pixel-dungeon-remix/tree/master/PixelDungeon/src/main/assets ) and for example ( https://github.com/NYRDS/PD_mini-RPD-MOD )+For example, you can see : ( https://github.com/NYRDS/PD_mini-RPD-MOD )
  
 +  * [[rpd:mods:Remixed Additions]]
 +  * [[rpd:mods:Remixed RPG]]
 +  * [[rpd:mods:The Epic Dungeon]]
   * [[rpd:mods:Maze]]   * [[rpd:mods:Maze]]
-  * [[rpd:mods:The Fallen]]+
 ==== Gameplay with mods ==== ==== Gameplay with mods ====
-Since mod can drastically change game difficulty one cannot earn badges while playing in mod.+Since mod can drastically change the game difficulty, you cannot earn badges while playing the mod. 
 + 
 +==== List of resources ==== 
 +  * assets (images, sounds, maps and dungeon layout): 
 +  * https://github.com/NYRDS/remixed-dungeon/tree/master/RemixedDungeon/src/main/assets 
 + 
 +  * res (texts): 
 +  * https://github.com/NYRDS/remixed-dungeon/tree/master/RemixedDungeon/src/main/res/values 
 + 
 +  * example of a level: 
 +  * https://github.com/NYRDS/remixed-dungeon/blob/master/RemixedDungeon/src/main/assets/levelsDesc/TestLevelGuts.json 
 + 
 +  * example of a level created with modified Tiled: 
 +  * https://github.com/NYRDS/remixed-dungeon/blob/master/RemixedDungeon/src/main/assets/levelsDesc/Town.json 
 + 
 +  * Dungeon layout: 
 +  * https://github.com/NYRDS/remixed-dungeon/blob/master/RemixedDungeon/src/main/assets/levelsDesc/Dungeon.json 
 + 
 +  * Bestiary: 
 +  * https://github.com/NYRDS/remixed-dungeon/blob/master/RemixedDungeon/src/main/assets/levelsDesc/Bestiary.json 
 + 
 +  * Hero initial stats & equipment: 
 +  * https://github.com/NYRDS/remixed-dungeon/blob/master/RemixedDungeon/src/main/assets/hero/initHeroes.json
  
 ==== Tools ==== ==== Tools ====
  
 [[Tiled]] - map editor [[Tiled]] - map editor
 +
 +=== Text editors for android ===
 +To edit json configs or lua scripts
 +
 +  * [[https://play.google.com/store/apps/details?id=com.maskyn.fileeditor|Turbo Editor // Text Editor]]
 +  * [[https://play.google.com/store/apps/details?id=xyz.iridiumion.enlightened|Enlightened (Code Editor)]]
rpd/mods.1484775049.txt.gz · Last modified: 2017/01/18 16:30 (external edit)