diff options
| author | Star Rauchenberger <fefferburbia@gmail.com> | 2023-04-21 12:10:01 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-04-21 12:10:01 -0400 |
| commit | db0f4da0c045e43dd4233efb018ed5090993e1fd (patch) | |
| tree | 4af077ee35af15035a91f0c4514f1fd574209f70 | |
| parent | a80ea459bcba73840eb8457f23aaff03bc1e5c3b (diff) | |
| download | lingo-archipelago-db0f4da0c045e43dd4233efb018ed5090993e1fd.tar.gz lingo-archipelago-db0f4da0c045e43dd4233efb018ed5090993e1fd.tar.bz2 lingo-archipelago-db0f4da0c045e43dd4233efb018ed5090993e1fd.zip | |
Added setup instructions to README
| -rw-r--r-- | README.md | 27 |
1 files changed, 27 insertions, 0 deletions
| diff --git a/README.md b/README.md index 2a52bf9..efeddf8 100644 --- a/README.md +++ b/README.md | |||
| @@ -2,3 +2,30 @@ | |||
| 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. | 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 | 3 | ||
| 4 | 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. | 4 | 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. |
| 5 | |||
| 6 | ## Installation | ||
| 7 | |||
| 8 | 1. Download the Lingo Archipelago Randomizer from [the releases page](https://github.com/hatkirby/lingo-archipelago/releases). | ||
| 9 | 2. Open up Lingo, go to settings, and click View Game Data. This should open up a folder in Windows Explorer. | ||
| 10 | 3. Unzip the contents of the randomizer into the "maps" folder. | ||
| 11 | 4. Installation complete! You may have to click Return to go back to the main menu and then click Settings again in | ||
| 12 | order to get the randomizer to show up in the level selection list. | ||
| 13 | |||
| 14 | ## Joining a Multiworld game | ||
| 15 | |||
| 16 | 1. Launch Lingo | ||
| 17 | 2. Click on Settings, and then Level. Choose Archipelago from the list. | ||
| 18 | 3. Start a new game. Leave the name field blank (anything you type in will be ignored). | ||
| 19 | 4. Enter the Archipelago address, slot name, and password into the fields. | ||
| 20 | 5. Press Connect. | ||
| 21 | 6. Enjoy! | ||
| 22 | |||
| 23 | To continue an earlier game, you can perform the exact same steps as above. You do not have to re-select Archipelago in | ||
| 24 | the level selection screen if you were using Archipelago the last time you launched the game. | ||
| 25 | |||
| 26 | In order to play the base game again, simply return to the level selection screen and choose Level 1 (or whatever else | ||
| 27 | you want to play). The randomizer will not affect gameplay unless you launch it by starting a new game while it is | ||
| 28 | selected in the level selection screen, so it is safe to play the game normally while the client is installed. | ||
| 29 | |||
| 30 | **Note**: Running the randomizer modifies the game's memory. If you want to play the base game after playing the randomizer, | ||
| 31 | you need to restart Lingo first. | ||