Bowmark AIdocs

Archipelago

Archipelago — the open-source multiworld/randomizer tool for game speedrunning communities.

Archipelago — the open-source multiworld/randomizer tool for game speedrunning communities. Reads the latest client release straight from GitHub (every platform installer, with its direct download URL) and archipelago.gg's own published per-game randomizer-options YAML template, no key, no browser.

Domain: archipelago.gg

Also known as: Archipelago, ArchipelagoMW, archipelago.gg, Archipelago Multiworld

Call it directly

bowmark.providers.archipelago.getClientRelease(): Promise<ArchipelagoRelease>
bowmark.providers.archipelago.getGameOptions(game: string): Promise<ArchipelagoGameOptions>

Functions

FunctionWhat it does
getClientReleaseReturns the latest published Archipelago client release from GitHub — the version tag, the release page URL, and every platform asset (Windows .exe, Linux .AppImage/.tar.gz, Android .apk)…
getGameOptionsReturns one game's per-player randomizer-options YAML template exactly as archipelago.gg publishes it — the file a real Archipelago multiworld generator player YAML is built from, comments…

Types

interface ArchipelagoAsset {
  name: string;
  platform: "windows" | "linux" | "android" | "macos" | "unknown";
  downloadUrl: string;
  size: number;
}
interface ArchipelagoRelease {
  version: string;
  url: string;
  publishedAt: string;
  assets: ArchipelagoAsset[];
}
interface ArchipelagoGameOptions {
  game: string;
  yaml: string;
}