-
Notifications
You must be signed in to change notification settings - Fork 61
Installation Guide
jtigues edited this page Oct 24, 2023
·
55 revisions
- Download the latest release
- Load the Tracker script into your emulator
- Setup the Ironmon Tracker
- Start Playing!
- 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
- To do so, open your emulator with a game ROM and the Ironmon Tracker loaded
- Click the Gear icon at the top of the Tracker screen, then click Update. You may have to click "Check for Updates"
- Click "Update automatically", wait for the update to download and install, then click "Restart Tracker"
- If something doesn't work quite right, you can try the alternative method.
- Restart the emulator and Lua scripting window, and remove any active Tracker scripts
- Load the
UpdateOrInstall.lua
file from the Tracker folder or latest release page - Follow the prompts to complete installation
- Download the
UpdateOrInstall.lua
file at the bottom of the latest release page - 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
- Open up your emulator (Bizhawk/mGBA)
- From the menus at the top, locate and open the Lua Console / Lua Scripting Window
- Load the script file you downloaded:
UpdateOrInstall.lua
- Follow the prompts to complete installation
- Download the latest
Ironmon-Tracker-#.#.#.zip
file at the bottom of the latest release page - Extract the contents of the
.zip
file with right-click -> "Extract All" in Windows, or by using a program such as 7-zip - Optional: Move the entire folder somewhere easy to find, such as "My Documents"
Notes:
- Avoid keeping the Tracker folder and files inside of a OneDrive folder or any folder whose full path contains an accented character (e.g. C:\Users\usérname\Pokemon\Tracker). This will prevent several of the Tracker's features from working properly, including the auto-updater.
- Also avoid keeping the Tracker folder in any System folders, such as directly in "C:", or "C:\Program Files", as the Operating System can prevent the Tracker from updating files here.
- If you haven't already, download the latest Bizhawk version (2.8 or higher is required) and install necessary prereqs
- Open the Bizhawk emulator (EmuHawk.exe) and load a Pokémon game ROM (See supported games here.)
- In the Bizhawk menus at the top, click
Tools -> Lua Console
- If there are any existing Ironmon Tracker scripts, highlight them one at a time and remove them: click the
X
icon button or press theDelete
key - Click
Script -> Open Script...
or pressCtrl+O
- Locate and select the
Ironmon-Tracker.lua
script file from the new Ironmon-Tracker release folder you downloaded, and open it - 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 ofOpen Script
- If you haven't loaded a ROM yet, the Lua Console should look something like this:
- 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.
- 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.
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.
- If you haven't already, download the latest mGBA version (0.10.0 or higher is required)
- Open the mGBA emulator and load a Pokémon game ROM (See supported games here.)
- From the emulator menus at the top, click
Tools -> Scripting
- In the console window, click
File -> Load Script
- Then locate the
Ironmon-Tracker.lua
file in the Tracker folder, and open it - Once the tracker is loaded and you've loaded a ROM into mGBA the scripting window should look something like this:
The tracker is text-based and only in the scripting window itself due to current limitations with mGBA's lua scripting
- At this point, you can load up a game ROM and/or unpause your game if you haven't already
- 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.
- 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 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
- Now that you've got everything setup, you're ready to start playing and enjoy using the Tracker
- 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
- If you are a streamer, check out our Streamer Setup Tips!