> For the complete documentation index, see [llms.txt](https://zumo.fusion.ac/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://zumo.fusion.ac/readme.md).

# Zumo

Zumo is gameplay tracking infrastructure for Hypixel: lobby activity, leaderboards, queues, and replay recording. Developers integrate through **Zed**, the realtime event hub at `https://zed.fusion.ac`.

<button type="button" class="button primary" data-action="ask" data-icon="gitbook-assistant">Ask a question...</button>

<button type="button" class="button secondary" data-action="ask" data-query="How do I get a Zumo API key?" data-icon="key">Get a key</button><button type="button" class="button secondary" data-action="ask" data-query="How do I connect to Zed with Socket.IO?" data-icon="plug">Connect to Zed</button><button type="button" class="button secondary" data-action="ask" data-query="How do I record a Hypixel replay?" data-icon="video">Record a replay</button>

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><h4><i class="fa-rocket" style="color:$primary;">:rocket:</i></h4></td><td><strong>Quickstart</strong></td><td>Request a key, connect to Zed, and receive your first event.</td><td><a href="/spaces/yE16Xb3IemPxJWydtPOj/pages/416edc1381c20849bc41111b02e482a722a49b94">/spaces/yE16Xb3IemPxJWydtPOj/pages/416edc1381c20849bc41111b02e482a722a49b94</a></td><td><a href="/files/LHIOZGoI6dPF36TuRaxH">/files/LHIOZGoI6dPF36TuRaxH</a></td></tr><tr><td><h4><i class="fa-book" style="color:$primary;">:book:</i></h4></td><td><strong>Guides</strong></td><td>Lobby feeds, replay recording, leaderboards, and Bedwars events.</td><td><a href="/spaces/yE16Xb3IemPxJWydtPOj">/spaces/yE16Xb3IemPxJWydtPOj</a></td><td><a href="/files/IaUMODRBBSBL8eUaPX09">/files/IaUMODRBBSBL8eUaPX09</a></td></tr><tr><td><h4><i class="fa-terminal" style="color:$primary;">:terminal:</i></h4></td><td><strong>API reference</strong></td><td>HTTP routes and Socket.IO event schemas for Zed.</td><td><a href="/spaces/M9ty6FYa3j98VSBHF9LN">/spaces/M9ty6FYa3j98VSBHF9LN</a></td><td><a href="/files/ebMoLMpZFyLqpzByuzrk">/files/ebMoLMpZFyLqpzByuzrk</a></td></tr></tbody></table>

{% columns %}
{% column width="50%" %}

## What you connect to

| Piece    | Role                                                                                     |
| -------- | ---------------------------------------------------------------------------------------- |
| **Zumo** | Platform brand and Discord bot. Issues consumer keys (`zk_*`) and publishes some events. |
| **Zed**  | Event hub. Socket.IO fan-out + HTTP for bots, replays, and MCPR downloads.               |
| **Zinc** | Desktop app. Not covered in these docs.                                                  |

**Base URL:** `https://zed.fusion.ac`
{% endcolumn %}

{% column width="50%" %}

## What you can build

* Live lobby join/leave and chat feeds
* Hypixel replay scrape + `.mcpr` download
* Temporary and lifetime leaderboard changes
* Bedwars stats, cosmetics, and party signals

<a href="/spaces/yE16Xb3IemPxJWydtPOj/pages/416edc1381c20849bc41111b02e482a722a49b94" class="button primary" data-icon="rocket-launch">Get started</a> <a href="/spaces/M9ty6FYa3j98VSBHF9LN" class="button secondary" data-icon="terminal">API reference</a>
{% endcolumn %}
{% endcolumns %}

{% hint style="info" %}
Keys are requested in the [Zumo Discord](https://discord.gg/t4HAw5wvDf) with `/zed request` and must be approved before they work. See [Getting a key](https://app.gitbook.com/s/yE16Xb3IemPxJWydtPOj/getting-started/getting-a-key).
{% endhint %}