Installation Guide

Contents

1. Download the latest release
   1. Already have the Tracker?
   2. Easy/Express Install Method
   3. Manual Install Method
2. Load the Tracker script into your emulator
   1. Install for Bizhawk
      • Notes for Linux Users
      • Note for Parallels on Mac OS Users
   2. Install for mGBA
3. Setup the Ironmon Tracker
4. Start Playing!

Step 1: Download the latest release

Already have the Tracker?

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"

   

5. If something doesn't work quite right, you can try the alternative method.
   1. Restart the emulator and Lua scripting window, and remove any active Tracker scripts
   2. Load the UpdateOrInstall.lua file from the Tracker folder or latest release page
   3. Follow the prompts to complete installation

Easy/Express Install Method

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 folder or similar cloud storage folder
3. Open up your emulator (Bizhawk/mGBA)
4. From the menus at the top, locate and open the Lua Console / Lua Scripting Window
5. Load the script file you downloaded: UpdateOrInstall.lua
6. Follow the prompts to complete installation

Manual 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 "Documents". Avoid the following:
   • OneDrive folders (Note that OneDrive can take over your user folders such as "Desktop" and "Documents").
     • C:\Users\username\OneDrive\Desktop\Tracker will not work as OneDrive will restrict access to the Tracker's files.
   • Filepaths where any folder name has non-english characters such as ü and é.
     • C:\Users\üsernáme\Pokémon\Tracker\ will not work as the Tracker is unable to handle non-english characters when looking for its files.
   • System folders.
     • Directly on C:\ or in C:\Program Files will not work as the Operating System can restrict access to files in these locations.

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.

   NOTE: There appears to be an issue on linux where the text is all blurry / pixellated even with the correct font. It's been brought up to the Bizhawk devs here though we don't know if there's an easy fix/solution for this issue.

Note for Parallels on Mac OS Users

Very occasionally we've seen people attempting to run Bizhawk on Mac OS via Parallels Desktop and having issues (particularly file permission issues like "unable to save custom theme" errors).

While we're not too familiar with using Parallels or how to set things up there, usually what fixed the issues for these people is putting the tracker folder on "This PC" instead of "Documents" / elsewhere so give that a try if you have similar issues.

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

   

6. Once the tracker is loaded and you've loaded a ROM into mGBA the scripting window should look something like this:

   NOTE: The tracker is text-based and only in the scripting window itself due to current limitations with mGBA's lua scripting

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 New Runs feature to load up the next seed, then be sure to set this up under Tracker Setup -> New Runs
   • When you activate the Tracker's New Runs feature, it automatically creates a new randomized ROM or loads the next one from a batch you provide
   • Load a New Run by pressing and holding 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!