1 files changed, 102 insertions, 8 deletions

@@ -18,7 +18,7 @@ part of an Archipelago multiworld game.
 3. Double click on `lingo2.apworld` to install it, or copy it manually to the
    `custom_worlds` folder of your Archipelago installation.
 
-## Joining a Multiworld game
+## Joining a Multiworld game (Windows)
 
 1. Open the Archipelago Launcher.
 2. Select "Lingo 2 Client".
@@ -34,6 +34,26 @@ part of an Archipelago multiworld game.
 
 To continue an earlier game, you can perform the exact same steps as above.
 
+## Joining a Multiworld game (Non-Windows)
+
+Lingo 2 only officially supports Windows, but has been known to work on Linux
+using Proton. Archipelago can be played on a non-Windows system, but the process
+is a little more complex.
+
+1. Download
+   [archipelago.tscn](https://code.fourisland.com/lingo2-archipelago/plain/client/archipelago.tscn)
+   and put it in your custom maps folder. You only have to do this once.
+2. Open Lingo 2, and select Archipelago from the level selection list.
+3. Put the path to your `lingo2.apworld` into the field provided. You only have
+   to do this once, as the game will remember what you put in.
+4. Click Start and wait for the connection settings screen to load.
+5. Open the Archipelago Launcher.
+6. Select "Lingo 2 Client".
+7. You should see "Connected to Lingo 2!" You can then return to Lingo 2 and
+   fill out your connection details.
+8. Press Connect.
+9. Enjoy!
+
 ## Frequently Asked Questions
 
 ### Why aren't the starting room letters shuffled?
@@ -51,13 +71,10 @@ same time as collecting the letter.
 
 ### What areas are randomized?
 
-Almost all maps that you can access from the base game are randomized. The
-exceptions are:
-
-- Icarus (this will be randomized at some point, although it will be optional)
-- Demo
-- The Hinterlands (this will probably be repurposed)
-- The beta tester gift maps
+Almost all maps that you can access from the base game are randomized. The only
+exception is The Hinterlands, which will probably be repurposed into a hint
+area. Some advanced/hidden maps are also disabled by default (as discussed
+below).
 
 ### Is my progress saved locally?
 
@@ -138,6 +155,83 @@ one. As long as you have all of the necessary letters, an alternate answer can
 be typed into a red panel even though it does not show you typing. When you
 finish typing the answer, the panel will solve as normal.
 
+### Why does the tracker say "The Entry (Colored Doors Area) - OPEN" is in logic?
+
+This is an infamous panel, both in the base game and in the randomizer. There
+are _two_ valid answers that open the door / clear the location. These are
+"ORANGE" and "WALL".
+
+### I can't solve the COLORS panel in The Sturdy!
+
+The Sturdy contains a rainbow painting that leads to the Gold Ending area in
+Daedalus. There are three ways to spawn this painting, which have different
+logical requirements:
+
+- Solve the COLORS panel that appears after collecting S2. This is the most
+  well-known way, and causes the most confusion because you may be expected to
+  enter the painting even if you are unable to solve the panel (e.g. if you are
+  missing letters or missing Boxes Symbol).
+- Solve the panels in the order that you walk across the colors on the way
+  toward S2: Magenta, Red, Orange, Yellow, Green, Blue, Purple, Cyan. This has
+  the same logic as accessing S2.
+- Type "MOVE" into the Green and Yellow panels, and none of the other ones. This
+  is a subset of the logic for accessing S2, so you may actually be expected to
+  use the rainbow painting before you can even collect S2.
+
+### How does Icarus work?
+
+While Icarus is easily accessible during normal play, it is not randomized by
+default. The main reason for this is that Icarus employs significantly more use
+of gravity changing mechanics than the rest of the game and as a result tends to
+cause motion sickness in a lot of players. It is also an infamously confusing
+area to navigate.
+
+Because of this, the player may enter and exit Icarus from the usual place in
+Daedalus, but it will not contain any locations, and no items will be added to
+the pool for it. The worldport will not be included in the randomization if
+worldport shuffle is on. Icarus can also still be entered from The Crystalline,
+but doing so (in order to then access Daedalus) will not be logically required.
+
+However, Icarus can be randomized via the "Enable Icarus" option. Doing so
+creates locations and items for the map, and includes the worldport in worldport
+shuffle. The aforementioned connection from The Crystalline also becomes
+logical, if The Crystalline is enabled.
+
+It is not trivial to telegraph exactly what is logical within Icarus. It is very
+easy to break logic because the gravity changers allow you to fall in almost any
+direction you want to. In general, falling is only in logic if it is "guided",
+i.e. falling through a hole or an open door to another platform, or using a
+gravity inverter. You may also sometimes be required to solve panels that are
+physically near you and easily visible, but not on your plane of gravity. The
+tracker can help you determine what is considered logical, if you want to stay
+within the randomizer's logic.
+
+### How do the gift maps work?
+
+The beta tester gift maps are hidden levels intended for specific people. By
+default, these are not accessible at all from within the randomizer. The "Enable
+Gift Maps" option allows you to enter the maps, and creates items and locations
+for them. If worldport shuffle is on, their worldports will be included in the
+randomization.
+
+The gift maps are accessed via a panel in The Entry's Starting Room, which only
+appears if at least one gift map is enabled. It is also treated like a cyan
+door, and will not appear until the condition specified in the Cyan Door
+Behavior option is satisfied. Solving this panel with the name of one of the
+beta testers will teleport you to their corresponding gift map. This README
+purposefully does not list the names you need to enter the maps via the panel.
+
+In the base game, nothing happens once you complete a gift map. Masteries have
+been added to the gift maps in the randomizer so that the player can be rewarded
+for completing them.
+
+Note that the gift maps were originally only intended to be played by specific
+people, and as a result may be frustrating or require knowledge of inside jokes.
+The Crystalline is particularly difficult as it requires completing a parkour
+course. It is highly recommended that you complete these maps vanilla or solo
+before bringing them to a multiworld. It is also perfectly acceptable to never
+enable them.
+
 ## Running from source
 
 The randomizer is mostly written in Python and GDScript, which do not need to be