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

Update readme for Yellow

This commit is contained in:
kyle 2015-05-07 18:28:51 -07:00
parent eaf975a3fa
commit 32a6f761aa
1 changed files with 15 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
Readme.md
View File

@ -2,12 +2,19 @@
An automated computer program that speedruns Pokémon generation 1 games.
![Nidoking Running (by MoofinSeeker)](http://static-cdn.jtvnw.net/jtv_user_pictures/panel-60552281-image-c4fbec3cb87cecc1-320.png)
Pokémon Red (Any% Glitchless) personal best runs:
* [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)
Pokémon Yellow (Any% Glitchless) personal best runs:
* [1:56:55](https://youtu.be/OgybaUCwQI0) (6 May 2015)
* [2:00:03](https://youtu.be/bGedRUr6ZXc) (3 May 2015)
## Watch live
### [twitch.tv/thepokebot](http://www.twitch.tv/thepokebot)
@ -18,15 +25,15 @@ PokéBot’s official streaming channel on Twitch. Consider following there to f
Running the PokéBot on your own machine is easy. You will need a Windows environment (it runs great in VMs on Mac/Linux too).
1. First, clone this repository (or download and unzip it) to your computer.
1. [Download the latest version](https://github.com/kylecoburn/PokeBot/releases) of PokéBot, and unzip it to your computer.
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.
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).
4. Procure a ROM file of Pokémon Red or Yellow (you should own the game).
5. Open BizHawk.exe, then drag your ROM file onto the window, and Pokémon Red should start up.
5. Open BizHawk.exe, then drag your ROM file onto the window, and the game should start up.
6. By default, the bot completes every run it can, without resetting if it gets too far behind its best run time. Set [`RESET_FOR_TIME` in `main.lua`](https://github.com/kylecoburn/PokeBot/blob/v1.4.4/main.lua#L3) to `true` instead of `false` to reset more aggressively, i.e. if you’re trying to get a new record.
@ -34,7 +41,7 @@ Running the PokéBot on your own machine is easy. You will need a Windows enviro
## 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.
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](wiki/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
@ -50,13 +57,15 @@ If you're interested in adapting the bot to other categories or games, we'd love
Kyle Coburn: Original concept, Red/Yellow routing
Michael Jondahl: Combat algorithm, Java bridge for connecting the bot to Twitch chat, LiveSplit, Twitter, etc.
Michael Jondahl: Combat algorithm, Java bridge for Twitch chat/responders, LiveSplit, DB, Twitter, etc.
### Special thanks
To [MoofinSeeker](http://www.twitch.tv/moofinseeker) - for the amazing channel description artwork (seen above).
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 [LiveSplit](http://livesplit.org) for providing the custom component for integrating in-game time splits.
To the [contributor community](https://github.com/kylecoburn/PokeBot/graphs/contributors) here, who have helped track seeds and improve the bot.