ArchipelagoEX
A downloadable Tool for Windows, macOS, and Linux
What It Is
- frontend/UI/wrapper for Archipelago functionality
- run/YAML organizer
What It Is Not
- A game
- YAML file editor (please use a capable editor for that, e.g., VS Code)
- AP world
- file-manager
- file archive
- A new game-generation feature
Concept
This tool is designed to be installed alongside your Archipelago installation. It helps you store YAML files and configure runs, making it easier to manage complex setups and reuse YAML files without manually copying them. It also automates moving YAML files around.
Think of it like LaunchBox/RetroArch for emulators or a Git client for Git, but for Archipelago. For example, you can configure your YAMLs, press "Run," and the tool will:
- Merge the YAML files together
- Move them to the correct directory
- Start the local generation process
- If successful, store the game (and its patches)
- Clean up your "players" directory, so no manual copy-pasting is needed
That's the initial idea. Possible future features include:
- A game launcher to start your game with a tracker alongside it
- A YAML merger to update YAML files with new versions
- Automatic run uploads (if that's allowed by Archipelago)
- A YAML snippet store for things like:
- Priority locations for a game
- Plando blocks
FAQ
Reset your installation
- Open your AP installation in cmd/powershell/any shell
- in windows: type
cmd
in the address bar of your explorer window
- in windows: type
- Run the executable with
--reset
- Windows:
AEXTui.exe --reset
- Linux:
./AEXTui --reset
- Windows:
Can't find my game
- make sure it's installed in, and only in,
custom_worlds
- run the
Reload games
action in AEX - if it's still not there run Generate Template Options from the
ArchipelagoLauncher
and see if a template gets generated
Imports
- (singular) Multiworld import That's probably the most common use-case. Reads and splits all
.yaml
files in a directory, everything will be linked to one single new MW. That's the async planer one. You can basically prepare the Players folder anywhere you want and load it in as a MW. - Multiworlds import Also searches a directory for yamls, but this links everything to independent multiworlds, if it finds a multigame
.yaml
here the configs will be split and they get linked to one MW. - Configs only Searches a directory for
.yaml
files and imports everything as a config. When it finds a multigame config (multiple games, not randomized game) it splits them into individual configs. Just a big bulk import of configs, useful when you have a big directory and just want to load everything in.
(Graphical) User Interface
It's a T(erminal)UI for now, because that is what I personally prefer. I'll make a GUI version when there is a demand for it and the features are a bit more set. But please don't be intimidated by the TUI. My goal is to make it accessible for everyone, even as a TUI. If you try it out and you don't get it, please let me know.
Download
Install instructions
Installation
- Drop the
AEXTui.exe
in your archipelago directory. (same level asArchipelagoGenerate.exe
) - That's it...
Uninstall
- Reset you installation (See below)
- Delete the
AEXTui.exe
Reset your installation
- Open your AP installation in cmd/powershell/any shell
- in windows: type
cmd
in the address bar of your explorer window
- in windows: type
- Run the executable with
--reset
- Windows:
AEXTui.exe --reset
- Linux:
./AEXTui --reset
- Windows:
Development log
- Patch notes 0.1.4920 days ago
- Patch notes 0.1.4821 days ago
- Patch notes 0.1.4524 days ago
- Patch Notes 0.1.4229 days ago
- Patch Notes 0.1.4130 days ago
- Patch Notes 0.1.3832 days ago
- Patch Notes 0.1.3633 days ago