morgan/Grinch-AP
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

AP Ocarina of Time Client (#352)

Browse Source
This commit is contained in:
espeon65536
2022-03-27 14:44:22 -05:00
committed by GitHub
parent 3c2933d587
commit 469dda7d85
10 changed files with 2700 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
WebHostLib/static/assets/tutorial/zelda5/setup_en.md
View File

@@ -1,27 +1,40 @@
# Setup Guide for Ocarina of time Archipelago
# Setup Guide for Ocarina of Time Archipelago
## Important
As we are using Z5Client and BizHawk, this guide is only applicable to Windows.
As we are using Bizhawk, this guide is only applicable to Windows and Linux systems.
## Required Software
- BizHawk and Z5Client from: [Z5Client Releases Page](https://github.com/ArchipelagoMW/Z5Client/releases)
- We recommend download Z5Client-setup as it makes some steps automatic.
- Bizhawk: [Bizhawk Releases from TASVideos](https://tasvideos.org/BizHawk/ReleaseHistory)
- Version 2.3.1 and later are supported. Version 2.7 is recommended for stability.
- 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.
- An Archipelago client for Ocarina of Time. There are two options available:
- The built-in Archipelago client, which can be installed [here](https://github.com/ArchipelagoMW/Archipelago/releases)
(select `Ocarina of Time Client` during installation). This client is kept up-to-date with the latest Archipelago version
and will always be supported.
- Z5Client, which can be installed [here](https://github.com/ArchipelagoMW/Z5Client/releases), and its associated Lua script `ootMulti.lua`.
- An Ocarina of Time v1.0 ROM.
## Install Emulator and client
## Configuring Bizhawk
Download getBizhawk.ps1 from previous link. Place it on the folder where you want your emulator to be installed, right
click on it and select "Run with PowerShell". This will download all the needed dependencies used by the emulator. This
can take a while.
Once Bizhawk has been installed, open Bizhawk and change the following settings:
It is strongly recommended to associate N64 rom extension (\*.n64) to the BizHawk we've just installed. To do so, we
simply have to search any N64 rom we happened to own, right click and select "Open with...", we unfold the list that
appears and select the bottom option "Look for another application", we browse to BizHawk folder and select EmuHawk.exe
- 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.
- 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.
- 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`.
- If playing with a controller, when you bind controls, disable "P1 A Up", "P1 A Down", "P1 A Left", and "P1 A Right" as these interfere
with aiming if bound. Set directional input using the Analog tab instead.
Place the ootMulti.lua file from the previous link inside the "lua" folder from the just installed emulator.
Install the Z5Client using its setup.
It is strongly recommended to associate N64 rom extensions (\*.n64, \*.z64) to the Bizhawk we've just installed. To do so, we
simply have to search any N64 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.
## Configuring your YAML file
@@ -33,7 +46,7 @@ an experience customized for their taste, and different players in the same mult
### Where do I get a YAML file?
A basic OOT yaml will look like this. There are lots of cosmetic options that have been removed for the sake of this
A basic OoT yaml will look like this. There are lots of cosmetic options that have been removed for the sake of this
tutorial, if you want to see a complete list, download Archipelago from
the [Archipelago Releases Page](https://github.com/ArchipelagoMW/Archipelago/releases) and look for the sample file in
the "Players" folder.
@@ -382,20 +395,23 @@ Ocarina of Time:
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 `.z5ap` extension.
files. Your data file should have a `.apz5` extension.
Double-click on your `.z5ap` file to start Z5Client and start the ROM patch process. Once the process is finished (this
can take a while), the emulator will be started automatically (If we associated the extension to the emulator as
recommended)
Double-click on your `.apz5` 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 Z5Client and the emulator are started we must connect them. Within the emulator we click on the "Tools"
menu and select "Lua console". In the new window click on the folder icon and look for the ootMulti.lua file. Once the
file is loaded it will connect automatically to Z5Client.
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.
Note: We strongly advise you don't open any emulator menu while it and Z5client are connected, as the script will halt
and disconnects can happen. If you get disconnected just double-click on the script again.
If you are using the Archipelago OoTClient, navigate to your Archipelago install folder and open `data/lua/OOT/oot_connector.lua`.
If you are using Z5Client, find the `ootMulti.lua` file and open it.
Note: If using Z5Client, we strongly advise you don't open any menus in Bizhawk while the emulator and Z5Client are connected, as the script will halt
and force-disconnect from the server. If you get disconnected just double-click on the script again.
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]`)