Skip to content

hatkirby/ArchipelagoWizard

Repository files navigation

ArchipelagoWizard

ArchipelagoWizard is a tool that can be used to generate YAML files compatible with the Archipelago multiworld multi-game randomizer. It aims to replicate the experience of using the archipelago.gg website for creating YAMLs, while also allowing you to configure options for worlds that are not officially supported by Archipelago.

Features

  • Create YAMLs using a form similar to the website
  • Load YAML files created in the tool or elsewhere
  • Builtin YAML editor for advanced configuration
  • GUI for weighted randomisation of choice and range fields
  • Filterable item picker UI for option sets with many values such as start_inventory
  • Option presets

Not yet implemented

  • Worlds with a random game
  • YAML files with multiple worlds
  • Schematised option types like item_links
  • In-place validation in the YAML editor

Screenshots

Screenshot of the main ArchipelagoWizard window Screenshot of the YAML editor Screenshot of the advanced randomization dialog Screenshot of the item picker dialog

Getting started

The latest version can be downloaded on the releases page. It contains a datafile up-to-date with Archipelago source main as of the time of release.

Only Windows builds are provided currently. However, ArchipelagoWizard is compatible with both macOS and Linux, and has been tested on both.

Compiling from source requires cmake and ninja-build. Run the following commands to configure and build:

git submodule update --init
cmake --preset ap-wizard
cmake --build --preset ap-wizard-debug

Replace "debug" with "release" for a release-optimised build.

ArchipelagoWizard uses a datafile of options dumped from Archipelago. A script (DumpOptions.py) is included in this repository which can be copied into an Archipelago source tree and used to generate this datafile. A minor change to Options.py is also needed (source). There is not currently a way to generate this file with a frozen Archipelago release, but ideally there will be one going forward. The datafile is called dumped-options.json and must be put in the same folder as the executable.