Skip to content
This repository has been archived by the owner on Apr 5, 2022. It is now read-only.

Releases: ArchipelagoMW/Z5Client

v0.9.3 - Fix for Emulation Pausing

06 Sep 04:06
Compare
Choose a tag to compare

Changelog

  • Z5Client now requires Archipelago server to be version 0.1.7 or higher

Bugfixes

  • Fixed a bug which would cause OoT games to report as completed if the user paused emulation long enough for a client timeout to occur

v0.9.2 - Bug Squashing 2: The Squashening

26 Aug 04:52
Compare
Choose a tag to compare

Changelog

  • Freestanding items are now sent immediately upon pickup
  • Boss drop items are now sent immediately upon pickup

Bugfixes

  • Fixed an oversight causing the toggle receiving items button to do nothing
  • Fixed a bug causing the game completed message from being formatted properly when sent to the AP server

v0.9.1 - Bug Squashing

20 Aug 21:22
Compare
Choose a tag to compare

Changelog

  • Chest checks now send immediately, without the need of saving or changing locations
  • Added debug output in case of communication timeouts with the LUA script
  • Updated the BizHawk installer script to set more configuration options (disable all hotkeys, enable background input, enable SRAM auto-backups)
  • Added game completion check
  • Support multiple base ROM hashes
  • Removes 500ms wait time between n64Interval loops

Bugfixes

  • Fixed two swapped location checks on Deku scrubs in Lost Woods
  • Fixed an oversight causing player names to be blank after the user performs a hard reset
  • Fixed a bug causing the membership card check to always return true if a save context is loaded
  • Fixed the light arrow cutscene being checked immediately when the game starts
  • Fixed the error message displayed when the socket server port is already bound
  • Fixed a bug causing the patched ROM to not launch automatically if a custom launcher is set
  • Fixed an oversight causing some valid base ROM files to not be usable for patching
  • Fixed a bug causing items to sometimes not be sent or be sent twice

v0.9.0 - Initial Release

15 Aug 23:31
Compare
Choose a tag to compare

Ocarina of Time (Z5) Client for Archipelago

Files Included:

  • Z5Client-Win64-Setup.exe: This is the installer file. You'll need to download and run this to install the client.
  • Z5Client-Win64.zip: This is a zip file which may be used as a stand-alone installation. It is not recommended to use this.
  • get-bizhawk.ps1: This is a Windows Powershell script which will download and configure BizHawk 2.3, which is currently the only version of BizHawk supported for Archipelago's implementation of OoT.
  • ootMulti.lua: This is the LUA script you will need to load into BizHawk after loading the randomizer ROM

How to Install

Z5Client

Simply double-click on the Z5Client-Win64-Setup.exe file, and the program will automatically install and launch. You may delete the setup file after installation.

BizHawk 2.3

Right-click on the get-bizhawk.ps1 file and choose "Run with PowerShell." The script will open a PowerShell window and download and install the BizHawk prerequisites, BizHawk itself, and automatically configure some LUA options for you. You will still need to configure your controls upon first launching BizHawk.

How to Play:

  1. Receive a .apz5 file from Archipelgo
  2. Double click the .apz5 file.
  3. The client will ask you to select a base rom file. This should be the english version of Ocarina of Time.
  4. The client will automatically patch your base rom and place your new rom in the same location as your patch file.
  5. You may need to select a default program to launch N64 roms. If this is any emulator other than the BizHawk downloaded during the installation process, you will need to close it and open the BizHawk 2.3 acquired using the get-bizhawk.ps1 file.
  6. Open the ootMulti.lua script in the BizHawk LUA console. If the client is not running, the script will terminate and ask you to run the Z5Client before trying to run it again.
  7. Type the server address into the Z5Client "Server" box and press enter.
  8. Have fun.

Where to Acquire a Base ROM:

You must dump your base ROM file from your physical cartridge of the English version of Ocarina of Time. There are several methods of doing so, which are outside the scope of this guide.