about summary refs log tree commit diff stats
path: root/apworld
diff options
context:
space:
mode:
authorStar Rauchenberger <fefferburbia@gmail.com>2025-09-25 19:50:42 -0400
committerStar Rauchenberger <fefferburbia@gmail.com>2025-09-25 19:50:42 -0400
commitd30a8e2ca351ba05d1b346e59feef6d098f75adf (patch)
tree9b79740df8cec5c6117869f9c149f86edf0a0e2c /apworld
parentf0c59deb3bfa9189c2136ab3c494f8a5b452470b (diff)
downloadlingo2-archipelago-d30a8e2ca351ba05d1b346e59feef6d098f75adf.tar.gz
lingo2-archipelago-d30a8e2ca351ba05d1b346e59feef6d098f75adf.tar.bz2
lingo2-archipelago-d30a8e2ca351ba05d1b346e59feef6d098f75adf.zip
Reorganized READMEs
Diffstat (limited to 'apworld')
-rw-r--r--apworld/CHANGELOG.md72
-rw-r--r--apworld/README.md48
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
14Download:
15[lingo2.apworld](https://files.fourisland.com/releases/lingo2-archipelago/apworld/v6.6/lingo2.apworld)<br/>
16Template YAML:
17[Lingo 2.yaml](https://files.fourisland.com/releases/lingo2-archipelago/apworld/v6.6/Lingo%202.yaml)<br/>
18Source:
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
28Download:
29[lingo2.apworld](https://files.fourisland.com/releases/lingo2-archipelago/apworld/v5.5/lingo2.apworld)<br/>
30Template YAML:
31[Lingo 2.yaml](https://files.fourisland.com/releases/lingo2-archipelago/apworld/v5.5/Lingo%202.yaml)<br/>
32Source:
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
39Download:
40[lingo2.apworld](https://files.fourisland.com/releases/lingo2-archipelago/apworld/v4.4/lingo2.apworld)<br/>
41Template YAML:
42[Lingo 2.yaml](https://files.fourisland.com/releases/lingo2-archipelago/apworld/v4.4/Lingo%202.yaml)<br/>
43Source:
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
55Download:
56[lingo2.apworld](https://files.fourisland.com/releases/lingo2-archipelago/apworld/v4.3/lingo2.apworld)<br/>
57Template YAML:
58[Lingo 2.yaml](https://files.fourisland.com/releases/lingo2-archipelago/apworld/v4.3/Lingo%202.yaml)<br/>
59Source:
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
67Download:
68[lingo2.apworld](https://files.fourisland.com/releases/lingo2-archipelago/apworld/v3.2/lingo2.apworld)<br/>
69Template YAML:
70[Lingo 2.yaml](https://files.fourisland.com/releases/lingo2-archipelago/apworld/v3.2/Lingo%202.yaml)<br/>
71Source:
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
3The Lingo 2 Apworld allows you to generate Archipelago Multiworlds containing
4Lingo 2.
5
6## Installation
7
81. Download the Lingo 2 Apworld from
9 [the releases page](https://code.fourisland.com/lingo2-archipelago/about/apworld/CHANGELOG.md).
102. If you do not already have it, download and install the
11 [Archipelago software](https://github.com/ArchipelagoMW/Archipelago/releases/).
123. 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
17The apworld is mostly written in Python, which does not need to be compiled.
18However, there are two files that need to be generated before the apworld can be
19used.
20
21The first file is `data.binpb`, the datafile containing the randomizer logic.
22You can read about how to generate it on
23[its own README page](https://code.fourisland.com/lingo2-archipelago/about/data/README.md).
24Once you have it, put it in a subfolder of `apworld` called `generated`.
25
26The second generated file is `data_pb2.py`. This file allows Archipelago to read
27the datafile. We use `protoc`, the Protocol Buffer compiler, to generate it. As
28of 0.6.3, Archipelago has protobuf 3.20.3 packaged with it, which means we need
29to compile our proto file with a similar version.
30
31If you followed the steps to generate `data.binpb` and compiled the `datapacker`
32tool yourself, you will already have protobuf version 3.21.12 installed through
33vcpkg. You can then run a command similar to this in order to generate the
34python 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
41The exact path to `protoc.exe` is going to depend on where vcpkg installed its
42packages. The above location is where Visual Studio will probably put it.
43
44After generating those two files, the apworld should be functional. You can copy
45it into an Archipelago source tree (rename the folder `apworld` to `lingo2` if
46you do so) if you want to edit/debug the code. Otherwise, you can zip up the
47folder and rename it to `lingo2.apworld` in order to package it for
48distribution.