Installation Guide

Contents

1. Download the latest release
   1. Already have the Tracker?
   2. Express Install Method (v7.1.0+)
   3. Original Install Method
2. Load the Tracker script into your emulator
   1. Install for Bizhawk
      • Notes for Linux Users
   2. Install for mGBA
3. Setup the Ironmon Tracker
4. Start Playing!

Step 1: Download the latest release

Already have the Tracker? (v7.0.0+)

1. If you already have the Ironmon Tracker and are on version 7.0.0 or higher, you can automatically update to the latest Tracker version using the Tracker itself
2. To do so, open your emulator with a game ROM and the Ironmon Tracker loaded
3. Click the Gear icon at the top of the Tracker screen, then click Update. You may have to click "Check for Updates"
4. Click "Update automatically", wait for the update to download and install, then click "Restart Tracker"

   

Express Install Method (v7.1.0+)

1. Download the UpdateOrInstall.lua file at the bottom of the latest release page
2. Move the downloaded file to the folder in which you want the tracker to be installed

   Note: Do not place inside a OneDrive (or similar cloud storage) folder

3. Open up your emulator and follow the steps in the "Load the Tracker script into your emulator" section
   • Load up the UpdateOrInstall.lua file instead of the Ironmon-Tracker.lua file
4. Follow the prompts to complete installation

Original Install Method

1. Download the latest Ironmon-Tracker-#.#.#.zip file at the bottom of the latest release page
2. Extract the contents of the .zip file with right-click -> "Extract All" in Windows, or by using a program such as 7-zip

   

3. Optional: Move the entire folder somewhere easy to find, such as "My Documents"

Note: Avoid keeping the Tracker folder and files inside of a OneDrive folder. This will prevent several of the Tracker's features from working properly, including the auto-updater.

Step 2: Load the Tracker script into your emulator

Install for Bizhawk

1. If you haven't already, download the latest Bizhawk version (2.8 or higher is required) and install necessary prereqs
2. Open the Bizhawk emulator (EmuHawk.exe) and load a Pokémon game ROM (See supported games here.)
3. In the Bizhawk menus at the top, click Tools -> Lua Console

   

4. If there are any existing Ironmon Tracker scripts, highlight them one at a time and remove them: click the X icon button or press the Delete key
5. Click Script -> Open Script... or press Ctrl+O

   

6. Locate and select the Ironmon-Tracker.lua script file from the new Ironmon-Tracker release folder you downloaded, and open it

   

7. The Ironmon Tracker should now be loaded and appear on Bizhawk
   • If you haven't loaded a ROM yet, the Lua Console should look something like this:

     

   • Once you load a ROM, then it should look something like this:

     

   • If you see no output at all, see here as you may have accidentally clicked on New Script instead of Open Script

Notes for Linux Users

1. We recommend using Bizhawk version 2.9 or higher. This version of Bizhawk contains quite a few compatibility updates to allow many Tracker features to work. Using version 2.8 may cause unexpected issues.
2. You will also want to download and install the Franklin Gothic Medium font if you don't have it installed already, otherwise the font size / UI scaling will be all messed up.

Install for mGBA

1. If you haven't already, download the latest mGBA version (0.10.0 or higher is required)
2. Open the mGBA emulator and load a Pokémon game ROM (See supported games here.)
3. From the emulator menus at the top, click Tools -> Scripting
4. In the console window, click File -> Load Script
5. Then locate the Ironmon-Tracker.lua file in the Tracker folder, and open it

Step 3: Setup the Ironmon Tracker

1. At this point, you can load up a game ROM and/or unpause your game if you haven't already
2. Select your Tracker settings and theme:
   • If you are using Bizhawk, click the Gear icon near the top of the Ironmon Tracker screen to edit tracker settings and customize your Tracker's theme
   • If you are using mGBA, click on the different screens that appear on the left sidebar to see available options. You can turn an option ON or OFF by typing a command into the bottom of the script window. For example: OPTION "2" will toggle the option labeled with #2 to ON/OFF.
3. If you want to use the quickload feature to load up the next seed, then be sure to set this up under Tracker Setup -> Quick-load
   • When you ask the Tracker to Quickload, it loads up a new game ROM based on your chosen Quickload mode
   • Quickload activates when you press A + B + START all at once on your controller

Step 4: Start Playing!

1. Now that you've got everything setup, you're ready to start playing and enjoy using the Tracker
2. If this is your first time using it, check out the Quickstart Guide to learn more about the type of information that it shows as well as all of it's features
3. If you are a streamer, check out our Streamer Setup Tips!