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 [2018/11/05 21:06] – [Tools] mikerpd: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 ===== =====  Basic Idea =====
-  * All 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 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 ) +  * 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 one can just provide different data set and it is.+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.
  
-Most simple way to get a better view at Remixed view is to download one of bundled mods and examine it 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 =====
  
-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: By just overriding resources you can:
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
  
-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 are structured, to get better idea.
- +
-You can check how other mods structured, to get better idea.+
  
 ==== Existing mods ==== ==== Existing mods ====
  
-For example you can see : ( https://github.com/NYRDS/PD_mini-RPD-MOD )+For exampleyou 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 ==== ==== List of resources ====
   * assets (images, sounds, maps and dungeon layout):   * assets (images, sounds, maps and dungeon layout):
-  * https://github.com/NYRDS/pixel-dungeon-remix/tree/master/PixelDungeon/src/main/assets+  * https://github.com/NYRDS/remixed-dungeon/tree/master/RemixedDungeon/src/main/assets
  
   * res (texts):   * res (texts):
-  * https://github.com/NYRDS/pixel-dungeon-remix/tree/master/PixelDungeon/src/main/res/values+  * https://github.com/NYRDS/remixed-dungeon/tree/master/RemixedDungeon/src/main/res/values
  
   * example of a level:   * example of a level:
-  * https://github.com/NYRDS/pixel-dungeon-remix/blob/master/PixelDungeon/src/main/assets/levelsDesc/TestLevelGuts.json+  * https://github.com/NYRDS/remixed-dungeon/blob/master/RemixedDungeon/src/main/assets/levelsDesc/TestLevelGuts.json
  
   * example of a level created with modified Tiled:   * example of a level created with modified Tiled:
-  * https://github.com/NYRDS/pixel-dungeon-remix/blob/master/PixelDungeon/src/main/assets/levelsDesc/Town.json+  * https://github.com/NYRDS/remixed-dungeon/blob/master/RemixedDungeon/src/main/assets/levelsDesc/Town.json
  
   * Dungeon layout:   * Dungeon layout:
-  * https://github.com/NYRDS/pixel-dungeon-remix/blob/master/PixelDungeon/src/main/assets/levelsDesc/Dungeon.json+  * https://github.com/NYRDS/remixed-dungeon/blob/master/RemixedDungeon/src/main/assets/levelsDesc/Dungeon.json
  
   * Bestiary:   * Bestiary:
-  * https://github.com/NYRDS/pixel-dungeon-remix/blob/master/PixelDungeon/src/main/assets/levelsDesc/Bestiary.json+  * 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 ====
rpd/mods.1541451960.txt.gz · Last modified: 2018/11/05 21:06 by mike