about summary refs log tree commit diff stats
diff options
context:
space:
mode:
-rw-r--r--README.md189
1 files changed, 132 insertions, 57 deletions
diff --git a/README.md b/README.md index 9f196d2..3d50f48 100644 --- a/README.md +++ b/README.md
@@ -1,53 +1,103 @@
1# Lingo Archipelago Client 1# Lingo Archipelago Client
2[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.
3 2
4This is a project that modifies the game [Lingo](https://lingothegame.com/) so that it can be played as part of an Archipelago multiworld game. 3[Archipelago](https://archipelago.gg/) is an open-source project that supports
4randomizing a number of different games and combining them into one cooperative
5experience. Items from each game are hidden in other games. For more information
6about Archipelago, you can look at their website.
7
8This is a project that modifies the game [Lingo](https://lingothegame.com/) so
9that it can be played as part of an Archipelago multiworld game.
5 10
6## Installation 11## Installation
7 12
81. Download the Lingo Archipelago Randomizer from [the releases page](https://code.fourisland.com/lingo-archipelago/about/CHANGELOG.md). 13The Lingo Archipelago client is available on
92. Open up Lingo, go to settings, and click View Game Data. This should open up a folder in Windows Explorer. 14[Steam Workshop](https://steamcommunity.com/sharedfiles/filedetails/?id=3092505110).
103. 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. 15If you click Subscribe on that page, Lingo will automatically download the map,
114. Installation complete! You may have to click Return to go back to the main menu and then click Settings again in 16and it will download any updates as they are posted.
12 order to get the randomizer to show up in the level selection list. 17
18If you don't want to / can't use Steam Workshop, you can install the mod
19manually:
20
211. Download the Lingo Archipelago Randomizer from
22 [the releases page](https://code.fourisland.com/lingo-archipelago/about/CHANGELOG.md).
232. Open up Lingo, go to settings, and click View Game Data. This should open up
24 a folder in Windows Explorer.
253. Place the randomizer in the "maps" folder. You may need to create the "maps"
26 folder if you have not played a custom Lingo map before. Older releases of
27 the randomizer are zip files; if you downloaded a zip file, you need to unzip
28 it.
294. Installation complete! You may have to click Return to go back to the main
30 menu and then click Settings again in order to get the randomizer to show up
31 in the level selection list.
13 32
14## Joining a Multiworld game 33## Joining a Multiworld game
15 34
161. Launch Lingo 351. Launch Lingo
172. Click on Settings, and then Level. Choose Archipelago from the list. 362. Click on Settings, and then Level. Choose Archipelago from the list.
183. Start a new game. Leave the name field blank (anything you type in will be ignored). 373. Start a new game. Leave the name field blank (anything you type in will be
38 ignored).
194. Enter the Archipelago address, slot name, and password into the fields. 394. Enter the Archipelago address, slot name, and password into the fields.
205. Press Connect. 405. Press Connect.
216. Enjoy! 416. Enjoy!
22 42
23To continue an earlier game, you can perform the exact same steps as above. You do not have to re-select Archipelago in 43To continue an earlier game, you can perform the exact same steps as above. You
24the level selection screen if you were using Archipelago the last time you launched the game. 44do not have to re-select Archipelago in the level selection screen if you were
45using Archipelago the last time you launched the game.
25 46
26In order to play the base game again, simply return to the level selection screen and choose Level 1 (or whatever else 47In order to play the base game again, simply return to the level selection
27you want to play). The randomizer will not affect gameplay unless you launch it by starting a new game while it is 48screen and choose Level 1 (or whatever else you want to play). The randomizer
28selected in the level selection screen, so it is safe to play the game normally while the client is installed. 49will not affect gameplay unless you launch it by starting a new game while it is
50selected in the level selection screen, so it is safe to play the game normally
51while the client is installed.
29 52
30**Note**: Running the randomizer modifies the game's memory. If you want to play the base game after playing the randomizer, 53**Note**: Running the randomizer modifies the game's memory. If you want to play
31you need to restart Lingo first. 54the base game after playing the randomizer, you need to restart Lingo first.
32 55
33## Running from source 56## Running from source
34 57
35The randomizer is almost ready to run from source. The only step that is required is to compile the LL1.yaml datafile into gamedata.gd, which needs to be played in the Archipelago folder. The generate_gamedata.rb script in the util folder can do this for you. The first argument is the path to the datafile, and the second argument is the path to the output file. 58If you are not testing local changes to the source code, skip this section and
59read the Installation section instead.
36 60
37## Features 61The randomizer is almost ready to run from source. The only step that is
62required is to compile the gamedata.gd file, which is generated from the
63[LL1.yaml](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/lingo/data/LL1.yaml)
64and
65[ids.yaml](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/lingo/data/ids.yaml)
66datafiles from the Archipelago source tree. The generate_gamedata.rb script in
67the util folder can do this for you. The first argument is the path to the
68LL1.yaml datafile, the second is the path to the ids.yaml datafile, and the
69third argument is the path to the output file.
38 70
39There are a couple of modes of randomization currently available, and you can pick and choose which ones you would like to use. 71## Features
40 72
41- **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. 73There are a couple of modes of randomization currently available, and you can
42- **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). 74pick and choose which ones you would like to use.
43- **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. 75
44- **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. 76- **Door shuffle**: There are many doors in the game, which are opened by
77 completing a set of panels. With door shuffle on, the doors become items and
78 only open up once you receive the corresponding item. The panel sets that
79 would ordinarily open the doors become locations.
80- **Color shuffle**: There are ten different colours of puzzle in the game, each
81 representing a different mechanic. With color shuffle on, you would start with
82 only access to white puzzles. Puzzles of other colours will require you to
83 receive an item in order to solve them (e.g. you can't solve any red puzzles
84 until you receive the "Red" item).
85- **Panel shuffle**: Panel shuffling replaces the puzzles on each panel with
86 different ones. So far, the only mode of panel shuffling is "rearrange" mode,
87 which simply shuffles the already-existing puzzles from the base game onto
88 different panels.
89- **Painting shuffle**: This randomizes the appearance of the paintings in the
90 game, as well as which of them are warps, and the locations that they warp you
91 to. It is the equivalent of an entrance randomizer in another game.
45 92
46## Frequently Asked Questions 93## Frequently Asked Questions
47 94
48### What are location checks in this game? 95### What are location checks in this game?
49 96
50Puzzle 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: 97Puzzle sets that ordinarily open doors in the base game are almost always
98location checks, even if you do not have door shuffle on. Achievement panels
99(ones starting with "THE", including "THE END") are also checks. There are also
100a few other panels that are location checks:
51 101
52- THE EYES / THEY SEE in Crossroads 102- THE EYES / THEY SEE in Crossroads
53- HIDE / SEEK (x4) in Hedge Maze 103- HIDE / SEEK (x4) in Hedge Maze
@@ -61,19 +111,31 @@ Puzzle sets that ordinarily open doors in the base game are almost always locati
61 111
62These may change in the future. 112These may change in the future.
63 113
64**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. 114**Note**: In the second room, you ordinarily only have to solve HI / HIGH to
65 115open the door. This is modified in the randomizer so that you have to solve both
66LEVEL 2 (the panel that unlocks Level 2) is a check. If Level 2 is selected as your victory condition, you will be required to solve the provided number of puzzles before you can get access to the LEVEL 2 panel. If Level 2 is not your victory condition, the LEVEL 2 room is automatically available as soon as you reach Second Room. 116puzzles to receive a location check.
67 117
68### Is my progress saved locally? 118### Is my progress saved locally?
69 119
70Lingo 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. 120Lingo autosaves your progress every time you solve a puzzle. The randomizer
121generates a savefile name based on your Multiworld seed and slot number, so you
122should be able to seamlessly switch between multiworlds and even slots within a
123multiworld.
71 124
72The 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. 125The exception to this is different rooms created from the same multiworld seed.
126The client is unable to tell rooms in a seed apart (this is a limitation of the
127Archipelago API), so the client will use the same save file for the same slot in
128different rooms on the same seed. You can work around this by manually moving or
129removing the save file from the level1 save file directory.
73 130
74If 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. 131If you play the base game again, you will see one or more save files with a long
132name that begins with "zzAP\_". These are the saves for your multiworlds. They
133can be safely deleted after you have completed the associated multiworld. It is
134not recommended to load these save files outside of the randomizer.
75 135
76A 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. 136A connection to Archipelago is required to resume playing a multiworld. This is
137because the set of items you have received is not stored locally. This may be
138changed in the future.
77 139
78### How do I solve the YOU puzzle in Champion's Rest? 140### How do I solve the YOU puzzle in Champion's Rest?
79 141
@@ -81,34 +143,47 @@ The solution to this puzzle is set to your slot name.
81 143
82### What about wall snipes? 144### What about wall snipes?
83 145
84"Wall sniping" refers to the fact that you are able to solve puzzles on the other side of opaque walls. This randomizer 146"Wall sniping" refers to the fact that you are able to solve puzzles on the
85does not change how wall snipes work, but it will never require the use of them. There are three puzzles from the base 147other side of opaque walls. This randomizer does not change how wall snipes
86game that you would ordinarily be expected to wall snipe. The randomizer moves these panels out of the wall or otherwise 148work, but it will never require the use of them. There are three puzzles from
87reveals them so that a snipe is not necessary. 149the base game that you would ordinarily be expected to wall snipe. The
150randomizer moves these panels out of the wall or otherwise reveals them so that
151a snipe is not necessary.
88 152
89Because of this, all wall snipes are considered out of logic. This includes sniping The Bearer's MIDDLE while standing 153Because of this, all wall snipes are considered out of logic. This includes
90outside The Bold, sniping The Colorful without opening all of the color doors, and sniping WELCOME from next to WELCOME 154sniping The Bearer's MIDDLE while standing outside The Bold, sniping The
91BACK. 155Colorful without opening all of the color doors, and sniping WELCOME from next
156to WELCOME BACK.
92 157
93### What about the pilgrimage? 158### What about the pilgrimage?
94 159
95The intended method of reaching the Pilgrim Room in the base game is known as "doing a pilgrimage". It involves entering 160The intended method of reaching the Pilgrim Room in the base game is known as
96each sunwarp in order without using any non-painting warps in between. This is difficult to map out properly in AP logic, 161"doing a pilgrimage". It involves entering each sunwarp in order without using
97so we only consider one specific path through the map to be the canonical pilgrimage route. Accessing the Pilgrim Room by 162any non-painting warps in between. This is difficult to map out properly in AP
98pilgrimage is only in logic if this specific route is available to you: 163logic, so we only consider one specific path through the map to be the canonical
99 164pilgrimage route. Accessing the Pilgrim Room by pilgrimage is only in logic if
100* From the Starting Room, proceed through the Second Room and into the Hub Room. Enter the first sunwarp. 165this specific route is available to you:
101* From the Crossroads, use the front tower entrance (the one nearest The Discerning; not the one next to Sword/Words). Go 166
102 through the Hot Crusts Door and enter the second sunwarp. 167- From the Starting Room, proceed through the Second Room and into the Hub Room.
103* Enter the third sunwarp immediately after. 168 Enter the first sunwarp.
104* Proceed past The Initiated and through the shortcut door back to the Hub Room. Go through the shortcut door to the 169- From the Crossroads, use the front tower entrance (the one nearest The
105 tower's first floor and enter the fourth sunwarp. 170 Discerning; not the one next to Sword/Words). Go through the Hot Crusts Door
106* Use the shortcut to the Directional Gallery (the one outside The Undeterred; not the one further down the hallway where 171 and enter the second sunwarp.
107 the Number Hunt is), pass through the Salt Pepper Door, and return to the Hub Room. Use the nearby entrance to the 172- Enter the third sunwarp immediately after.
108 Crossroads and proceed to the fifth sunwarp. 173- Proceed past The Initiated and through the shortcut door back to the Hub Room.
109* Use the door that takes you to The Steady, and then the one that takes you to The Bearer, and then the one that takes you 174 Go through the shortcut door to the tower's first floor and enter the fourth
110 to The Initiated. Return to the Hub Room once more, and enter The Tenacious via the shortcut that opens upon solving the 175 sunwarp.
111 palindromes. Use the top-right door to access the area Outside the Agreeable, and enter the final sunwarp. 176- Use the shortcut to the Directional Gallery (the one outside The Undeterred;
112 177 not the one further down the hallway where the Number Hunt is), pass through
113This route can be seen [starting at 2:47 in this video](https://youtu.be/8GfuDRRswdA?t=167). Note that this will almost 178 the Salt Pepper Door, and return to the Hub Room. Use the nearby entrance to
114never be required if door shuffle is enabled, as one of the other entrances to the room will usually be available sooner. 179 the Crossroads and proceed to the fifth sunwarp.
180- Use the door that takes you to The Steady, and then the one that takes you to
181 The Bearer, and then the one that takes you to The Initiated. Return to the
182 Hub Room once more, and enter The Tenacious via the shortcut that opens upon
183 solving the palindromes. Use the top-right door to access the area Outside the
184 Agreeable, and enter the final sunwarp.
185
186This route can be seen
187[starting at 2:47 in this video](https://youtu.be/8GfuDRRswdA?t=167). Note that
188this will almost never be required if door shuffle is enabled, as one of the
189other entrances to the room will usually be available sooner.