Nyrds Wiki

User Tools

Site Tools

Trace:
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 [2019/01/06 22:42] – mikerpd:mods [2024/09/19 01:28] (current) – 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:
 +
 +Android version >= 11 (requires remixed 32.1+)
 +
 +option 1 (If you delevoping mod):
 +  * unpack mod archive to any directory under Downloads folder
 +  * In game Mod -> Install local mod -> pick mod directory (refer to [[https://www.youtube.com/shorts/hJq-7vVaf4o|video]] if in doubt)
 +
 +option 2 (To install mod developed by someone else):
 +  * place mod archive in rpd format on device
 +  * navigate to it in file manager (refer to [[https://www.youtube.com/shorts/wyPVbAdbWXQ|video]] if in doubt)
 +  * tap to open
 +  * choose Remixed Dungeon app
 +  * In app: confirm mod installation
 +
 +Android version < 11
 +
 +  * 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 =====
   * 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 most simple 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 74:
   * 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. 
- 
-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.
Line 48: Line 83:
 ==== Existing mods ==== ==== Existing mods ====
  
-For example you can see : ( 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 ====
Line 58: Line 95:
 ==== List of resources ==== ==== List of resources ====
   * assets (images, sounds, maps and dungeon layout):   * assets (images, sounds, maps and dungeon layout):
-  * https://github.com/NYRDS/remixed-dungeon/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/remixed-dungeon/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/remixed-dungeon/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/remixed-dungeon/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/remixed-dungeon/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/remixed-dungeon/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.1546814529.txt.gz · Last modified: 2019/01/06 22:42 by mike