This project is under active WIP! Join our Discord Server to stay up to date!

Pokemon Stream Tool

Pokemon ST allows you to manage dynamic overlays with the help of a GUI, with features like:

• Manage your game's info.
  • Player's party, with info for nickname, lvl, health values...
  • Your badges and stats like Pokemon catched or allied Pokemon deaths.
  • Enemy data that gets revealed as the battle goes on.
  • Current wild encounter with its possible stats and abilities.
  • Store your catches to be displayed on a "Waiting to start" scene.
• Gen 6/7 auto-update for player party, badges and enemy data, reading directly from Citra (or Citra-likes).
• No auto for your game? Worry not, everything can be done manually within the GUI.
  • Manual mode supports up to Scarlet/Violet.
• You can use the included overlays for OBS with minimal setup, or make your own.
• Remote GUI so multiple people on different devices can manage the overlay info at the same time.
• Supports multiple languages!
  • Fully localized: English, Spanish (ES).
  • Pokemon, Items, Abilities and Move names: French, German, Italian, Japanese.
• Crossplatform GUI (Windows, Linux), built on Electron.
• Made to be customized! Dive into the folders and modify the entirety of the tool to your heart's content.
• Download it right here, right now! No need to join any Discord server.

The tool comes with pre-made overlays for some games, like:

• X and Y (regular overlay):

• X and Y (trainer battle)
  • Enemy info is hidden until the move gets revealed in-game.

More Screenshots

• Black and White 2

• Omega Ruby and Alpha Saphire

• Stream intro (uses data from your previous catches) (background not included):

Stream.Intro.mp4

• Trainer battle intro

Trainer.battle.intro.mp4

How to

There are no public official releases yet, but if you really want to try this out, you can start by getting the latest dev build.

Once you got the thing downloaded, open the Stream Tool folder and simply start the executable, and play around!

To add overlays to your stream, go into the Stream Tool/Overlays/ folder and select the one you want, then simply drag the .html file found on that folder and drop it onto OBS. As long as the GUI is open, everything should be already connected!

Check here to learn how to use the Remote GUI.

Pokémon sprites repo

The overlay uses sprites from Pokémon Showdown, which aren't included in this repo. Instead of depending on Showdown, these are fetched from another repository entirely. The tool will automatically download sprites to be used locally, but if for any reason that fails, you can head over to the resources' own repository. More info about assets can be found there.

---

Used libraries

• @pkmn, main Pokemon data library used.
• encoding.js, to translate Unicode to regular text.
• Mousetrap, to handle some hotkeys.
• Electron, duh.

References

• PokeStreamer Tools for being the spark that initiated the hard and arduous journey of gen6/7 memory reading.
• PKM Structure for providing most of gen6 party memory data.
• Pokelink's Nimbus Fox for helping me with some gen 6/7 memory addresses making that journey a hell of a lot easier.
• Bulbapedia for providing a list of Pokemon's names, moves, items and abilities in different languages.