2 files changed, 87 insertions, 0 deletions

@@ -0,0 +1,42 @@
+# Lingo
+
+## Where is the settings page?
+
+The [player settings page for this game](../player-settings) contains all the options you need to configure and export a
+config file.
+
+## What does randomization do to this game?
+
+There are a couple of modes of randomization currently available, and you can pick and choose which ones you would like
+to use.
+
+* **Door shuffle**: There are many doors in the game, which are opened by completing a set of panels. With door shuffle
+  on, the doors become items and only open up once you receive the corresponding item. The panel sets that would
+  ordinarily open the doors become locations.
+
+* **Color shuffle**: There are ten different colors of puzzle in the game, each representing a different mechanic. With
+  color shuffle on, you would start with only access to white puzzles. Puzzles of other colors will require you to
+  receive an  item in order to solve them (e.g. you can't solve any red puzzles until you receive the "Red" item).
+
+* **Panel shuffle**: Panel shuffling replaces the puzzles on each panel with different ones. So far, the only mode of
+  panel shuffling is "rearrange" mode, which simply shuffles the already-existing puzzles from the base game onto
+  different panels.
+
+* **Painting shuffle**: This randomizes the appearance of the paintings in the game, as well as which of them are warps,
+  and the locations that they warp you to. It is the equivalent of an entrance randomizer in another game.
+
+## What is a "check" in this game?
+
+Most panels / panel sets that open a door are now location checks, even if door shuffle is not enabled. Various other
+puzzles are also location checks, including the achievement panels for each area.
+
+## What about wall snipes?
+
+"Wall sniping" refers to the fact that you are able to solve puzzles on the other side of opaque walls. This randomizer
+does not change how wall snipes work, but it will never require the use of them. There are three puzzles from the base
+game that you would ordinarily be expected to wall snipe. The randomizer moves these panels out of the wall or otherwise
+reveals them so that a snipe is not necessary.
+
+Because of this, all wall snipes are considered out of logic. This includes sniping The Bearer's MIDDLE while standing
+outside The Bold, sniping The Colorful without opening all of the color doors, and sniping WELCOME from next to WELCOME
+BACK.
@@ -0,0 +1,45 @@
+# Lingo Randomizer Setup
+
+## Required Software
+
+- [Lingo](https://store.steampowered.com/app/1814170/Lingo/)
+- [Lingo Archipelago Randomizer](https://code.fourisland.com/lingo-archipelago/about/CHANGELOG.md)
+
+## Optional Software
+
+- [Archipelago Text Client](https://github.com/ArchipelagoMW/Archipelago/releases)
+- [Lingo AP Tracker](https://code.fourisland.com/lingo-ap-tracker/about/CHANGELOG.md)
+
+## Installation
+
+1. Download the Lingo Archipelago Randomizer from the above link.
+2. Open up Lingo, go to settings, and click View Game Data. This should open up
+   a folder in Windows Explorer.
+3. Unzip the contents of the randomizer into the "maps" folder. You may need to
+   create the "maps" folder if you have not played a custom Lingo map before.
+4. Installation complete! You may have to click Return to go back to the main
+   menu and then click Settings again in order to get the randomizer to show up
+   in the level selection list.
+
+## Joining a Multiworld game
+
+1. Launch Lingo
+2. Click on Settings, and then Level. Choose Archipelago from the list.
+3. Start a new game. Leave the name field blank (anything you type in will be
+   ignored).
+4. Enter the Archipelago address, slot name, and password into the fields.
+5. Press Connect.
+6. Enjoy!
+
+To continue an earlier game, you can perform the exact same steps as above. You
+do not have to re-select Archipelago in the level selection screen if you were
+using Archipelago the last time you launched the game.
+
+In order to play the base game again, simply return to the level selection
+screen and choose Level 1 (or whatever else you want to play). The randomizer
+will not affect gameplay unless you launch it by starting a new game while it is
+selected in the level selection screen, so it is safe to play the game normally
+while the client is installed.
+
+**Note**: Running the randomizer modifies the game's memory. If you want to play
+the base game after playing the randomizer, you need to restart Lingo first.