From be69b1cc67e5324dfcba0fc5f768449c6e5498b4 Mon Sep 17 00:00:00 2001 From: Kevin Lubick Date: Thu, 24 Jul 2014 13:05:07 -0400 Subject: [PATCH] More details on getting up and running Also added a more stable link to BizHawk 1.6.1 Newer versions don't seem to work, the bot doesn't seem to detect the main menu and gets stuck pressing start. Also, the linked site has most of the links down, so the cannon release site should be more stable. --- Readme.md | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/Readme.md b/Readme.md index b0e9b1f..7bc0bf3 100644 --- a/Readme.md +++ b/Readme.md @@ -11,9 +11,31 @@ PokéBot's official streaming channel on Twitch. Consider following there to fin Try it out ========== -Running the PokéBot on your own machine is easy. You will need a Windows environment (it runs great in VM's on Mac too). First, clone this repository (or download and unzip it) to your computer. Install the [BizHawk 1.6.1](http://down.emucr.com/v3/10194002) emulator, and procure a ROM file of Pokémon Red (you should personally own the game). +Running the PokéBot on your own machine is easy. You will need a Windows environment (it runs great in VM's on Mac too). First, clone this repository (or download and unzip it) to your computer. Download the [BizHawk 1.6.1](http://sourceforge.net/projects/bizhawk/files/BizHawk/BizHawk-1.6.1.zip/download) emulator, and procure a ROM file of Pokémon Red (you should personally own the game). -Open the ROM file with BizHawk, and Pokémon Red should start up. 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! + +##About BizHawk## +BizHawk 1.6.1 (Windows only) is the only version known to work. Later versions, like 1.7.2a do not seem to work, due to differences with reading bytes from memory. + +Run the [prereq installer](http://sourceforge.net/projects/bizhawk/files/Prerequisites/bizhawk_prereqs_v1.1.zip/download), which should update a C++ distributable needed by BizHawk + +You can unextract BizHawk-1.6.1.zip anywhere. + +##Setting up and verifying the ROM## +The ROM file should `Pokemon Red.gb`. The file name doesn't matter, but upload it to http://www.fileformat.info/tool/hash.htm to verify it's the US version. The linked website will spit out lots of hashes, make sure the two below match: +``` +MD5: 3d45c1ee9abd5738df46d2bdda8b57dc +SHA-1: ea9bcae617fdf159b045185467ae58b2e4a48b9a +``` + +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 unextracted. + + +##Running the bot## +If you want to test the full run, change [this line](https://github.com/kylecoburn/PokeBot/blob/52232581f227b829ea283d795ddaf60a52ce24fe/main.lua#L4) to be false. +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! Seeds =====