From 5753db0d12da94f6ff2f1e3040a8be172be027b7 Mon Sep 17 00:00:00 2001 From: Star Rauchenberger Date: Thu, 11 Sep 2025 10:44:04 -0400 Subject: Worked on the documentation --- README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ apworld/options.py | 18 +++++++++++++++++- client/README.md | 7 ------- 3 files changed, 67 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 60dc1b3..3b69bbd 100644 --- a/README.md +++ b/README.md @@ -14,3 +14,53 @@ There are multiple parts of this project: - [Client](https://code.fourisland.com/lingo2-archipelago/about/client/README.md) - [Apworld](https://code.fourisland.com/lingo2-archipelago/about/apworld/README.md) - [Data](https://code.fourisland.com/lingo2-archipelago/about/data/README.md) + +## Frequently Asked Questions + +### What about wall snipes? + +"Wall sniping" refers to the fact that you are able to solve puzzles on the +other side of opaque walls. The player is never expected to or required to do +this in normal gameplay. This randomizer does not change how wall snipes work, +but it will likewise never require the use of them. + +### How do cyan doors work? + +In the base game, there are a number of cyan-colored doors that ordinarily open +once you collect H2 in The Repetitive. There are also a handful of panels that +only appear upon getting H2 as well, which the apworld treats the same as the +cyan doors. + +There is an option that lets you choose how these doors and panels behave. By +default, they act the same as in the base game: they only open or appear after +collecting H2. Note that this means the actual H2 collectable in The Repetitive. +Receiving H2 via remote letter shuffle does not count for this requirement. +However, you can also make cyan doors activate upon collecting or receiving your +first double letter, regardless of what it is or if it's remote. Finally, you +can lock cyan doors behind an item called "Cyan Doors". + +It is important to note, however, that the Cyan Door Behavior option only +applies to cyan doors that are not already affected by another type of +shuffling. When door shuffle is on, the following cyan doors are activated by +individual items and are not impacted by your choice of Cyan Door Behavior: + +- The entrance to The Tower from The Great (The Great - Tower Entrance) +- The entrance to The Butterfly from The Bearer (The Bearer - Butterfly + Entrance) +- The entrance to The Repetitive from The Entry (The Entry - Repetitive + Entrance) +- The eye painting near the yellow color hallway in Daedalus (Daedalus - Eye + Painting) + +Additionally, when control center color shuffle is enabled, the orange door in +The Unkempt (which ordinarily doubles as a cyan door) opens upon receiving the +Control Center Orange Doors item, instead of following the Cyan Door Behavior +option. + +### Help! I lost C/G in The Congruent! + +If you place C or G into the relevant keyholders in The Congruent, the keyholder +disappears. You can retrieve your letter immediately by pressing C or G again +while standing in the same position, as the keyholder is still there, just +invisible. If you have already left the room, though, there is an easier way to +get your letters back: just use the Key Return in The Entry. diff --git a/apworld/options.py b/apworld/options.py index f72e826..6f60282 100644 --- a/apworld/options.py +++ b/apworld/options.py @@ -88,7 +88,23 @@ class DaedalusRoofAccess(Toggle): class VictoryCondition(Choice): - """Victory condition.""" + """ + This option determines what your goal is. + + - **Gray Ending** (The Colorful) + - **Purple Ending** (The Sun Temple). This ordinarily requires all level 1 (purple) letters. + - **Mint Ending** (typing EXIT into the keyholders in Control Center) + - **Black Ending** (The Graveyard) + - **Blue Ending** (The Words) + - **Cyan Ending** (The Parthenon). This ordinarily requires almost all level 2 (cyan) letters. + - **Red Ending** (The Tower) + - **Plum Ending** (The Wondrous / The Door) + - **Orange Ending** (the castle in Daedalus) + - **Gold Ending** (The Gold). This involves going through the color rooms in Daedalus. + - **Yellow Ending** (The Gallery). This requires unlocking all gallery paintings. + - **Green Ending** (The Ancient). This requires filling all keyholders with specific letters. + - **White Ending** (Control Center). This combines every other ending. + """ display_name = "Victory Condition" option_gray_ending = 0 option_purple_ending = 1 diff --git a/client/README.md b/client/README.md index 1e94bdb..99589c5 100644 --- a/client/README.md +++ b/client/README.md @@ -88,10 +88,3 @@ not recommended to load these save files outside of the randomizer. A connection to Archipelago is required to resume playing a multiworld. This is because the set of items you have received is not stored locally. - -### What about wall snipes? - -"Wall sniping" refers to the fact that you are able to solve puzzles on the -other side of opaque walls. The player is never expected to or required to do -this in normal gameplay. This randomizer does not change how wall snipes work, -but it will likewise never require the use of them. -- cgit 1.4.1