Getting started
This page will walk you through how to set up your own instance of a pokebot-bizhawk.
Please follow this guide carefully before asking for help in the #bot-support❓ channel. If you do need help, please provide a clear and concise description of your issues, along with any screenshots and error logs.
First up, you will need to install a few things:
Download and install the Python 3.11 (important: during the install, tick Add python.exe to PATH).
Download and install Bizhawk prereqs, under Assets > bizhawk_prereqs_vx.x.x.zip (this includes .NET and other frameworks for Bizhawk to run).
Download and extract Bizhawk (emulator) 2.9 (extract this somewhere you will remember, your save data will saved in GBA/SaveRAM so make sure you back it up if you ever upgrade Bizhawk).
Run EmuHawk.exe to launch Bizhawk.
Load up and start a supported game (bring you own ROM, please do not ask anyone in Discord for them).
Config > Hotkeys > Tools > Change the keybind for "Lua Console" (I just use the L key for Lua).
Config > Customize... > Untick Pause when menu activated, also tick Run in background.
Tools > Lua Console > File > Recent Scripts > Tick Autoload Script (this saves a lot of clicking if you're constantly restarting the Lua script in Bizhawk).
To display gamepad inputs on-screen go to View > tick Display Input.
Download the latest copy of the bot here (optionally git clone this repo if you know how to use git).
Make a new folder called pokebot-bizhawk.
Extract pokebot-bizhawk-main.zip into pokebot-bizhawk.
In the pokebot-bizhawk folder you just extracted and install the required Python modules using one of the following options:
- Option 1: Double click
requirements.py(it should open a Python window) and automatically install the required Python modules. - Option 2: Open a terminal in the
pokebot-bizhawkfolder and runpython.exe -m pip install -r .\requirements.txt.
Visit Wiki:Config file to learn how to configure the bot to run in the desired mode (default bot mode: Starter Pokemon soft resets).
Set your trainer in the correct location for the bot_mode you have set in config.yml in step 3.
Open the Bizhawk Lua Console (Tools > Lua Console), then go to Script > Open Script and open pokebot.lua from the pokebot-bizhawk folder (note: you will lose control of your trainer while pokebot.lua is running, you can pause the Lua script at any time).
Finally, start the bot by double clicking bot.py file to launch Python (or run python.exe .\bot.py in a terminal)!