Tutorial:Navigating PMDO's Repository
The repository for PMDO, PMDODump, consists of several different modules and sub-repositories that contain different pieces of the game and its engine. Knowing where different parts of the game can be found is important for the purposes of modding.
This tutorial contains some information on what pieces of the engine can be found where, and what parts of the overall repository to navigate in order to find how the code works.
PMDODump
PMDODump is the master repository for PMDO. It is used to build the game and include all of the information relevant to it.
It has the following folders:
- DataAsset: Contains generated output showing some of PMDO's data.
- DataGenerator: These files are used to generate some of the data that PMDO has.
- PMDOSetup:: Files related to initializing the
PMDOSetupprogram, which is used to manage the install of the game. - Scripts: Python script for automating some development processes.
RawAsset
RawAsset contains the visual assets for PMDO, such as sprites. These are converted to the Content subfolder in DumpAsset.
Subfolders are:
- BG: Backgrounds for effects.
- Beam: The components for various beam-like effects used in attacks.
- Icon: Icons for UI elements, indicators, and actor emotes.
- Item: The sprites for items when on the ground.
- Object: The sprites for ground map objects.
- Particle: Textures for particle effects.
- Portrait: Pokémon portraits that are used from SpriteCollab.
- Tile: Non-dungeon tiles that are used by the game. There are 16x16 and 8x8 tilesets.
- TileDtef: Dungeon tiles that are used by the game, which are 24x24.
- Font: Assets for the fonts used in PMDO.
DumpAsset
DumpAsset contains all data generated for PMDO, such as Pokemon, base game mods, ground map scripts, and the editor.
Subfolders are:
- Base: Some defined base constants of PMDO.
- CONFIG: Config defaults for the rescue server and keyboard.
- CONVERSION: Indexed tables to look up when searching for indexes.
- Content: This subfolder is created by running PMDC with the
-convertflag, which packages all files in the RawAsset repository into Content. - Controls: Files related to keyboard and controller controls.
- Data: This subfolder is created by running the DataGenerator project found in PMDO dump, alongside changes that have been made manually.
- Editor: UI aspects of the dev mode editor.
- Licenses: All of the licenses that are associated with PMDO.
- MODS: The folder that mods are installed to. In the repositority, it contains all mods included with PMDO by default.
These subfolders collectively include:
- Lua script files that are used in the main game
- Mods included with the game by default
- Text strings
- Overall all accessible game content
PMDC
PMDC contains the overall engine that is used to run PMDO, which parses the game data. The module include PMD series specific mystery dungeon features. Includes:
- The components of MapGenTest, which is used to check for seed-dependent errors in dungeons
- Zone steps and floor generation steps that implement PMD specific features, such as mob spawning, shops, monster houses, terrain placement, and chests.
RogueEssence
The underlying engine that forms PMDO, for creating roguelikes.
