Home

Welcome to the archipelagopy wiki!

archipelagopy is a Python API wrapper for the Archipelago Randomizer network protocol, built with Pydantic and asyncio.

Getting started

1. Install: pip install archipelagopy
2. Requires Python 3.11+
3. If you're new to async Python, see the asyncio documentation first
4. To test against a server, see the Archipelago setup guide

Pages

• Client Configuration - Constructor parameters, SSL, and reconnection settings
• Callbacks - Full callback reference, lifecycle, and override patterns
• Packets - Client and server packet types

Examples

Start with the Simple Client and work your way up:

• Simple Client - Connect, log in, and print messages (start here)
• Advanced Client - Subclassed client with error handling and context manager
• Chat Client - Interactive chat with async terminal input
• Multiple Clients - Connecting to multiple servers with shared data package caching

Quick links

• Archipelago Network Protocol - Official protocol specification