Agora documentation
What are you trying to do?
This page is a hub for all the documentation Agora provides. It is organized by what you are trying to do, so you can find the right information quickly. If you are new to Agora, start with the install and first run guide. If you are troubleshooting an issue, check the troubleshooting guide. If you are using the CLI tool, check the CLI reference. If you want to contribute or build Agora, check the development guide.
The links below are the same as the left sidebar with additional descriptions and grouped by audience.
I am new to Agora
Download a package, work through first-run setup, and reach a launch you can recover from.
Install and first run →I want step-by-step guides for everything
Step-by-step guides for common tasks, from installing mods to sharing setups.
Task guides →Something is not working
Start from the symptom: launch blocked, loader mismatch, missing Java, crash after launch, offline failures.
Troubleshooting →I want to use the command line
The CLI reference describes every command, flag, exit code, and file location.
CLI reference →I want to build or contribute
Local builds, validation gates, architecture boundaries, registry curation, and release procedure.
Development guide →Common questions
Straight to the guide that answers it.
- How do I set up my first instance?
- What are versions, loaders, and dependencies?
- Why is my launch blocked, and what is a health check?
- Minecraft crashed — how do I find the cause?
- What does a snapshot actually protect?
- What does Agora send, and how do I play offline?
- How do I move a setup to another machine?
- How much memory should I give Minecraft?
Already have Agora installed?
The app has the same guides built in under Help & Guide, where they are searchable and link directly to the screens they describe. This website publishes them so you can read them before installing, or send someone a link to a specific answer.
Advanced and developer docs
The above guides are meant for desktop app users. If you are using the CLI tool, wish to contribute, or want to understand the inner workings of Agora, check the developer docs. They cover the CLI reference, local builds, validation gates, architecture boundaries, registry curation, and release procedure.
For everyone using Agora
For contributors and maintainers
Contribute and curate
Code of Engagement
The rules below govern reviews, comments, and community participation across the Agora registry. They apply everywhere Agora accepts community text, including review forms and registry proposals. The quoted text is the canonical wording re…
How Agora's documentation is organized
Agora's documentation is organized by audience and by depth. The goal is to help a player complete a task quickly without forcing maintainers, CLI users, and governance operators through the same page. This file describes the system; it is…
Agora Registry Curation Reference
A self-contained reference for an agent who does not have access to the Agora repository. With this document alone, you can author valid mod / pack / shader / resource pack / datapack / server / world manifests for the curated registry.
Architecture
Elsewhere
Desktop packages ship in v* releases. registry-* releases contain catalog data assets, not installers.