A Bot Programmed to Play Pokemon Perla. At this current stage, the bot saves the game, and walks the player from left to right, if the pixel underneath the mouse cursor is the same color as the in-game sprite's head (i.e. if the mouse is hovered over the character). When a battle is initiated, PerlaBot presses the X key (the A Button) until the battle ends. However, if the battle lasts longer than 3 minutes, PerlaBot assumes that the lead move is out of PP, subsequently running away and switching the move order. If the switch tag is set, then PerlaBot switches the positions of the first and second Pokémon in the party. Currently, PerlaBot is functional in Pokemon Perla (a bootleg of Pokemon Ruby), with updates coming soon for functionality in Pokemon Ruby, Sapphire, Emerald, FireRed, LeafGreen, and ChaosBlack (a bootleg of FireRed). PerlaBot is written in Python.
It should also be noted that PerlaBot has a "failsafe" method programmed in; if you move your mouse to the upper-left corner of your computer screen, the programme will automatically stop.
PerlaBot requires PyAutoGUI, PyScreeze, and Pillow, which can all be installed using pip:
pip install pyautogui pyscreeze Pillow
For Mac OSX, PyAutoGUI requires the modules pyobjc-core and pyobjc.
For Linux distributions, PyAutoGUI requires either python3-xlib (for Python 3) or python-xlib (for Python 2).
Additionally, Linux distributions further require scrot, for pixel colour detection. scrot can be installed through any of the following methods:
For Debian-based distributions (Debian, Ubuntu, Linux Mint):
sudo apt-get install scrot
For Red Hat-based distributions (CentOS, SUSE, openSUSE):
sudo yum install scrot
For Fedora:
sudo dnf in scrot
For Arch-based distributions (Arch Linux, Manjaro):
sudo pacman -S scrot
Emulator controls should be set as follows:
| Computer Key | Gameboy Equivalent |
|---|---|
| X key | A button |
| Z key | B button |
| Enter/Return key | Start button |
| Up key | Up |
| Down key | Down |
| Left key | Left |
| Right key | Right |
PerlaBot may be activated by invoking the following:
python perla.py [-h] [-w WAIT] [-s] [-g GAME] N -x SEX
positional arguments:
| Argument(s) | Description |
|---|---|
| N | amount of time (in minutes) that perla runs for |
| -x SEX, --sex SEX | gender of the in-game character (either Male or Female) |
optional arguments:
| Argument(s) | Description |
|---|---|
| -h, --help | show help message and exit |
| -w WAIT, --wait WAIT | amount of time (in minutes) that perla waits before running (defaults to one minute, if no input) |
| -s, --switch | switch the first and second Pokemon in your party |
| -g GAME, --game GAME | game version for which you want to use PerlaBot (either Sapphire, Ruby, Emerald, Perla, FireRed, LeafGreen, or ChaosBlack; default is Perla) |
python perla.py 20 -w 2 -s -g ChaosBlack -x Female
In this example, the bot runs for 20 minutes after a two minute waiting period. The game is set to ChaosBlack and the in-game character's gender is female. Additionally, because the switch tag is set, the first and second Pokemon in your party are switched.
If you would like to contribute to this project, clone the repository and start making pull requests! I'll review them from there. Any help is greatly appreciated!
git clone https://github.com/jacksemancik/PokemonPerlaBot.git
This programme is licensed under the MIT License. For more information, read the full license!
This programme was created by John "Jack" Frank Semancik V in 2017.