Getting Started

This section will help install the Retry System for your project.

Contents


Download UberASM Tool

The first step is to download UberASM Tool, which is the tool used to insert Retry and many other resources. Note that you need to use UberASM Tool version 2.0 or higher to insert Retry.


Copy Retry Files into Project

Now that you have UberASM Tool, you'll need to copy the Retry files into it.

Inside the main folder you can find the retry_install.bat file, which will do all the copying for you. Just double click it, and then drag and drop your UberASM Tool folder inside the terminal window that pops up. After that, the script will copy all the files in your folder, and you should see a success message. Additionally, if Retry was already present in your UberASM Tool folder, the script will backup up its files in a separate retry_old_backup folder, in case you need to port your settings from the previous version (feel free to delete this folder afterwards).

If you instead want to do it manually, follow these steps:

After running the script or copying the files manually, your UberASM Tool folder structure should look like this:

UberASM Tool Folder ├─ asm ├─ gamemode └─ retry_gm*.asm ├─ level ├─ library └─ retry.asm ├─ other ├─ overworld ├─ retry_config ├─ retry_old_backup (only present if old Retry backed up by install script) ├─ routines (only present in UberASM Tool 2.0+) ├─ ...


Insert Files with UberASM Tool

Now that the Retry files are in place, you need to tell UberASM Tool to insert them in your rom.


Further Steps

Now Retry is inserted in your rom, so if you start a new game and die in a level, you should see the Retry prompt pop up (since it is the default configuration). To customize it, you need to edit the configuration files in the retry_config folder. When you make changes, you can just run UberASM Tool again to see them applied in the game.

For more information about the customization options, check out the Configuration section.


Return to main page