Customise the server list entry

The edge answers the server list for your join address itself, so you can change what players see there without touching your server. The Server list tab of a join address, or of an external server, sets the message of the day (MOTD) while your server is up and while it is down, the icon, the version text and how long the edge reuses your server's answer. Changes also apply at a custom domain linked to the join address.

• The join address is on your Game Shield list and is not suspended. While it is suspended, the tab shows This join address is suspended and you cannot save.
• For an external server, the join address must exist. Until Coritan sets it up, the tab shows Not set up yet (How external servers work).
• For an icon, have a PNG file of 64 × 64 pixels, under about 22 KB.

1. In the dashboard, go to Game Shield and select the join address or external server.
2. Select the Server list tab.
3. Change any of these fields:
   • Server name: the name the dashboard shows, up to 100 characters. It cannot be empty.
   • Version string: the version text the entry carries while your server does not answer, up to 64 characters, such as Paper 1.21.
   • While the server is online: the MOTD players see while your server answers, in place of the server's own. Leave it empty to show the server's own MOTD.
   • While the server is offline: the MOTD players see while your server does not answer. Leave it empty to show the platform's (What players see). For a free server that sleeps, an empty field shows the server's last MOTD instead: its first line, cut to 100 characters. The text is the first line of the entry, and a second line says that the server is asleep, starting or queued (How free servers work). Your organization can set an offline text too, which this field overrides.
   • Server icon: select Upload PNG… and choose the file. Clear icon removes it.
   • Status cache: how long the edge reuses your server's answer before it asks again, from 1 second to 10 seconds. Platform default uses the platform's setting.
4. Check the Preview card. Choose Online or Offline to see the entry in each state. The preview's player count, 12/100, is only an example.
5. Select Save changes.

Each MOTD holds up to 256 characters on two lines. The game shows the first two lines only.

The MOTD takes Minecraft's formatting codes: a section sign § followed by one character. Select a button under the MOTD to insert a code where the cursor is. A coloured swatch from 0 to f inserts a colour, Bold, Italic, Underline, Strike and Obfuscated insert a style, and Reset inserts §r, which ends every code before it.

For example, §6Survival SMP §7| §aSeason 3 shows Survival SMP in gold, the bar in gray and Season 3 in green.

Your server's answer and your fields combine like this in a Minecraft Java server list:

Java players see the name they gave the server when they added it to their list, so Server name does not appear there.

Minecraft versions before 1.7 ask for the entry in an older format. The edge answers with the MOTD on one line and the player counts. Minecraft 1.4 to 1.6 also get the version. Versions before 1.4 have no field for it, so they get none.

Minecraft Bedrock's server list shows the two MOTDs in the same way, as its first line. Under it, Bedrock shows a world name. While your server answers, that is the world name your server reports. While it does not answer, the edge shows the Server name. For a free server that sleeps, the edge shows the state line there, the text that says the server is asleep, starting or queued. The Server icon and the Version string do not apply to Bedrock.

The dashboard shows Branding saved., and the caption under the form reads No unsaved changes. Players see the new entry the next time their server list refreshes. The Server list card on the Overview tab shows the new values.

Enter a server name.

You emptied Server name. Enter a name.

The icon must be 64 x 64 pixels (this one is 128 x 128).

Resize the image to 64 × 64 pixels and upload it again.

The icon is too large. Use a 64 by 64 PNG under about 22 KB.

Save the PNG with fewer colours or more compression, then upload it again.

The icon must be a PNG. or That file is not a PNG image.

The file is another format, or a file with a .png name that is not a PNG. Export the image as a PNG.

The MOTD shows & and a letter

The game does not read & codes. Replace each & with §.

The version string does not show while the server is up

The list shows your server's own version while it answers, and the Version string only while it does not.

The Status cache does not go back to Platform default

The dashboard does not save a change back to Platform default. Send "status_cache_ttl_seconds": null with the API (With the API).

The server list shows the offline MOTD while players can still join

The server did not answer the edge within 1.5 seconds, which happens while it starts or when it is overloaded. When PROXY protocol is on, the edge starts the request for the entry with a PROXY protocol version 2 header with no player address, so a server that requires the header answers it. A server that does not read the header fails the request and the join. On an external server, turn PROXY protocol off on the Connection tab and on your server, or make the server read the header (Connect a server you host elsewhere).

• How join addresses work
• Use your own domain for a join address
• Customise the game proxy messages

Change the server list entry with PATCH /api/v1/gameproxy/routes/{route_id}. route_id is the join address's id from GET /api/v1/gameproxy/routes, or an external server's route_id (How external servers work).

curl -X PATCH https://api.coritan.com/api/v1/gameproxy/routes/42 \
  -H "Authorization: Bearer $CORITAN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "online_motd": "§6Survival SMP\n§7Season 3 is live",
    "offline_motd": "§cBack soon",
    "version_name": "Paper 1.21",
    "status_cache_ttl_seconds": 5
  }'

{"ok": true, "route_id": 42}

Send only the fields you change. A field you send as null goes back to its default, and so does one you empty with a clear_* field.

The API checks that favicon is a 64 × 64 PNG data URI and not too long. A join address that is not on your account answers 404 with Route not found. A favicon that is too long answers 400 with Favicon too large. Favicon must be a 64 by 64 PNG under about 22 KB., one that is not a PNG of that size answers 400 with Favicon must be a 64 by 64 PNG under about 22 KB., and one in another format answers 400 with Favicon must be a data:image/png;base64,... URI. A value outside its range, such as a status_cache_ttl_seconds of 30, answers 422.