Home

WorldAPI puts a Paper server on HTTP. One jar gives sites, bots, and AI agents a REST API and a live WebSocket feed of the world, the players, and their statistics, plus an admin panel in the browser. This wiki is the manual: start at the top of your list and follow the “Next” links.

For players and server owners

1. Installation—put the jar on your server.
2. First steps—your first request, your first token, and the admin panel.
3. Tokens and permissions—who may read and change what.
4. Admin panel—accounts, invites, and forgotten passwords.
5. Configuration—every section of config.yml, and your own database.
6. Reverse proxy—HTTPS with Caddy or nginx, before you open it to the internet.
7. Security—what WorldAPI guards, and what stays up to you.
8. Monitoring—Prometheus, Grafana, and Plan.
9. MCP—ask an AI client about your server.
10. FAQ—short answers and known limits.

For developers

• REST API—conventions, errors, paging, and examples. Then by area: Server, Worlds and blocks, Players, Leaderboards, Events, Files, Access control.
• WebSocket—live topics, snapshots, and the protocol.
• Extensions—share your plugin's data through WorldAPI.
• Java scripts—run Java on the server, for those you'd trust with SSH.
• Building from source, Architecture, Development, Releasing.