Installation

1. Download the jar

Get AtlasRealms-<version>.jar from your purchase.

2. Drop it in plugins/

Copy the jar into your server’s plugins/ folder. Do not unzip it.

3. Start the server

AtlasRealms’s loader fetches its own database drivers (HikariCP, the MySQL driver, the SQLite driver) from Maven Central the first time it starts. The server needs outbound internet access for this step.

On this first start, AtlasRealms also writes:

• config.yml, roles.yml, locales/en_US.yml, and ten menu files under plugins/AtlasRealms/.
• A template licence file at plugins/AtlasLoader/atlasrealms.yml, in a folder shared with any other Oreades plugin on the server.

The plugin stays disabled until a licence key is in place.

Note

AtlasRealms and AtlasSpawner share one AtlasLoader folder. Each plugin reads its own file inside it — atlasrealms.yml for AtlasRealms.

4. Activate your licence

Open plugins/AtlasLoader/atlasrealms.yml and paste your key into the license field:

license: "your-key-here"
version: latest
channel: stable

Start the server again. See Licensing & activation for what version and channel do, and what to try if activation fails.

5. First configuration pass

With the plugin running, open config.yml and decide two things before players start creating realms:

• realm.world-storage — folder (an ordinary Paper world per realm, the default) or polar (one compact file per realm, through the PolarPaper plugin). polar needs PolarPaper 2.1.0 or newer and a server on Java 25.
• realm.layout — world (each realm is its own world, the default) or grid (every realm is a square inside one shared world). grid needs world-storage: polar, plus a void world you make and load at startup — AtlasRealms only reads its name, it never creates or unloads it.

Note

On Folia, only realm.layout: grid works. Folia refuses to create or unload a world, so a realm cannot be a world of its own there.

Run /realm admin status to see the storage backend and layout actually running, and whether a realm can be created yet. See World storage & layout for the full picture, and config.yml for every key.