Map deploys

A builder finishes a map on a build server and sends it into a template with one command. The map lands in a fresh draft, so an Admin still decides when it goes live.

Let a template take maps

Open the template and choose Settings, then Map deploys:

  • Accept map deploys turns deploys on for this template.
  • From groups lists the groups whose servers may deploy here. Add your build server's group.
  • Maps go in is the folder inside the template. It starts as maps/, so a map called Castle lands in maps/Castle.
  • After a deploy is either Done message or Setup server.
  • Setup files lists the files a setup server sends back. {map} in a path becomes the map's name.

Save with the pill at the top. These settings belong to the template itself, not to a draft.

Deploy a map

On a Paper 1.21.7 or later server, type /deploy <world> <Name>. <world> is a loaded world and <Name> is what the map is called, used exactly as you type it. A name holds letters, digits, - and _. The command needs the atlas.deploy permission.

Without a template at the end, a dialog lists the templates that take maps from this server's group, eight to a page. Hover one to see its live version. Add the template's name, as in /deploy castle Castle bedwars, to skip the dialog.

The plugin turns off autosave for the world, saves it and sends it to the panel. The panel makes a draft named after the template and the map, like bedwars-castle, on the build server's node. It mirrors the world into the map's folder, so files the world no longer has are removed from the draft. Deploying a name again replaces that map.

session.lock, uid.dat, playerdata/, stats/ and advancements/ stay behind. A deploy that fails discards its draft.

With Done message, the builder reads that the map waits for review, and the deploy ends there.

Set up a map

With Setup server, Atlas starts a dev server from the new draft once the map is copied. It runs in the first group by name that uses the template and takes its name from that group's dev server pattern, like dev-bedwars-1. The builder is sent there.

The server starts with ATLAS_SETUP=true and ATLAS_MAP=<Name> in its environment, so a minigame plugin can open its arena editor. A plugin can also call atlas.setup(), which is empty on every other server.

When the setup is done, type /deploy done, or let the plugin call finish() on the setup. Atlas copies the setup files into the draft, stops the setup server and sends the builder back to the build server. Stopping the setup server saves the files too.

A setup server counts toward your plan's dev servers. While a map's setup isn't saved yet, or the same map is still copying, another deploy of that map waits with a busy message.

In the panel

The draft's sidebar shows who sent it, like "Deployed by Steve from build-1". Publish it like any other draft.

The activity feed gets one line by the player, "Steve deployed Castle to bedwars from build-1". It waits while the map copies and, with a setup server, until the setup is saved. Then it turns done or failed.

A world inside a template resets on every start. That suits minigames and lobbies, not survival worlds.