Shiny-Tracker is a collection of lua scripts for the Bizhawk emulator (v2.8 or higher) used to track Shiny hunts.
This project is based on MKDasher's PokemonBizhawkLua project.
Currently supported (and tested) Pokémon games / languages:
| Version | Ruby | Sapphire | Emerald | FireRed | LeafGreen |
|---|---|---|---|---|---|
| English | ❌ | ❌ | ❌ | ✔️ | ❌ |
| Spanish | ❌ | ❌ | ❌ | ❌ | ❌ |
| French | ❌ | ❌ | ❌ | ❌ | ❌ |
| Italian | ❌ | ❌ | ❌ | ❌ | ❌ |
| German | ❌ | ❌ | ❌ | ❌ | ❌ |
- Download the Tracker
- You can get the latest project release from the Releases section of this Github repository.
- Get a Supported Emulator
- We recommend using the Bizhawk emulator (Windows/Linux only)
- Download Bizhawk (v2.8 or higher)
- If you are on Windows, make sure to also download and run the prereq installer first
- If you are on Linux, we recommend using Bizhawk 2.9 or higher
- We recommend using the Bizhawk emulator (Windows/Linux only)
- Install and Setup
- See the full Installation Guide for more detailed instructions for installing or upgrading.
- If you are on Linux, you'll also want to install the Franklin Gothic Medium font.
- Quickstart Guide
- After getting it all setup, check out the Quickstart Guide for an overview on how to use the Tracker and learn about all of the information that it displays.
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, I'd ask that you either open a feature request issue on GitHub or talk to me in my 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.
The tracker is for more easily tracking and displaying stats around legitimate shiny hunts, not for more easily getting a shiny. As such, any feature ideas/requests should be around improving the hunt tracking experience and not interfere with actual game code/memory at all other than in a read-only fashion.
Additionally, if the feature involves a UI element on the tracker screen, I want to make it as clear and simple to use as I 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:
- EditorConfig: To help with consistent formatting.
- vscode-lua: Provides intellisense and linting for Lua.
- Lua: This is Trevor's preferred Lua intellisense extension, provided in addition to the one recommended by the Shiny Team.
Lua Versions:
- Bizhawk 2.8 uses Lua 5.1, this is the version currently set in our
.vscode/settings.jsonfile for linting. - Bizhawk 2.9 uses Lua 5.4
- Since we intend to still support Bizhawk 2.8 the code must be compatible with both Lua 5.1 and 5.4
Emu-specific Lua documentation:
The primary branches of the Shiny-Tracker repository are as follows:
- Main: This is kept in a state of the latest release. We merge into this branch from dev when we are ready to do the final checks and make a new release.
- Dev: This is essentially the "staging" build of the next release, where the majority of contributions merge into.
- Beta-Test: This branch is for test builds that Tracker users can opt-in to trying out. It regularly gets updated with new features from the dev branch.
Make your PRs to the Dev branch.
The workflow we'd recommend for contributing:
- Create a fork of the repository.
- Create a branch on your local fork for your new feature/contribution. Make your commits to this branch.
- When you are ready to send it to us for review, open a Pull Request back to this repository. Request to merge into the Dev branch.
- We'll review the Pull Request and decide whether it needs some changes / more work or if we're happy to merge it in.