path: root/README.md

# Lingo Archipelago Client

[Archipelago](https://archipelago.gg/) is an open-source project that supports
randomizing a number of different games and combining them into one cooperative
experience. Items from each game are hidden in other games. For more information
about Archipelago, you can look at their website.

This is a project that modifies the game [Lingo](https://lingothegame.com/) so
that it can be played as part of an Archipelago multiworld game.

## Installation

The Lingo Archipelago client is available on
[Steam Workshop](https://steamcommunity.com/sharedfiles/filedetails/?id=3092505110).
If you click Subscribe on that page, Lingo will automatically download the map,
and it will download any updates as they are posted.

If you don't want to / can't use Steam Workshop, you can install the mod
manually:

1. Download the Lingo Archipelago Randomizer from
   [the releases page](https://code.fourisland.com/lingo-archipelago/about/CHANGELOG.md).
2. Open up Lingo, go to settings, and click View Game Data. This should open up
   a folder in Windows Explorer.
3. Unzip 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.

## Running from source

If you are not testing local changes to the source code, skip this section and
read the Installation section instead.

The randomizer is almost ready to run from source. The only step that is
required is to compile the gamedata.gd file, which is generated from the
[LL1.yaml](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/lingo/data/LL1.yaml)
and
[ids.yaml](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/lingo/data/ids.yaml)
datafiles from the Archipelago source tree. The generate_gamedata.rb script in
the util folder can do this for you. The first argument is the path to the
LL1.yaml datafile, the second is the path to the ids.yaml datafile, and the
third argument is the path to the output file.

## Features

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 colours 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 colours 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.
- **Sunwarp shuffle**: This randomizes the six pairs of sunwarps. The pairing of
  the warps can change, whether a warp is an entrance or an exit can change, and
  the numbering can change. You can also specify whether access to the sunwarps
  should be locked behind receiving certain items.

There is also a built-in text client you can use to talk to other players and
issue commands. You can open and close it by pressing tab.

## Frequently Asked Questions

### What are location checks in this game?

Puzzle sets that ordinarily open doors in the base game are almost always
location checks, even if you do not have door shuffle on. Achievement panels
(ones starting with "THE", including "THE END") are also checks. There are also
a few other panels that are location checks:

- THE EYES / THEY SEE in Crossroads
- HIDE / SEEK (x4) in Hedge Maze
- OUT / OUT in the Wheelbarrow Hallway
- UNDISTRACTED / UNDISTRACTED in the Wheelbarrow Hallway
- CLOCKWISE / COUNTERCLOCKWISE in the Welcome Back Area
- RAINY / RAINBOW in the rainbow room next to The Undeterred (blue room)
- PARANOID / PARANOID in the Directional Gallery
- WADED + WEE / WARTS in the Directional Gallery
- YOU / \[your name\] in Champion's Rest

These may change in the future.

**Note**: In the second room, you ordinarily only have to solve HI / HIGH to
open the door. This is modified in the randomizer so that you have to solve both
puzzles to receive a location check.

### Is my progress saved locally?

Lingo autosaves your progress every time you solve a puzzle. The randomizer
generates a savefile name based on your Multiworld seed and slot number, so you
should be able to seamlessly switch between multiworlds and even slots within a
multiworld.

The exception to this is different rooms created from the same multiworld seed.
The client is unable to tell rooms in a seed apart (this is a limitation of the
Archipelago API), so the client will use the same save file for the same slot in
different rooms on the same seed. You can work around this by manually moving or
removing the save file from the level1 save file directory.

If you play the base game again, you will see one or more save files with a long
name that begins with "zzAP\_". These are the saves for your multiworlds. They
can be safely deleted after you have completed the associated multiworld. It is
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. This may be
changed in the future.

### How do I solve the YOU puzzle in Champion's Rest?

The solution to this puzzle is set to your slot name.

### 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.

### What about the pilgrimage?

You can enable or disable the pilgrimage in the world options. It defaults to
disabled. When disabled, it is impossible to perform a pilgrimage (although the
sunwarps will still work, as long as you haven't disabled them too). The Sun
Painting will be added to the item pool, even if you do not have door shuffle
on, so that you can still access the Pilgrim Antechamber.

When the pilgrimage is enabled, you are required to perform a pilgrimage in
order to access the Pilgrim Antechamber (although the Pilgrim Room itself may
still be accessible through The Seeker if you have door shuffle on). The Sun
Painting will not be added to the pool, and will behave as it does in vanilla
(in that it only moves when you solve HOT CRUST inside the Pilgrim Antechamber).
It is non-trivial to determine whether you are able to perform a pilgrimage at
any given state, but logic will expect you to be able to figure this out. There
are options that let you determine whether or not paintings and/or the roof
access stairs in Crossroads will disable a pilgrimage. When sunwarps are
shuffled, your pilgrimage must take the new numbering of the warps into
consideration. The tracker is able to tell you whether or not the Pilgrim
Antechamber is accessible (as long as there is an otherwise accessible check
inside it), but it can't tell you what your pilgrimage path should be. If you
are lost, you can check your world's spoiler log for direction on the pilgrimage
path to take.

In previous versions of the randomizer, there was a "canonical pilgrimage" that
involved following a specific path in order to reach the Pilgrim Antechamber.
This is no longer relevant, because all possible pilgrimage paths are now in
logic, but you can still see the old route
[starting at 2:47 in this video](https://youtu.be/8GfuDRRswdA?t=167) for
reference.