The Legend of Zelda: Phantom Hourglass MultiworldGG

Latest Release
Setup Guide
Tricks and Skips
wiki, has detailed location info, item+location groups

Where is the settings page?

The player options page for this game contains all the options you need to configure and export a config file.

This is a MultiworldGG/Archipelago Randomizer for Zelda: Phantom Hourglass that doesn't use modding or romhacking to function. All randomization is done by reading and writing active memory with a lua script connected to the client. This means the game stops being randomized the moment the client disconnects.

If you want to help make a randomizer that's fully integrated into the game, visit ph-randomizer. Unaffiliated with this project, but real cool.

This is a spiritual successor to my discontinued Manual for Phantom Hourglass. It covers the full game but you've got to do all the memory editing manually.

Also check out the Spirit Tracks Archipelago Randomizer, made using the same system!

Who made this?

This version of the randomizer was made by me, @Carrotinator. Some features were added by @CelestialKitsune and @Tanker50207, and some stuff in the shared client with Spirit tracks was written by @DayKat and @1313e. The Universal Tracker Map Integration was worked on by @palex00 and @catzador. But it wouldn't have been possible without the work of many that came before. Here are some of them:

The Phantom Hourglass Decomp Project, and especially:
- @Aetias for making an inventory editing script while playing the manual rando for PH I made previously. This spawned the idea for using the generic bizhawk connector to do everything, and look where that got us
- Everyone who worked on the PH dev spreadsheet, but especially SammyGoodTunes, for updating the dev spreadsheets memory addresses live while I was working on this. I wouldn't have been able to do anything without the documentation in the spreadsheet.
The standalone Phantom Hourglass Randomizer
@Dinopony & @Ishigh1, whose Archipelago implementation for Zelda: Oracle of Seasons I used as a starting point and a reference for how to make an Archipelago client using the bizhawk tools. And for making their code easy to understand!
@alwaysintreble, whose entrance randomizer code from The Messenger helped me figure that stuff out
Codegorilla/@Ars-Ignis, whose crystalis implementation was extensively referenced for doing advanced universal tracker stuff.
The Manual for Archipelago discord, for lowering the entry threshold to Archipelago development.
Everyone who worked on Archipelago as a whole, for upholding high standards in code readability, and for creating such an amazing system.
Everyone who playtested the early versions of this, for giving enthusiasm and bug reports!
Everyone who playtested the later versions of this!

FAQ

What is currently implemented?

The whole game! Things not implemented:

Internal dungeon entrance shuffle
Travelling Ship entrance shuffle
Postman locations
That one treasure map from the girl on Molida Island

It's still alpha, and there are still issues around! Report issues to the phantom hourglass thread in the Archipelago Discord. There's also a channel in the PH and ST Speedrunning Discord

Is there a tracker?

Universal Tracker is fully supported, and includes a detailed map tracker by @palex00, @catzador and me. It has some special setup instructions. There's an item tracker for poptracker by @ZobeePlays.

How do I warp to start?

Open the collection screen with select or from the menu tab, and press the button to switch the screens. Then enter any scene transition. There will be messages in the MultiworldGG client to let you know it's working. You can warp to start with a save and quit too. But not a save and reset.

How does map warping work?

Map warping is my custom fast travel system. First it must be enabled in the yaml settings. Map warping lets you warp to any ocean or island port you've previously visited. Open the sea chart map while on land, and click on an island to select it as a warp destination. Then enter any entrance to warp there! The client will let you know what goes wrong if it fails There are some special conditions for warping:

You cannot map warp from the ocean. You can from ships at sea, like beedle.
You need to have visited an island or ocean to warp there, and have logical access to the port.
If overworld entrances are shuffled, it will specifically check for access to the port quadrant.
If you enabled warp items in the yaml, you'll need those for warping to each island. Not having warp items will remove the islands from your map.
You cannot map warp with a save and quit.

If using Universal Tracker and /get_logical_path, map warps will be accounted for when warping after selecting a valid warp destination once. You can disable this feature in your host.yaml.

Where do I find more ammo?

Warp to start now refills health and ammo! The Milk Bar on Mercay Island will also give free refills. How nice

My ship is slow. How do i go faster?

There are ship speed options built into the client. Use /boat speed to set your max speed, the default value is 266. You can also instant acceleration with /boat snap_speed. Boat options are saved in host.yaml and persist between sessions and seeds. Note that the boat is bad at going round corners at high speed. It can be a bit finicky to use.

My game crashed/I quit without saving

The client should give you back your missing items when you reenter the game. It can take a while if you're missing a lot of items, but it will tell you what it's doing in the client.

Where is `Location`?

There's a location guide being worked on at the wiki, mostly written by @thedragonslayr. If the location you're looking for isn't there, and the map tracker isn't helping, ask about it in the discord.

I collected some locations while the client wasn't connected

There is a backup system that reads savedata for missing checks when you enter a room. To trigger this, save and reenter the room with the locations in question. So far this is only implemented for save slot 1 and the overworld checks on Mercay Island, and some problematic checks like big rupees that can despawn or fall in the sea. I'm planning to add all locations in bulk soon.

How do small keys work in Temple of the Ocean King?

Since most locked doors in TotOK re-lock themselves each time you enter, TotOK has some special key rules:

When you enter the dungeon, you start with as many TotOK small keys as you've found so far
If you've opened the locked door on 1F that stays permanently unlocked, you don't get that key back. Logic assumes you can permanently lose that key, so you can safely open the 1F door unless you wanna go out of logic.
When you reach the midway room with the yellow warp, it saves the number of keys you still have. When you take the yellow warp you should start with however many keys you saved.
Finding more TotOK small keys after reaching the yellow midway will add them to the number of keys you get both at the start of the dungeon and from the midway.
Logic can expect you to restart from the beginning to use your keys differently.
The grappling hook can be used to skip a key on B3. This is in logic.