Tracker Add ons - besteon/Ironmon-Tracker GitHub Wiki

What are Add-ons?

Occasionally a new feature will get added to the Tracker that is either quite large in file size or requires additional code that needs to be separate from the main project. These are add-ons and are available as an extension to the main project. Information on how to install the add-on to the Ironmon Tracker and any required files/downloads will be available on this page.

Available Add-ons

Animated Pokemon Pop-out

image

About

Version Compatibility: v0.6.1+

This feature add-on allows the Tracker display the lead Pokémon in your party as a 3D animated mode, opened in a separate transparent window (Bizhawk) or by creating a GIF in the tracker folder (mGBA). You can add this window/GIF as a source to your stream setup and display it anywhere on your overlay.

Required Files

Install and Setup

  1. Download and extract the required files, using a program such as 7-zip or Windows -> Extract All

  2. Open the extracted folder and locate the pokemonAnimated folder

  3. Move the entire pokemonAnimated folder to your Tracker by placing it in the /ironmon_tracker/images folder:

    image

  4. Reload the Tracker script in the Lua Console, or simply turn it off and on again

  5. Enable the Feature:

    • Bizhawk: Toggle the "Animated Pokemon Popout" setting in the Tracker Extras menu, which you can access by clicking the Gear icon near the top of the Ironmon Tracker -> Extras -> Options.
      • If this option is highlighted in red (or your theme's "Negative Text" color), then the Tracker doesn't detect the pokemonAnimated folder. In this case carefully go through the previous steps again and make sure this folder is in the right place, extracted out of the zip file, and that you've reloaded the Tracker script.

        image

    • mGBA: Toggle the option by entering the command OPTION "9" into the scripting console. The option number may have changed, so double-check. You can check if the setting is enabled under the GENERAL SETUP sidebar menu.

      image

  6. Finally, check out the Usage Notes below for adding the animated pokemon to your stream layout.

Usage Notes

Bizhawk

  • Currently the 3D Pokémon models can only be drawn from the bottom-up on the pop-out window
  • Use Window Capture when adding the pop-out window source to your stream setup. Recommended settings for the capture are:
    • [Emuhawk.exe]: Animated Pokemon
    • Capture Method: Automatic
    • Window Match Priority: Window title must match
    • Capture Cursor: OFF
  • The pop-out window uses a Magenta transparency color key. You can use this same color as a Chroma Key filter in your stream setup. You may need to tweak the filter attributes a bit to get it just right, but a good starting point is:
    • Key Color Type: Magenta
    • Similarity: 300
    • Smoothness: 80
    • Key Color Spill Reduction: 100

mGBA

  • mGBA's lua scripting does not currently have the functionality to open the 3D model in a pop-out window, instead an AnimatedPokemon.gif file will be created in the tracker's folder for the lead Pokémon in your party.
  • You can add this GIF to your stream layout as an Image Source in OBS/similar.
  • This GIF will already have a transparent background, so you don't need to worry about Chroma Key filters.

    image

Custom Code Extensions

About

Version Compatibility: v7.3.0+

Extensions allow the Tracker to load and execute custom code that other users have written. These extensions (code file packages) integrate with the Tracker script to allow for any number of customizations, whether they are new features or improvements to existing features. Developers can create and share their own extensions with ease. The possibility of what these scripts can do are limitless, have fun coding!

While custom extensions are not part of the main Tracker project code, they are upgrade-safe! This means that future Tracker updates won't remove these extensions or customizations.

User-Created Extensions

The following extensions have been verified by the Tracker project team.

Want to create and share your own custom extension? Open a GitHub Issue and post your extension idea and/or code.

Extension Author Version Description Usage Instructions
Emerald & FireRed Nat. Dex CyanSMP64 1.1.3 The original ROM hack designed for the IronMON challenge with a total of 1209 different Pokémon. Wiki
Smacker Tracker WaffleSmacker 1.3 Keep data from all your Ironmon seeds and view them in a dashboard. README
Auto Pokémon Themes Fellshadow 1.2 Automatically load unique custom themes for each of your lead Pokémon. README
Pokémon Stadium Brows ninjafriend 1.2 Puts eyebrows on all the Pokémon while on the Tracker Screen. README
Walking Pixel Pokémon eiphzor 2.1 Replaces the Animated Pokémon Pop-out sprites with walking pixel variants from HGSS. README
I'm Attached UTDZac 1.3 This simple extension adds a heart button to the Tracker screen, to let you and your viewers know that you're "attached" to your Pokémon. README
Auto-Pedometer ninjafriend 1.1 Automatically enables the Tracker's pedometer in Mt. Moon and the Underground Tunnels. README
Tourney Point Tracker UTDZac 3.3 This extension adds extra functionality to the Tracker for counting and displaying points, great for friendly competitions. README
Pokémon Infinite Fusion UTDZac 2.0 Fuse two Pokémon together from the Pokémon Infinite Fusion game. README
Calc Atk Dmg Calculator UTDZac 1.1 Estimate an enemy Pokémon's attacking stat using a reverse damage formula calculation. README
Sprite Is Me UTDZac 1.4 You become the Pokémon! README
Death Quotes UTDZac 1.1 Let's you change the death quotes that appear on the Game Over screen. README
Faster Battle Intro Subwild 1.2 This simple extension fast forwards the battle animation. README

Install and Setup

  1. Download any of the User-Created Extensions above or create your own using the CodeExtensionTemplate.lua.txt example
  2. Extract the downloaded zip file, using a program such as 7-zip or Windows -> Extract All
  3. Move the contents of the extracted folder to the extensions folder found in your main Tracker folder

    image

  4. Click the Gear icon on the Tracker screen to access the settings, then click the "Extensions" button
  5. On the Extensions menu, make sure to enable "Allow custom code to run" (if it is currently disabled)
  6. Click the "Install New" button to have the Tracker check for newly installed extensions
  7. Click on each individual extension to enable or disable it

Usage Notes

  • While it's unlikely that a Tracker update breaks any custom extensions, it is still a possibility given custom code is not maintained by the Tracker project team
  • When creating a new custom extension, avoid using spaces or non-English characters/symbols in the filename of your extension; stick with alphanumeric characters only