This project is under active WIP! Things are usable, although not consumer friendly. Join our Discord Server to stay up to date!

Pokemon Stream Tool

Pokemon ST is a tool that manages dynamic overlays with the help of a GUI. But what can it really do? Let me show you a feature list:

Manage your active pokemon party (species, nickname, lvl, health...).
Manage your player's info (badges, stats...).
Display stats for current wild encounter.
Store your catches to be displayed on a "Waiting to start" scene.
Gen 6 auto-update for your current player party, reading directly from Citra (or Citra-likes).
- Also reads battle enemies, revealing hidden info as it's shown in-game, automatically.
Remote GUI so multiple people on different devices can manage the overlay info at the same time.
Download it right here, right now! No need to join any Discord server.
Crossplatform GUI (Windows, Linux), built on Electron.
Made to be customized! Just dive into the folders and modify the tool to your heart's content.

For the moment, the tool comes with overlays included for:

X and Y (regular overlay):

X and Y (trainer battle)

Black and White 2:

Stream intro (uses data from your previous catches):

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 and drop the .html file found on that folder 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.

readek / pokemon-stream-tool Goto Github PK