bouletmarc
/
PokeBot
mirror of https://github.com/bouletmarc/PokeBot.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add historical PB, add other categories section, simplify setup language

This commit is contained in:
kyle 2015-04-15 21:15:12 -07:00
parent ee3babd3db
commit 6510c0d160
1 changed files with 20 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
Readme.md
View File

@ -1,11 +1,12 @@
# PokéBot
An automated computer program that speedruns Pokémon Red, Blue, or Yellow.
An automated computer program that speedruns Pokémon generation 1 games.
Here are the bot’s best runs so far in the Pokémon Red Any% Glitchless category:
Pokémon Red (Any% Glitchless) personal best runs:
* [1:50:14 (13 April 2015)](https://www.youtube.com/watch?v=lVE_ksd4WJw)
* [1:51:11 (23 June 2014)](https://www.youtube.com/watch?v=M4pOlQ-mIoc)
* [1:50:14](https://www.youtube.com/watch?v=lVE_ksd4WJw) (13 April 2015)
* [1:51:11](https://www.youtube.com/watch?v=M4pOlQ-mIoc) (23 June 2014)
* [1:56:45](https://youtu.be/yh3hI2xNvh4) (7 May 2014)
## Watch live
@ -21,31 +22,30 @@ Running the PokéBot on your own machine is easy. You will need a Windows enviro
2. Download the [BizHawk 1.6.1](http://sourceforge.net/projects/bizhawk/files/BizHawk/BizHawk-1.6.1.zip/download) emulator and extract the ZIP file anywhere you like to “install” it.
**Note:** BizHawk v1.6.1 (Windows only) is the only version known to work. Later versions like v1.7.2a do not seem to work, due to differences with reading bytes from memory.
**Note:** BizHawk v1.6.1 (Windows only) is the only version known to work.
3. Run [the BizHawk prerequisites installer](http://sourceforge.net/projects/bizhawk/files/Prerequisites/bizhawk_prereqs_v1.1.zip/download), which should update a C++ distributable needed by BizHawk.
4. Procure a ROM file of Pokémon Red (you should personally own the game).
The ROM file has a name like `Pokemon Red (UE) [S][!].gb`, but the file name doesn’t matter. Upload it to [fileformat.info/tool/hash.htm](http://www.fileformat.info/tool/hash.htm) to verify it’s the correct version. The linked website will spit out lots of hashes; make sure the two below match:
5. Open BizHawk.exe, then drag your ROM file onto the window, and Pokémon Red should start up.
```
MD5: 3d45c1ee9abd5738df46d2bdda8b57dc
SHA-1: ea9bcae617fdf159b045185467ae58b2e4a48b9a
```
6. If you want to test the full run, set [`RESET_FOR_TIME` in `main.lua`](https://github.com/kylecoburn/PokeBot/blob/0fd1258ca17f7d74edbac72fa0afc2b5c6d58bb3/main.lua#L3) to `false` instead of `true`.
Open the ROM file with BizHawk (drag the `.gb` file onto EmuHawk), and Pokémon Red should start up.
The colors may look weird. To fix this, go to _GB_ → _Palette Editor_, and then find the `POKEMON RED.pal` file which should be under _Gameboy_ → _Palettes_ in the directory where BizHawk was extracted.
5. If you want to test the full run, set [`RESET_FOR_TIME` in `main.lua`](https://github.com/kylecoburn/PokeBot/blob/0fd1258ca17f7d74edbac72fa0afc2b5c6d58bb3/main.lua#L3) to `false` instead of `true`.
6. Then, under the _Tools_ menu, select _Lua Console_. Click the “open folder” button, and navigate to the PokéBot folder you downloaded. Select `main.lua` and press “open”. The bot should start running!
7. Under the _Tools_ menu, select _Lua Console_. Press the “open folder” button, and navigate to the PokéBot folder you downloaded. Select `main.lua` and press “open”. The bot should start running!
## Seeds
PokéBot comes with a built-in run recording feature that takes advantage of random number seeding to reproduce runs in their entirety. Any time the bot resets or beats the game, it will log a number to the Lua console that is the seed for the run. If you set `CUSTOM_SEED` in `main.lua` to that number, the bot will reproduce your run, allowing you to [share your times with others](Seeds.md). Note that making any other modifications will prevent this from working. So if you want to make changes to the bot and share your time, be sure to fork the repo and push your changes.
## Other Categories
The bot is designed to run "any% glitchless" (beat the game as fast as possible, without major glitches) categories - the most popular in the speedrunning community. However, the bot can easily be adapted for other purposes including use in testing frame data for human players, or to run different categories of the game.
[Red Any% No Save Corruption](https://github.com/bouletmarc/PokeBot) by [Marc-Andre Boulet](https://github.com/bouletmarc)
If you're interested in adapting the bot to other categories or games, we'd love to see it, and are happy to help answer questions.
## Credits
### Developers
@ -56,6 +56,8 @@ Michael Jondahl: Combat algorithm, Java bridge for connecting the bot to Twitch
### Special thanks
To our Twitch chat moderators who help answer questions, and make the stream a great place to hang out.
To LiveSplit for providing custom component for integrating in-game time splits.
To the Pokémon speedrunning community members who inspired the idea, and shared ways to improve the bot.
To the Pokémon speedrunning community members who inspired the idea, and shared their knowledge on ways to improve the bot.