# The Legend of Zelda: Phantom Hourglass AP Setup Guide

## Required Software

* [Archipelago 0.6.1+](https://archipelago.gg/tutorial/Archipelago/setup/en)
* [Bizhawk 2.10+](https://github.com/TASEmulators/BizHawk)
* Legally acquired Phantom Hourglass EU rom (US support coming soon). Apparently it only works in English
* [Latest tloz_ph.apworld](https://github.com/carrotinator/Archipelago/releases)

## Recommended Software

* [Universal Tracker](https://github.com/FarisTheAncient/Archipelago/releases) version v0.2.25 or later. Contains a detailed map tracker by @palex00, @catzador and @carrotinator.
* [Item Tracker](https://github.com/ZobeePlays/PH-AP-Item-Tracker/tree/main), a poptracker pack by @ZobeePlays. No map tracking.

## Game Setup

1. Find your Archipelago directory, and put `tloz_ph.apworld` in the `custom_worlds` folder
2. Create a yaml settings file, and put it in the Archipelago directories `players` folder. You can generate a template yaml with the archipelago launcher.
3. Generate your game
4. Host the game, either locally or via the archipelago web hosting service
5. Open the `generic bizhawk client` in Archipelago, and connect to the server
6. Launch the vanilla game in bizhawk, and open the lua console. Add the `connector_bizhawk_generic.lua` script that can be found in `Archipelago\data\lua`. 
7. You are now ready to play! Start a new savefile and go! You can check that everything worked by checking if the bridge has been repaired.

## External patches
- Works with controller patches!
- Works with player model patches. [Guide](https://gamebanana.com/tuts/19109) for making them.

## Useful to know before you start
- Since the game runs on live patching, you can't see what you found in game. Check your client to see what items you find.
- You can warp to start by opening the collection screen and flipping the screen, then entering any transition. This will also refill you ammo and heal you.
- If enabled in the yaml, there is a fast travel system. Open your sea chart and select an island you've previously visited to select a warp location, and enter any transition to warp to it's port.
- Some locations can despawn. They usually have a backup system. Save and reenter the room to trigger it. Only works for save slot one.

## Further Reading
- [FAQ and Credits](https://github.com/carrotinator/Archipelago/blob/main/worlds/tloz_ph/docs/faq_and_credits.md)
- [Tricks and Skips](https://github.com/carrotinator/Archipelago/blob/main/worlds/tloz_ph/docs/tricks_and_skips.md)
- [wiki](https://github.com/carrotinator/Archipelago/wiki) contains locations, maps, groupings and stuff