Skilly/APWorldTester
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Skilly
2026-09-06 17:03:30 +02:00
parent ccd3d8ebf3
commit ce9216d3da
1 changed files with 14 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@@ -2,8 +2,7 @@
_Disclaimer: AI was used in this project_ _Disclaimer: AI was used in this project_
This project checks whether [community Archipelago worlds](https://docs.google.com/spreadsheets/d/1iuzDTOAvdoNe8Ne8i461qGNucg5OuEoF-Ikqs8aUQZw/edit?gid=58422002#gid=58422002) can generate a seed. This project checks whether [community Archipelago worlds](https://docs.google.com/spreadsheets/d/1iuzDTOAvdoNe8Ne8i461qGNucg5OuEoF-Ikqs8aUQZw/edit?gid=58422002#gid=58422002) can generate a seed.
It reads the community worlds spreadsheet, downloads each world's newest `.apworld` file, and runs Archipelago's generator against it in a Docker container. It reads the community worlds spreadsheet, downloads each world's newest `.apworld` file, and runs Archipelago's generator against it in a Docker container. To see the results of this live in action, see [worlds.archipelago.skillysue.nl](https://worlds.archipelago.skillysue.nl)
To see the results of this live in action, see [worlds.archipelago.skillysue.nl](https://worlds.archipelago.skillysue.nl)
Each world is tested five ways: Each world is tested five ways:
@@ -25,8 +24,7 @@ Each test is repeated with different seeds. The results are combined into one of
| Unknown | No usable result, for example because the `.apworld` was missing or a ROM was required | | Unknown | No usable result, for example because the `.apworld` was missing or a ROM was required |
A successful test means the world loaded, generated a seed, and computed the spoiler log at the configured level. With the default `playthrough` level, this also checks that the seed is completable. A successful test means the world loaded, generated a seed, and computed the spoiler log at the configured level. With the default `playthrough` level, this also checks that the seed is completable.
## Requirements ## Requirements
@@ -63,7 +61,12 @@ docker run --rm hello-world
``` ```
### Install the package ### Install the package
Install the latest version with pip:
```sh
pip install --no-cache-dir https://git.skillysue.nl/Skilly/APWorldTester/archive/latest.tar.gz
```
Or clone the repo and install it:
```sh ```sh
# Clone repo # Clone repo
git clone git.skillysue.nl/APWorldTester && cd APWorldTester git clone git.skillysue.nl/APWorldTester && cd APWorldTester
@@ -85,10 +88,10 @@ apworld-tester init
``` ```
That writes the template config to `~/.config/apworld-tester/config.yaml`. That writes the template config to `~/.config/apworld-tester/config.yaml`.
Two settings that require changing: Two settings that require attention:
- `general.output_directory` The output directory for running the tester, including cloning the Archipelago repo and downloaded apworlds. - `general.output_directory` The output directory for running the tester, including cloning the Archipelago repo and downloaded apworlds. Must be changed, otherwise an error is thrown.
- `general.roms_directory` Directory where base ROMs are located for apworlds that need one. - `general.roms_directory` Directory where base ROMs are located for apworlds that need one. Optional, but increases the number of testable worlds.
### GitHub ### GitHub
The tester checks and downloads hundreds of apworlds from GitHub repositories. It is highly recommended to register a GitHub token and store it in an .env file as follows: The tester checks and downloads hundreds of apworlds from GitHub repositories. It is highly recommended to register a GitHub token and store it in an .env file as follows:
@@ -149,3 +152,7 @@ TestRun(
).run() ).run()
``` ```
## Related Projects
- [Community Spreadsheet](https://docs.google.com/spreadsheets/d/1iuzDTOAvdoNe8Ne8i461qGNucg5OuEoF-Ikqs8aUQZw/edit?gid=58422002#gid=58422002): A curated list of games and resources. Without the spreadsheet, this work would be impossible.
- [Archipelago Games Library](https://mk-404.github.io/Archipelago-Games-Library/): A list of available games and tools made by the community. Very player friendly.
- [Archipelago fuzzer](https://github.com/Eijebong/Archipelago-fuzzer): A set of scripts to generate multiworlds to record failures.