mirror of
https://github.com/MarioSpore/Grinch-AP.git
synced 2025-10-21 20:21:32 -06:00
The Wind Waker: Implement New Game (#4458)
Adds The Legend of Zelda: The Wind Waker as a supported game in Archipelago. The game uses [LagoLunatic's randomizer](https://github.com/LagoLunatic/wwrando) as its base (regarding logic, options, etc.) and builds from there.
This commit is contained in:
120
worlds/tww/docs/en_The Wind Waker.md
Normal file
120
worlds/tww/docs/en_The Wind Waker.md
Normal file
@@ -0,0 +1,120 @@
|
||||
# The Wind Waker
|
||||
|
||||
## Where is the options page?
|
||||
|
||||
The [player options page for this game](../player-options) contains all the options you need to configure and export a
|
||||
config file.
|
||||
|
||||
## What does randomization do to this game?
|
||||
|
||||
Items get shuffled between the different locations in the game, so each playthrough is unique. Randomized locations
|
||||
include chests, items received from NPC, and treasure salvaged from the ocean floor. The randomizer also includes
|
||||
quality-of-life features such as a fully opened world, removing many cutscenes, increased sailing speed, and more.
|
||||
|
||||
## Which locations get shuffled?
|
||||
|
||||
Only locations put into logic by the world's settings will be randomized. The remaining locations in the game will have
|
||||
a yellow Rupee, which includes a message that the location is not randomized.
|
||||
|
||||
## What is the goal of The Wind Waker?
|
||||
|
||||
Reach and defeat Ganondorf atop Ganon's Tower. This will require all eight shards of the Triforce of Courage, the
|
||||
fully-powered Master Sword (unless it's swordless mode), Light Arrows, and any other items necessary to reach Ganondorf.
|
||||
|
||||
## What does another world's item look like in TWW?
|
||||
|
||||
Items belonging to other non-TWW worlds are represented by Father's Letter (the letter Medli gives you to give to
|
||||
Komali), an unused item in the randomizer.
|
||||
|
||||
## When the player receives an item, what happens?
|
||||
|
||||
When the player receives an item, it will automatically be added to Link's inventory. Unlike many other Zelda
|
||||
randomizers, Link **will not** hold the item above his head.
|
||||
|
||||
## I need help! What do I do?
|
||||
|
||||
Refer to the [FAQ](https://lagolunatic.github.io/wwrando/faq/) first. Then, try the troubleshooting steps in the
|
||||
[setup guide](/tutorial/The%20Wind%20Waker/setup/en). If you are still stuck, please ask in the Wind Waker channel in
|
||||
the Archipelago server.
|
||||
|
||||
## Known issues
|
||||
|
||||
- Randomized freestanding rupees, spoils, and bait will also be given to the player picking up the item. The item will
|
||||
be sent properly, but the collecting player will receive an extra copy.
|
||||
- Demo items (items which are held over Link's head) which are **not** randomized, such as rupees from salvages from
|
||||
random light rings or rewards from minigames, will not work.
|
||||
- Item get messages for progressive items received on locations that send earlier than intended will be incorrect. This
|
||||
does not affect gameplay.
|
||||
- The Heart Piece count in item get messages will be off by one. This does not affect gameplay.
|
||||
- It has been reported that item links can be buggy. Nothing game-breaking, but do be aware of it.
|
||||
|
||||
Feel free to report any other issues or suggest improvements in the Wind Waker channel in the Archipelago server!
|
||||
|
||||
## Tips and Tricks
|
||||
|
||||
### Where are dungeon secrets found in the dungeons?
|
||||
|
||||
[This document](https://docs.google.com/document/d/1LrjGr6W9970XEA-pzl8OhwnqMqTbQaxCX--M-kdsLos/edit?usp=sharing) has
|
||||
images of each of the dungeon secrets.
|
||||
|
||||
### What exactly do the obscure and precise difficulty options do?
|
||||
|
||||
The `logic_obscurity` and `logic_precision` options modify the randomizer's logic to put various tricks and techniques
|
||||
into logic.
|
||||
[This document](https://docs.google.com/spreadsheets/d/14ToE1SvNr9yRRqU4GK2qxIsuDUs9Edegik3wUbLtzH8/edit?usp=sharing)
|
||||
neatly lists the changes that are made. The options are progressive, so, for instance, hard obscure difficulty includes
|
||||
both normal and hard obscure tricks. Some changes require a combination of both options. For example, to put having the
|
||||
Forsaken Fortress cannons blow the door up for you into logic requires both obscure and precise difficulty to be set to
|
||||
at least normal.
|
||||
|
||||
### What are the different options presets?
|
||||
|
||||
A few presets are available on the [player options page](../player-options) for your convenience.
|
||||
|
||||
- **Tournament S7**: These are (as close to as possible) the settings used in the WWR Racing Server's
|
||||
[Season 7 Tournament](https://docs.google.com/document/d/1mJj7an-DvpYilwNt-DdlFOy1fz5_NMZaPZvHeIekplc).
|
||||
The preset features 3 required bosses and hard obscurity difficulty, and while the list of enabled progression options
|
||||
may seem intimidating, the preset also excludes several locations.
|
||||
- **Miniblins 2025**: These are (as close to as possible) the settings used in the WWR Racing Server's
|
||||
[2025 Season of Minblins](https://docs.google.com/document/d/19vT68eU6PepD2BD2ZjR9ikElfqs8pXfqQucZ-TcscV8). This
|
||||
preset is great if you're new to Wind Waker! There aren't too many locations in the world, and you only need to
|
||||
complete two dungeons. You also start with many convenience items, such as double magic, a capacity upgrade for your
|
||||
bow and bombs, and six hearts.
|
||||
- **Mixed Pools**: These are the settings used in the WWR Racing Server's
|
||||
[Mixed Pools Co-op Tournament](https://docs.google.com/document/d/1YGPTtEgP978TIi0PUAD792OtZbE2jBQpI8XCAy63qpg). This
|
||||
preset features full entrance rando and includes many locations behind a randomized entrance. There are also a bunch
|
||||
of overworld locations, as these settings were intended to be played in a two-person co-op team. The preset also has 6
|
||||
required bosses, but since entrance pools are randomized, the bosses could be found anywhere! Check your Sea Chart to
|
||||
find out which island the bosses are on.
|
||||
|
||||
## Planned Features
|
||||
|
||||
- Dynamic CTMC based on enabled options
|
||||
- Hint implementation from base randomizer (hint placement options and hint types)
|
||||
- Integration with Archipelago's hint system (e.g., auction hints)
|
||||
- EnergyLink support
|
||||
- Swift Sail logic as an option
|
||||
- Continued bugfixes
|
||||
|
||||
## Credits
|
||||
|
||||
This randomizer would not be possible without the help from:
|
||||
|
||||
- BigSharkZ: (icon artwork)
|
||||
- Celeste (Maëlle): (logic and typo fixes, additional programming)
|
||||
- Chavu: (logic difficulty document)
|
||||
- CrainWWR: (multiworld and Dolphin memory assistance, additional programming)
|
||||
- Cyb3R: (reference for `TWWClient`)
|
||||
- DeamonHunter: (additional programming)
|
||||
- Dev5ter: (initial TWW AP implmentation)
|
||||
- Gamma / SageOfMirrors: (additional programming)
|
||||
- LagoLunatic: (base randomizer, additional assistance)
|
||||
- Lunix: (Linux support, additional programming)
|
||||
- Mysteryem: (tracker support, additional programming)
|
||||
- Necrofitz: (additional documentation)
|
||||
- Ouro: (tracker support)
|
||||
- tal (matzahTalSoup): (dungeon secrets guide)
|
||||
- Tubamann: (additional programming)
|
||||
|
||||
The Archipelago logo © 2022 by Krista Corkos and Christopher Wilson, licensed under
|
||||
[CC BY-NC 4.0](http://creativecommons.org/licenses/by-nc/4.0/).
|
67
worlds/tww/docs/setup_en.md
Normal file
67
worlds/tww/docs/setup_en.md
Normal file
@@ -0,0 +1,67 @@
|
||||
# Setup Guide for The Wind Waker Archipelago
|
||||
|
||||
Welcome to The Wind Waker Archipelago! This guide will help you set up the randomizer and play your first multiworld.
|
||||
If you're playing The Wind Waker, you must follow a few simple steps to get started.
|
||||
|
||||
## Requirements
|
||||
|
||||
You'll need the following components to be able to play with The Wind Waker:
|
||||
* Install [Dolphin Emulator](https://dolphin-emu.org/download/). **We recommend using the latest release.**
|
||||
* For Linux users, you can use the flatpak package
|
||||
[available on Flathub](https://flathub.org/apps/org.DolphinEmu.dolphin-emu).
|
||||
* The 2.5.0 version of the [TWW AP Randomizer Build](https://github.com/tanjo3/wwrando/releases/tag/ap_2.5.0).
|
||||
* A The Wind Waker ISO (North American version), probably named "Legend of Zelda, The - The Wind Waker (USA).iso".
|
||||
|
||||
Optionally, you can also download:
|
||||
* [Wind Waker Tracker](https://github.com/Mysteryem/ww-poptracker/releases/latest)
|
||||
* Requires [PopTracker](https://github.com/black-sliver/PopTracker/releases)
|
||||
* [Custom Wind Waker Player Models](https://github.com/Sage-of-Mirrors/Custom-Wind-Waker-Player-Models)
|
||||
|
||||
## Setting Up a YAML
|
||||
|
||||
All players playing The Wind Waker must provide the room host with a YAML file containing the settings for their world.
|
||||
Visit the [The Wind Waker options page](/games/The%20Wind%20Waker/player-options) to generate a YAML with your desired
|
||||
options. Only locations categorized under the options enabled under "Progression Locations" will be randomized in your
|
||||
world. Once you're happy with your settings, provide the room host with your YAML file and proceed to the next step.
|
||||
|
||||
## Connecting to a Room
|
||||
|
||||
The multiworld host will provide you a link to download your `aptww` file or a zip file containing everyone's files. The
|
||||
`aptww` file should be named `P#_<name>_XXXXX.aptww`, where `#` is your player ID, `<name>` is your player name, and
|
||||
`XXXXX` is the room ID. The host should also provide you with the room's server name and port number.
|
||||
|
||||
Once you do, follow these steps to connect to the room:
|
||||
1. Run the TWW AP Randomizer Build. If this is the first time you've opened the randomizer, you'll need to specify the
|
||||
path to your The Wind Waker ISO and the output folder for the randomized ISO. These will be saved for the next time you
|
||||
open the program.
|
||||
2. Modify any cosmetic convenience tweaks and player customization options as desired.
|
||||
3. For the APTWW file, browse and locate the path to your `aptww` file.
|
||||
4. Click `Randomize` at the bottom-right. This randomizes the ISO and puts it in the output folder you specified. The
|
||||
file will be named `TWW AP_YYYYY_P# (<name>).iso`, where `YYYYY` is the seed name, `#` is your player ID, and `<name>`
|
||||
is your player (slot) name. Verify that the values are correct for the multiworld.
|
||||
5. Open Dolphin and use it to open the randomized ISO.
|
||||
6. Start `ArchipelagoLauncher.exe` (without `.exe` on Linux) and choose `The Wind Waker Client`, which will open the
|
||||
text client. If Dolphin is not already open, or you have yet to start a new file, you will be prompted to do so.
|
||||
* Once you've opened the ISO in Dolphin, the client should say "Dolphin connected successfully.".
|
||||
7. Connect to the room by entering the server name and port number at the top and pressing `Connect`. For rooms hosted
|
||||
on the website, this will be `archipelago.gg:<port>`, where `<port>` is the port number. If a game is hosted from the
|
||||
`ArchipelagoServer.exe` (without `.exe` on Linux), the port number will default to `38281` but may be changed in the
|
||||
`host.yaml`.
|
||||
8. If you've opened a ROM corresponding to the multiworld to which you are connected, it should authenticate your slot
|
||||
name automatically when you start a new save file.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
* Ensure you are running the same version of Archipelago on which the multiworld was generated.
|
||||
* Ensure `tww.apworld` is not in your Archipelago installation's `custom_worlds` folder.
|
||||
* Ensure you are using the correct randomizer build for the version of Archipelago you are using. The build should
|
||||
provide an error message directing you to the correct version. You can also look at the release notes of TWW AP builds
|
||||
[here](https://github.com/tanjo3/wwrando/releases) to see which versions of Archipelago each build is compatible with.
|
||||
* If you encounter issues with authenticating, ensure that the randomized ROM is open in Dolphin and corresponds to the
|
||||
multiworld to which you are connecting.
|
||||
* Ensure that you do not have any Dolphin cheats or codes enabled. Some cheats or codes can unexpectedly interfere with
|
||||
emulation and make troubleshooting errors difficult.
|
||||
* If you get an error message, ensure that `Enable Emulated Memory Size Override` in Dolphin (under `Options` >
|
||||
`Configuration` > `Advanced`) is **disabled**.
|
||||
* If you run with a custom GC boot menu, you'll need to skip it by going to `Options` > `Configuration` > `GameCube`
|
||||
and checking `Skip Main Menu`.
|
Reference in New Issue
Block a user