Pokepelago Client

Welcome to the Pokepelago Client, the companion React web application for the Archipelago Pokepelago APWorld!

This client allows you to visually track your progress, track your caught Pokémon, and interact with the Archipelago multiworld server in a highly polished, interactive Pokédex interface.

New to Pokepelago? The main setup guide lives on AP-Pie: Pokepelago setup guide. It covers the .apworld install, the YAML, and connecting.

Features

• Archipelago Integration: Connects directly to any Archipelago server using archipelago.js.
• Real-time Sync: Instantly receives items, type keys, and updates your Pokédex as you progress through your seed.
• Smart Logic Validations: Prevents you from guessing Pokémon you haven't mathematically unlocked yet (e.g., requires specific Type Keys).
• Responsive Design: Includes a masonry-style Pokédex or a traditional grid.
• Visual Flourishes: Features shiny variations, hints, and dynamic unlocking animations.

Setup & Installation

Make sure you have Node.js installed on your machine.

1. Clone the repository:

   git clone https://github.com/dowlle/PokepelagoClient.git
   cd PokepelagoClient

2. Install dependencies:

   npm install

3. Start the development server:

   npm run dev

4. Build for production:

   npm run build

How to Connect

Note: This client runs in your web browser. Since apworld 0.6.5, clicking your slot link on the room page opens a chooser in the Archipelago Launcher that can open the web client for you; you can also just open the address below.

1. Open the Pokepelago Client in your browser (Chrome or Firefox recommended).
2. Enter your AP server address (hostname and port), your slot name, and password (if any).
3. The client connects to the server via WebSocket. If your server uses HTTPS, the client will use a secure connection automatically.

How to Play

1. Start your Archipelago Server with the Pokepelago .apworld generated seed.
2. Open the Pokepelago Client in your browser.
3. Enter your Hostname, Port, and Slot Name (e.g., AshKetchum) in the connection prompt.
4. Once connected, your Oak's Lab starting items will automatically sync.
5. Use the input bar at the bottom to "guess" Pokémon names.
6. As you guess Pokémon and receive items from the multiworld, more Pokémon will become catchable!

Debugging

The client includes an auto-guesser script designed for testing seed mathematically. You can activate it by enabling the Debug Controls in the UI settings or using the custom debug triggers.

---

Contributing

Feel free to open issues or submit pull requests if you want to improve the client's UI or add new tracking features!

AI usage

I use AI while developing Pokepelago. It helps with implementation, debugging, and review, while I make the design decisions and test releases in the browser. The project does not use AI-generated art. I am disclosing this because I want people to know how the project is made. I have ADHD, and this is one of the tools that helps me turn ideas into finished projects.

More detail about how I use and verify AI-assisted work is available in AI_USAGE.md.

License

The Pokepelago client is licensed under the GNU Affero General Public License v3.0 or later (AGPL-3.0-or-later) — see LICENSE. Copyright (C) 2026 Dowlle.

The Pokepelago APWorld (the Python world, distributed separately) is licensed under the MIT License.