Installation

WorldAPI needs Paper 26.3 or a fork of it, like Purpur, on Java 25. Plan is optional.

With Docker (recommended)

If your server runs in itzg/minecraft-server, it fetches WorldAPI itself.

1. Name WorldAPI in MODRINTH_PROJECTS:

   services:
     minecraft:
       image: itzg/minecraft-server:java25
       environment:
         EULA: "TRUE"
         TYPE: PAPER
         VERSION: "26.3"
         MODRINTH_PROJECTS: |
           worldapi
       ports: ["25565:25565"]
       volumes: ["./data:/data"]

2. Start it: docker compose up -d.

worldapi:<version>, like worldapi:3.2.0, pins a version. To take the jar from GitHub instead, use PLUGINS: https://github.com/MairwunNx/minecraft-worldapi/releases/latest/download/worldapi.jar.

Port 8110 stays inside Docker on purpose. Reverse proxy shows how to publish it safely.

By hand

1. Download the jar from Modrinth, Hangar, or GitHub.
2. Put it in plugins/.
3. Restart the server.

What happens on the first start

WorldAPI writes plugins/WorldAPI/config.yml with a fresh admin token and listens on port 8110. The console says so: Listening on 0.0.0.0:8110/api/v1 with … endpoints.

Next: First steps.