Paper Mario DX

Paper Mario DX is a modified version of the Paper Mario decompilation specifically tailored for making mods.

Requirements

You will need:

A computer running Windows 10+, macOS, or Linux
The Paper Mario (US) ROM in .z64 format
Visual Studio Code (or a different editor)

Installation

Open PowerShell in administrator mode by right-clicking and selecting "Run as administrator".
Type wsl --install and press Enter.
Restart your computer.
After restarting, an "Ubuntu" installation window will appear. Follow the instructions to set it up.
Open Ubuntu, type bash <(curl -Ls https://bates64.com/setup-dx.sh), and press enter.
Follow the instructions in the Ubuntu window.

Open Terminal, type bash <(curl -Ls https://bates64.com/setup-dx.sh), and press enter.
Follow the instructions in the terminal window.

Open a terminal and run bash <(curl -Ls https://bates64.com/setup-dx.sh).
Follow the instructions in the terminal window.

When the script finishes successfully, it should open the project in Visual Studio Code.

Build and run

With Visual Studio Code focused, press Ctrl+Shift+B (Cmd+Shift+B on macOS) to build the game.

DX will automatically try to run the game in a known emulator after building. We recommend using the accurate emulator ares. If you don't regularly test with ares and/or real hardware, your mod may not work correctly for others.

If DX did not find your emulator, you can load the ROM manually. The output ROM is located at ver/us/build/papermario.z64.

If you prefer real hardware, you can copy the output ROM ver/us/build/papermario.z64 to a flashcart.

Troubleshooting

If you run into any issues, you can ask for help in the #papermario-dx channel in the Star Haven Discord.

I closed VSCode! How do I open it again?

You can reopen it by using the 'Recent' menu on the VSCode Welcome screen.

If you can't find it, you can open VSCode from a terminal. Open a terminal and run code ~/papermario-dx. Note that you should use WSL if you're on Windows.