Skip to content

Project Structure

Here are the important files and folders in a Paper Mario DX mod.

  • README.md
  • Directoryassets
    • Directorymod Where you will place your mod's assets
    • Directorydx Assets provided by DX (do not edit)
    • Directoryus Assets dumped from the baserom (do not edit)
  • Directoryinclude C headers
  • Directorysrc C code
    • Directorydx
      • config.h Mod configuration
  • Other files/folders are internal to DX

The assets folder

The assets folder contains game content (not engine code).

It has a layered approach where assets/mod/ takes priority over assets/dx/, which takes priority over assets/us/. For example, the file assets/us/msg/0C_Chapter1.msg can be overridden by creating a file at assets/mod/msg/0C_Chapter1.msg. You can create the msg folder if it doesn't exist.

The src and include folders

These folders contain C code for the game engine. You can edit it freely, just note that you may get merge conflicts when updating to a new version of DX.

The src/dx/config.h file

This is where you configure mod settings like the mod name and new game start, the debug menu, and more. You don't need to understand C code to use these options — just edit the file.