Ironmon-Tracker is a collection of lua scripts for the Bizhawk emulator (v2.8 or higher) or mGBA emulator* (v0.10.0 or higher) used to track IronMon attempts.
* mGBA's lua scripting is currently limited and doesn't provide any drawing functionality, this means the tracker on mGBA is purely text-based in the scripting window as we can't draw images/screens like on Bizhawk.
For more information on IronMon, see http://ironmon.gg
We have a set of Wiki pages documenting various parts of the tracker, including a full Feature List.
If you have any issues using the tracker, check the FAQ & Troubleshooting page first to see if your issue has a known solution. If your issue isn't listed there, or if you find any bugs or have feature requests, feel free to create a GitHub issue or let us know in the IronMon Discord server.
This project is based on MKDasher's PokemonBizhawkLua project.
For NDS (gen 4/5) games, please use the NDS IronMon Tracker by OnlySpaghettiCode
Currently supported Pokémon games / languages:
Version | Ruby | Sapphire | Emerald | FireRed | LeafGreen |
---|---|---|---|---|---|
English | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
Spanish | ❌ | ❌ | ❌ | ✔️ | ❌ |
French | ❌ | ❌ | ❌ | ✔️ | ❌ |
Italian | ❌ | ❌ | ❌ | ✔️ | ❌ |
German | ❌ | ❌ | ❌ | ✔️ | ❌ |
Want to help us translate the Tracker into supported languages? Check out our discussion thread to help contribute!
We'd ideally like to support all non-English versions if we can, progress updates can be found here.
Read more about this cool new feature here: Stream Connect Guide
See the project's Wiki for a full Version Changelog.
If you'd like to contribute to the tracker, great! Here's some information for you on our processes and setup.
If you're planning to implement a new feature, we'd ask that you either open a feature request issue on GitHub or talk to us in the Ironmon Discord server about your idea first. This is so we can discuss if it's a good fit for the tracker and how best to implement the feature, before you go through any effort of coding it up.
Generally, we try to avoid revealing too much information that a player can't gather themself in-game in some way. For example, we won't show a Pokémon's EVs and IVs directly as you don't get that information in the games. We also like to try and make toggleable options for certain features for those that would rather have them disabled.
Additionally, if the feature involves a UI element on the tracker screen, we want to make it as clear and simple to use as we can. There's limited space on the tracker screens so we also want to avoid cramming too many things in or extending the current size of the tracker (as this would mess with many people's stream layouts).
There are a couple of VS Code extensions which we recommend, which should automatically be recommended to you in your VS Code:
Lua Versions:
.vscode/settings.json
file for linting.Emu-specific Lua documentation:
The primary branches of the Ironmon-Tracker repository are as follows:
Make your PRs to the Dev branch.
The workflow we'd recommend for contributing: