diff options
author | Star Rauchenberger <fefferburbia@gmail.com> | 2025-09-25 19:50:42 -0400 |
---|---|---|
committer | Star Rauchenberger <fefferburbia@gmail.com> | 2025-09-25 19:50:42 -0400 |
commit | d30a8e2ca351ba05d1b346e59feef6d098f75adf (patch) | |
tree | 9b79740df8cec5c6117869f9c149f86edf0a0e2c /apworld | |
parent | f0c59deb3bfa9189c2136ab3c494f8a5b452470b (diff) | |
download | lingo2-archipelago-d30a8e2ca351ba05d1b346e59feef6d098f75adf.tar.gz lingo2-archipelago-d30a8e2ca351ba05d1b346e59feef6d098f75adf.tar.bz2 lingo2-archipelago-d30a8e2ca351ba05d1b346e59feef6d098f75adf.zip |
Reorganized READMEs
Diffstat (limited to 'apworld')
-rw-r--r-- | apworld/CHANGELOG.md | 72 | ||||
-rw-r--r-- | apworld/README.md | 48 |
2 files changed, 0 insertions, 120 deletions
diff --git a/apworld/CHANGELOG.md b/apworld/CHANGELOG.md deleted file mode 100644 index 9637ee4..0000000 --- a/apworld/CHANGELOG.md +++ /dev/null | |||
@@ -1,72 +0,0 @@ | |||
1 | # lingo2-archipelago Apworld Releases | ||
2 | |||
3 | ## v6.6 - 2025-09-19 | ||
4 | |||
5 | - Added options that make the requirements for Purple Ending and Cyan Ending | ||
6 | stricter. With the strict options on, players are required to have all purple | ||
7 | (level 1) letters in order to get Purple Ending, and all cyan (level 2) | ||
8 | letters to get Cyan Ending. These options are on by default. | ||
9 | - Renamed several items and locations, mostly regarding changing relative | ||
10 | directions (left, right, etc) to compass directions. The colored SMILE panels | ||
11 | in Daedalus now have clearer names too. | ||
12 | - Fixed some minor logic errors. | ||
13 | |||
14 | Download: | ||
15 | [lingo2.apworld](https://files.fourisland.com/releases/lingo2-archipelago/apworld/v6.6/lingo2.apworld)<br/> | ||
16 | Template YAML: | ||
17 | [Lingo 2.yaml](https://files.fourisland.com/releases/lingo2-archipelago/apworld/v6.6/Lingo%202.yaml)<br/> | ||
18 | Source: | ||
19 | [v6.6](https://code.fourisland.com/lingo2-archipelago/tag/?h=apworld-v6.6) | ||
20 | |||
21 | ## v5.5 - 2025-09-16 | ||
22 | |||
23 | - Fixed a panel in The Ancient that was missing a symbol. | ||
24 | - Fixed an issue where you could be expected to get S1 in The Darkroom without | ||
25 | having U. | ||
26 | - Renamed a few locations. | ||
27 | |||
28 | Download: | ||
29 | [lingo2.apworld](https://files.fourisland.com/releases/lingo2-archipelago/apworld/v5.5/lingo2.apworld)<br/> | ||
30 | Template YAML: | ||
31 | [Lingo 2.yaml](https://files.fourisland.com/releases/lingo2-archipelago/apworld/v5.5/Lingo%202.yaml)<br/> | ||
32 | Source: | ||
33 | [v5.5](https://code.fourisland.com/lingo2-archipelago/tag/?h=apworld-v5.5) | ||
34 | |||
35 | ## v4.4 - 2025-09-14 | ||
36 | |||
37 | - Fixed panel set location names. | ||
38 | |||
39 | Download: | ||
40 | [lingo2.apworld](https://files.fourisland.com/releases/lingo2-archipelago/apworld/v4.4/lingo2.apworld)<br/> | ||
41 | Template YAML: | ||
42 | [Lingo 2.yaml](https://files.fourisland.com/releases/lingo2-archipelago/apworld/v4.4/Lingo%202.yaml)<br/> | ||
43 | Source: | ||
44 | [v4.4](https://code.fourisland.com/lingo2-archipelago/tag/?h=apworld-v4.4) | ||
45 | |||
46 | ## v4.3 - 2025-09-13 | ||
47 | |||
48 | - Added a location for the anti-collectable in The Repetitive. | ||
49 | - Added trap items. These remove letters from your keyboard until you use the | ||
50 | Key Return in The Entry, similar to the anti-collectable in The Repetitive. | ||
51 | This can be controlled using the `trap_percentage` option, which defaults to | ||
52 | zero. | ||
53 | - Fixed crash on load when using Python 3.11. | ||
54 | |||
55 | Download: | ||
56 | [lingo2.apworld](https://files.fourisland.com/releases/lingo2-archipelago/apworld/v4.3/lingo2.apworld)<br/> | ||
57 | Template YAML: | ||
58 | [Lingo 2.yaml](https://files.fourisland.com/releases/lingo2-archipelago/apworld/v4.3/Lingo%202.yaml)<br/> | ||
59 | Source: | ||
60 | [v4.3](https://code.fourisland.com/lingo2-archipelago/tag/?h=apworld-v4.3) | ||
61 | |||
62 | ## v3.2 - 2025-09-12 | ||
63 | |||
64 | - Initial release for testing. Features include door shuffle, letter shuffle, | ||
65 | and symbol shuffle. | ||
66 | |||
67 | Download: | ||
68 | [lingo2.apworld](https://files.fourisland.com/releases/lingo2-archipelago/apworld/v3.2/lingo2.apworld)<br/> | ||
69 | Template YAML: | ||
70 | [Lingo 2.yaml](https://files.fourisland.com/releases/lingo2-archipelago/apworld/v3.2/Lingo%202.yaml)<br/> | ||
71 | Source: | ||
72 | [v3.2](https://code.fourisland.com/lingo2-archipelago/tag/?h=apworld-v3.2) | ||
diff --git a/apworld/README.md b/apworld/README.md deleted file mode 100644 index 13374b2..0000000 --- a/apworld/README.md +++ /dev/null | |||
@@ -1,48 +0,0 @@ | |||
1 | # Lingo 2 Apworld | ||
2 | |||
3 | The Lingo 2 Apworld allows you to generate Archipelago Multiworlds containing | ||
4 | Lingo 2. | ||
5 | |||
6 | ## Installation | ||
7 | |||
8 | 1. Download the Lingo 2 Apworld from | ||
9 | [the releases page](https://code.fourisland.com/lingo2-archipelago/about/apworld/CHANGELOG.md). | ||
10 | 2. If you do not already have it, download and install the | ||
11 | [Archipelago software](https://github.com/ArchipelagoMW/Archipelago/releases/). | ||
12 | 3. Double click on `lingo2.apworld` to install it, or copy it manually to the | ||
13 | `custom_worlds` folder of your Archipelago installation. | ||
14 | |||
15 | ## Running from source | ||
16 | |||
17 | The apworld is mostly written in Python, which does not need to be compiled. | ||
18 | However, there are two files that need to be generated before the apworld can be | ||
19 | used. | ||
20 | |||
21 | The first file is `data.binpb`, the datafile containing the randomizer logic. | ||
22 | You can read about how to generate it on | ||
23 | [its own README page](https://code.fourisland.com/lingo2-archipelago/about/data/README.md). | ||
24 | Once you have it, put it in a subfolder of `apworld` called `generated`. | ||
25 | |||
26 | The second generated file is `data_pb2.py`. This file allows Archipelago to read | ||
27 | the datafile. We use `protoc`, the Protocol Buffer compiler, to generate it. As | ||
28 | of 0.6.3, Archipelago has protobuf 3.20.3 packaged with it, which means we need | ||
29 | to compile our proto file with a similar version. | ||
30 | |||
31 | If you followed the steps to generate `data.binpb` and compiled the `datapacker` | ||
32 | tool yourself, you will already have protobuf version 3.21.12 installed through | ||
33 | vcpkg. You can then run a command similar to this in order to generate the | ||
34 | python file. | ||
35 | |||
36 | ```shell | ||
37 | .\out\build\x64-Debug\vcpkg_installed\x64-windows\tools\protobuf\protoc.exe -Iproto\ ^ | ||
38 | --python_out=apworld\generated\ .\proto\data.proto | ||
39 | ``` | ||
40 | |||
41 | The exact path to `protoc.exe` is going to depend on where vcpkg installed its | ||
42 | packages. The above location is where Visual Studio will probably put it. | ||
43 | |||
44 | After generating those two files, the apworld should be functional. You can copy | ||
45 | it into an Archipelago source tree (rename the folder `apworld` to `lingo2` if | ||
46 | you do so) if you want to edit/debug the code. Otherwise, you can zip up the | ||
47 | folder and rename it to `lingo2.apworld` in order to package it for | ||
48 | distribution. | ||