Using Decomplicator

Decomplicator is a tool that can automate the process of setting up a build environment for HackerSM64, and simplify common decomp ROM hacking tasks, like building the ROM. It is intended to provide newcomers to decomp ROM hacking an easy way to get started on their project.

To get started, download Decomplicator.

Note: Decomplicator uses MinGW under the hood to build the ROM. You can also set up a MinGW environment separately, if you'd like, by following this guide.

Setting up a new project

1. Open Decomplicator, select Create new project, then click Next.
   
   

2. Select HackerSM64 from the list of project templates, then click Next.
   
   

3. Select a folder to contain the project by clicking Browse..., then click Next.
   
   

4. You need to provide your ROM for the US version of Super Mario 64 in order to create a ROM hack. To do this, click Select ROM..., then select your ROM. Click Create Project to start the setup process.
   
   

5. Decomplicator will set up your project environment for you, downloading all the necessary software and setting up a local HackerSM64 repository in the folder you selected.
   
   

6. When the setup process is complete, you will see a screen like the one below, which lists a few commonly used ROM hacking tools. When you're ready, click Finish.
   
   

You can open the project later using the list of recent projects on the launch page of Decomplicator, or by opening the project file (decomplicator.toml) in your project folder using the Open existing project option.

Project actions

Several "actions" are provided, which allow you to easily complete common tasks related to your project. The one you will use the most often is Build and Play, which builds the ROM with your changes included, then opens it in your default emulator so that you can test your changes.

You should read through each of the actions to understand what they do. In particular, you should note the Open Terminal button, which will open a terminal inside your project's build environment. If you need to run a command related to your project, you should use the terminal that appears when you click this button.

Building the ROM

When you build the ROM (or perform most project actions), a window will appear with two large text areas. Since most actions simply run one or more commands, you can see the output from the command(s) in the top area of this window, and errors in the bottom area.

When the command(s) finish running, click Close to close the action window.