YARGArchipelago randomizer mod

Compatibility notes

• Use APWorld 1.3.0 with YARGAPClient 1.0.1. Both release pages request the other component’s 1.x series; the World requires Archipelago 0.6.7 or newer. The ordinary YARG application alone is not the AP client. Windows was the distribution examined; Linux and macOS downloads exist, but their runtime was not tested here.
• Install the official setlist through YARC Launcher and download the AP client separately. Install yarg.apworld, create your options, generate and host a room, then scan the required charts in YARGAPClient. Open its Archipelago menu and enter host, port and slot; leave Game ID blank for the base YARG World. If songs are missing, use the maintainer’s folder-discovery and rescan steps.
• The default selects ten songs from the official setlist: nine ordinary songs award three checks each, for 27 checks, and one song is the goal. You start with one song unlocked, then receive song unlocks, five required Gems and Star Power bonuses. Version 1.3.0 adds Classical Keys Pack 3 and Children’s Keys Pack 3 to the available catalog. Setlist metadata in the World does not include the music or charts; install only content you are entitled to use.
• Instrument shuffle is optional and requires at least two selected instruments with enough compatible charts. It can reject a randomly selected subset even if the larger library has compatible songs. The client requires the goal song, Gems and its assigned instrument, then completion of the song. The World’s completion predicate drops that instrument requirement and does not require a song-clear event, so it is not an exact representation of the client’s goal trigger.
• Keep the client connected while finishing a song: disconnected completions are not held in a persistent sending queue, so replay the song after reconnecting. Star Power bonuses received outside a song do not provide a later stored bonus. Restart the client before switching rooms because instrument allowances are retained in a process-wide set. Goal transmission and transient-bonus replay have no persistent recovery ledger.
• The connection cache stores the room password and the journal can include it; avoid reusing sensitive credentials or sharing unredacted logs/cache files. Use an explicit WSS address where supported: a bare address can fall back to WS, and the saved host/port does not preserve the scheme. DeathLink defaults off and offers instant-fail or recoverable one-hit modes. EnergyLink is on by default and contributes song score to the shared energy pool.
• The sixteen World Python modules match the tagged source; remaining differences concern tutorial/manifest packaging. Critical client behavior was also read from the Windows assembly. World source is MIT and client source LGPL-3.0-or-later, but complete distributed notices remain undocumented. The World’s ten test functions are APQuest examples, not YARG rule tests; inherited audio tests do not establish AP reconnect or delivery coverage.