Files
archipelago-yamls/README.md
T

53 lines
2.1 KiB
Markdown

# Archipelago YAMLs
Player YAML configs for the [Archipelago](https://archipelago.gg/) multiworld randomizer, plus the custom `.apworld` game plugins some of them depend on. Each YAML configures one game slot for a multiworld seed; files get uploaded to an Archipelago server to generate a game.
## Files
| YAML | Game | Requires |
|---|---|---|
| `Mandalore - Crystal.yaml` | Pokémon Crystal | `pokemon_crystal.apworld` |
| `Mandalore - Emerald.yaml` | Pokémon Emerald | core-supported |
| `MandaloreDS3.yaml` | Dark Souls III | `dark_souls_3.apworld` |
| `MandaloreDS3-less-intensive.yaml` | Dark Souls III (lighter item/location density) | `dark_souls_3.apworld` |
| `Mandalore-EldenRing-BIG.yaml` | Elden Ring (larger pool) | `eldenring.apworld` |
| `Mandalore-EldenRing-Smaller.yaml` | Elden Ring (smaller pool) | `eldenring.apworld` |
| `MandaloreTY1.yaml` | Ty the Tasmanian Tiger | `ty_the_tasmanian_tiger.apworld` |
| `MandoOOT.yaml` | Ocarina of Time | core-supported |
| `MandoZWW.yaml` | The Wind Waker | core-supported |
The `.apworld` files are plugins for games not built into Archipelago core — drop the matching one into your Archipelago install's `custom_worlds/` (or `lib/worlds/`) directory before generating a seed that uses that YAML. Core-supported games need no plugin.
## YAML structure
Every file follows Archipelago's standard shape:
```yaml
name: Mandalore # in-game player name, max 16 chars
game: Game Name
description: ...
Game Name:
progression_balancing: ...
accessibility: ...
# game-specific options...
```
**Weighted values**: most options use a weighted format — each possible value gets a weight, and higher weight means higher probability. A weight of `0` means never chosen; `50` is the conventional "always use this" weight when only one option should have a nonzero value.
```yaml
some_option:
option_a: 50 # always pick this
option_b: 0 # never pick this
```
Some games also accept a single-value shorthand instead of weights:
```yaml
some_option: 'value'
```
## Validation
- YAML syntax: http://www.yamllint.com/
- Archipelago-specific options: https://archipelago.gg/check