91 lines
		
	
	
		
			5.1 KiB
		
	
	
	
		
			Markdown
		
	
	
	
	
	
			
		
		
	
	
			91 lines
		
	
	
		
			5.1 KiB
		
	
	
	
		
			Markdown
		
	
	
	
	
	
| # Setup Guide for MegaMan Battle Network 3 Archipelago
 | |
| 
 | |
| ## Important
 | |
| 
 | |
| As we are using Bizhawk, this guide is only applicable to Windows and Linux systems.
 | |
| 
 | |
| ## Required Software
 | |
| 
 | |
| - Bizhawk: [Bizhawk Releases from TASVideos](https://tasvideos.org/BizHawk/ReleaseHistory)
 | |
|   - Version 2.7.0 and later are supported.
 | |
|   - Detailed installation instructions for Bizhawk can be found at the above link.
 | |
|   - Windows users must run the prereq installer first, which can also be found at the above link.
 | |
| - The built-in Archipelago client, which can be installed [here](https://github.com/ArchipelagoMW/Archipelago/releases).
 | |
| - A US MegaMan Battle Network 3 Blue Rom. If you have the [MegaMan Battle Network Legacy Collection Vol. 1](https://store.steampowered.com/app/1798010/Mega_Man_Battle_Network_Legacy_Collection_Vol_1/)
 | |
| on Steam, you can obtain a copy of this ROM from the game's files, see instructions below.
 | |
| 
 | |
| ## Configuring Bizhawk
 | |
| 
 | |
| Once Bizhawk has been installed, open Bizhawk and change the following settings:
 | |
| 
 | |
| - **If you are using a version of BizHawk older than 2.9**, you will need to modify the Lua Core.
 | |
|   Go to Config > Customize. Switch to the Advanced tab, then switch the Lua Core from "NLua+KopiLua" to
 | |
|   "Lua+LuaInterface". This is required for the Lua script to function correctly.  
 | |
|   **NOTE:** Even if "Lua+LuaInterface" is already selected, toggle between the two options and reselect it. Fresh installs 
 | |
|   of newer versions of Bizhawk have a tendency to show "Lua+LuaInterface" as the default selected option but still load 
 | |
|   "NLua+KopiLua" until this step is done.
 | |
| - Under Config > Customize > Advanced, make sure the box for AutoSaveRAM is checked, and click the 5s button.
 | |
|   This reduces the possibility of losing save data in emulator crashes.
 | |
| - Under Config > Customize, check the "Run in background" and "Accept background input" boxes. This will allow you to
 | |
|   continue playing in the background, even if another window is selected, such as the Client.
 | |
| - Under Config > Hotkeys, many hotkeys are listed, with many bound to common keys on the keyboard. You will likely want
 | |
|   to disable most of these, which you can do quickly using `Esc`.
 | |
| 
 | |
| It is strongly recommended to associate GBA rom extensions (\*.gba) to the Bizhawk we've just installed.
 | |
| To do so, we simply have to search any GBA rom we happened to own, right click and select "Open with...", unfold
 | |
| the list that appears and select the bottom option "Look for another application", then browse to the Bizhawk folder
 | |
| and select EmuHawk.exe.
 | |
| 
 | |
| ## Extracting a ROM from the Legacy Collection
 | |
| 
 | |
| The Steam version of the Battle Network Legacy Collection contains unmodified GBA ROMs in its files. You can extract these for use with Archipelago.
 | |
| 
 | |
| 1. Open the Legacy Collection Vol. 1's Game Files (Right click on the game in your Library, then open Properties -> Installed Files -> Browse)
 | |
| 2. Open the file `exe/data/exe3b.dat` in a zip-extracting program such as 7-Zip or WinRAR.
 | |
| 3. Extract the file `rom_b_e.srl` somewhere and rename it to `Mega Man Battle Network 3 - Blue Version (USA).gba`
 | |
| 
 | |
| ## Configuring your YAML file
 | |
| 
 | |
| ### What is a YAML file and why do I need one?
 | |
| 
 | |
| Your YAML file contains a set of configuration options which provide the generator with information about how it should
 | |
| generate your game. Each player of a multiworld will provide their own YAML file. This setup allows each player to enjoy
 | |
| an experience customized for their taste, and different players in the same multiworld can all have different options.
 | |
| 
 | |
| ### Where do I get a YAML file?
 | |
| 
 | |
| You can customize your options by visiting the 
 | |
| [MegaMan Battle Network 3 Player Options Page](/games/MegaMan%20Battle%20Network%203/player-options)
 | |
| 
 | |
| ## Joining a MultiWorld Game
 | |
| 
 | |
| ### Obtain your GBA patch file
 | |
| 
 | |
| When you join a multiworld game, you will be asked to provide your YAML file to whoever is hosting. Once that is done,
 | |
| the host will provide you with either a link to download your data file, or with a zip file containing everyone's data
 | |
| files. Your data file should have a `.apbn3` extension.
 | |
| 
 | |
| Double-click on your `.apbn3` file to start your client and start the ROM patch process. Once the process is finished
 | |
| (this can take a while), the client and the emulator will be started automatically (if you associated the extension
 | |
| to the emulator as recommended).
 | |
| 
 | |
| ### Connect to the Multiserver
 | |
| 
 | |
| Once both the client and the emulator are started, you must connect them. Within the emulator click on the "Tools"
 | |
| menu and select "Lua Console". Click the folder button or press Ctrl+O to open a Lua script.
 | |
| 
 | |
| Navigate to your Archipelago install folder and open `data/lua/connector_mmbn3.lua`.  
 | |
| **NOTE:** The MMBN3 Lua file depends on other shared Lua files inside of the `data` directory in the Archipelago
 | |
| installation. Do not move this Lua file from its default location or you may run into issues connecting.
 | |
| 
 | |
| To connect the client to the multiserver simply put `<address>:<port>` on the textfield on top and press enter (if the
 | |
| server uses password, type in the bottom textfield `/connect <address>:<port> [password]`)
 | |
| 
 | |
| Don't forget to start manipulating RNG early by shouting during generation:
 | |
| 
 | |
| ```
 | |
| JACK IN!
 | |
| [Your name]!   
 | |
| EXECUTE!
 | |
| ```
 | 
