TWW: Documentation Cleanup (#4942)

worlds/tww/Options.py

@@ -19,6 +19,8 @@ from .Locations import DUNGEON_NAMES
 class Dungeons(DefaultOnToggle):
     """
     This controls whether dungeon locations are randomized.
+
+    This means the items found in dungeons will be randomized, not that the entrances to dungeons will be randomized.
     """
 
     display_name = "Dungeons"

worlds/tww/docs/en_The Wind Waker.md

@@ -19,17 +19,18 @@ 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.
+fully-powered Master Sword (unless it's swords optional or 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?
+## What happens when the player receives an item?
 
-When the player receives an item, it will automatically be added to Link's inventory. Unlike many other Zelda
+When the player receives an item, it will automatically be added to Link's inventory. Link **will not** hold the item
-randomizers, Link **will not** hold the item above his head.
+above his head like many other Zelda randomizers.
 
 ## I need help! What do I do?
 
@@ -37,16 +38,20 @@ Refer to the [FAQ](https://lagolunatic.github.io/wwrando/faq/) first. Then, try
 [setup guide](/tutorial/The%20Wind%20Waker/setup/en). If you are still stuck, please ask in the Wind Waker channel in
 the Archipelago server.
 
+## I opened the game in Dolphin, but I don't have any of my starting items!
+
+You must connect to the multiworld room to receive any items, including your starting inventory.
+
 ## 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
+- Demo items (items held over Link's head) that are **not** randomized, such as rupees from salvages from random light
-  random light rings or rewards from minigames, will not work.
+  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.
+- It has been reported that item links can be buggy. It is 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!
 
@@ -76,14 +81,14 @@ A few presets are available on the [player options page](../player-options) for
   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
+  [2025 Season of Miniblins](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
+  preset features full entrance rando and includes most locations behind a randomized entrance. There are also many
-  of overworld locations, as these settings were intended to be played in a two-person co-op team. The preset also has 6
+  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.
 
@@ -106,7 +111,7 @@ This randomizer would not be possible without the help from:
 - CrainWWR: (multiworld and Dolphin memory assistance, additional programming)
 - Cyb3R: (reference for `TWWClient`)
 - DeamonHunter: (additional programming)
-- Dev5ter: (initial TWW AP implmentation)
+- Dev5ter: (initial TWW AP implementation)
 - Gamma / SageOfMirrors: (additional programming)
 - LagoLunatic: (base randomizer, additional assistance)
 - Lunix: (Linux support, additional programming)

worlds/tww/docs/setup_en.md

@@ -5,11 +5,13 @@ If you're playing The Wind Waker, you must follow a few simple steps to get star
 
 ## Requirements
 
-You'll need the following components to be able to play with The Wind Waker:
+You'll need the following components to be able to play 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
+    * Linux users 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).
+* The latest version of the [TWW AP Randomizer Build](https://github.com/tanjo3/wwrando/releases?q=tag%3Aap_2).
+    * Please note that this build is **different** from the one the standalone randomizer uses. This build is
+      specifically for Archipelago.
 * A The Wind Waker ISO (North American version), probably named "Legend of Zelda, The - The Wind Waker (USA).iso".
 
 Optionally, you can also download:
@@ -26,17 +28,17 @@ world. Once you're happy with your settings, provide the room host with your YAM
 
 ## 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
+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
+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:
+Once you're ready, 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.
+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
+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.
@@ -47,7 +49,7 @@ text client. If Dolphin is not already open, or you have yet to start a new file
 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
+8. If you've opened an ISO corresponding to the multiworld to which you are connected, it should authenticate your slot
 name automatically when you start a new save file.
 
 ## Troubleshooting
@@ -56,12 +58,17 @@ name automatically when you start a new save file.
 * 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.
+  [here](https://github.com/tanjo3/wwrando/releases?q=tag%3Aap_2) to see which versions of Archipelago each build is
+  compatible with.
+* Do not run the Archipelago Launcher or Dolphin as an administrator on Windows.
 * 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` >
+* Ensure that `Enable Emulated Memory Size Override` in Dolphin (under `Options` > `Configuration` > `Advanced`) is
-`Configuration` > `Advanced`) is **disabled**.
+  **disabled**.
+* If the client cannot connect to Dolphin, ensure Dolphin is on the same drive as Archipelago. Having Dolphin on an
+  external drive has reportedly caused connection issues.
+* Ensure the `Fallback Region` in Dolphin (under `Options` > `Configuration` > `General`) is set to `NTSC-U`.
 * 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`.