Welcome to Pokémon Automation's official GitHub group.
Pokémon Automation is a project that strives to automate the Pokémon games.
Certain aspects of Pokémon are very boring and tedious (such as shiny hunting). So rather than spending hundreds of hours grinding with manual gameplay, you have a bot do it for you. Thus the fun changes to managing the bots that play the game for you.
With automation, it becomes possible to play 24/7 and simultaneously on multiple devices without wasting too much of your own time. Thus with so much extra game time, it becomes possible to legitimately obtain extremely rare Pokémon that are normally only feasible via hacking.
The Nintendo Switch allows the use of 3rd party wired controllers. But instead of using an actual game controller, we emulate a controller using a microcontroller such as an Arduino. This microcontroller can then be programmed to send button presses to the Switch. Once programmed, all that is needed is to plug the microcontroller into your Switch's USB port just like any handheld controller and watch it do its thing.
This approach is not new. brianuuuSonic's AutoController(1) was (probably?) the first to do this for Switch-based Pokémon games.
Our version of these "microcontroller-only" programs can be found in the Microcontroller Repo(2).
While most automation is entirely Arduino or microcontroller based, we have taken it to a new level. We connect the microcontroller to a PC to utilize the full computing potential of a modern computer. This allows us to perform visual recognition of the display and make gameplay decisions the same way a human player would.
This has allowed us to automate every single shiny hunt in Pokémon Sword/Shield as well as a good portion of the newer games.
These "computer-controlled" programs can be found in our Computer-Control Repo(3).
Examples:
Automatic detection of shiny encounters using visual recognition of the shiny sparkle animation.
Automatic playthrough of Dynamax Adventures to shiny-hunt legendaries.
Shiny detection in Pokémon Legends Arceus using audio recognition.
Interested? This is PART 1
Choose the link below that aligns with your experience with electronics.
| Beginner | Experienced |
|---|---|
| I don't know what a circuit is. | I have a degree in electrical engineering. |
| I have not used a microcontroller before. | I have used a microcontroller before. |
| I'm impatient and I don't want to think. Just make it work ASAP! | Give me options for me to choose from. |
| I'm new to GitHub. | I've have experience with GitHub. |
Contributors:
- Kuroneko (Kuroneko#6019) - Project founder.
- Gin (Gin#2531) - R&D, Program+Framework development, Qt6, audio, and Mac support.
- pifopi (pifopi#7834) - R&D, AutoMaxlair, Program+Framework Development.
- MrDonders (MrDonders#4095) - R&D, AutoMaxlair, pioneer of serial hardware.
- Koi (Koi#3088) - Discord bot integration.
- denvoros (denvoros#0001) - AI R&D, AutoMaxlair, Build scripts, Mac support.
- SakuraKim (SakuraKim#9422) - R&D, Program+Framework Development.
- Fye (Fye#7349) - Program Development
- Ryder (_Ryder#0149) - Documentation and wiki management.
- baboul (baboul#7130) - Program Contributor
- joyrida (JoyRida#6391) - Build scripts and Mac support.
- Ptamalion (Ptamalion#1167) - Program Contributor and Qt6 support.
- Icaroto (Icaroto#9259) - Program Contributor
- b0bness (b0bness#9479) - Program Contributor
- kichithewolf (kichithewolf#5141) - Program Contributor
And countless users and testers in the Pokémon Automation Discord Server.
As of this writing, we do not take donations of any kind for this project. The only support we request is by sharing our work with your friends if you have enjoyed using it. In the spirit of transparency, we kindly ask that you disclose the use of automation when sharing photos or videos of Pokémon obtained using these programs. This can be done simply by sharing a screenshot of the program with stats or with a text footer indicating it is done by automation.
If such a disclosure is not permissible, we ask that you avoid any explicit or implicit claims that such Pokémon were caught manually.
You are free to use our software personal use only.
Do not try to profit off of these programs. It's just a game; keep the money out of it and have fun.
For all other uses, please reach out to the administrators of the Pokémon Automation discord server.
This software is provided "as is" and the developers disclaim all warranties with regard to this software including all implied warranties of merchantability and fitness. In no event shall the developers be liable for any special, direct, indirect, or consequential damages, or any damages whatsoever resulting from loss of use, data or profits, whether in an action of contract, negligence or other tortious action, arising out of or in connection with the use or performance of this software.