Your licence
Adding your licence to each map, map places, and what happens when a licence ends.
On this page6 sections
ClusterSync needs a licence to sync. Your licence key, the maps using it and how many may run at once are all on your licences page.
Your copy of ClusterSync
Download ClusterSync from your licences page. Everyone with a licence downloads the same copy: your licence key is what lets it sync, so keep the key private. A trial is started from the ClusterSync page, under the beta terms.
Add your licence to each map
Open Show key on your licences page and copy the key. Then add a Licensing section to the ClusterSync config.json of every map that should sync, with the same key on each:
"Licensing": {
"LicenseKey": "paste-your-licence-key-here",
"ClusterId": "",
"Reminders": true
}Restart the map. Its log says either that the licence was confirmed and syncing has started, or that it is not syncing on this map, and why.
| Setting | Default | What it does |
|---|---|---|
LicenseKey | required | Your licence key, from your licences page. |
ClusterId | the map’s -clusterid= | Groups a cluster’s maps together on your licences page — it does not affect syncing. Leave it empty to use the -clusterid= the map is already launched with, the value every map of an ARK cluster shares for transfers; a map launched without one is listed as standalone. If you set it, use 3–64 letters, digits, - or _, the same on every map of the cluster. A value that breaks this rule stops that map syncing, and its log says why. |
Reminders | true | Reminds you before your licence ends, in the server log and through your admin alerts (AdminWebhookUrl) if you have set them. false turns off only these reminders — you are always told when a subscription has ended. |
Keep your key private
How many maps can run
A licence covers a set number of maps running at once, across any number of clusters — your licences page shows how many, and which maps are using it. Each running map holds one place. A map that shuts down normally frees its place straight away. A map whose server process is ended abruptly — killed by a server manager, say — frees its place on its own after a few hours.
If all places are in use, a map that starts does not sync: its log lists the maps holding places, and one alert goes to your admin alerts if you have set them. It keeps trying, and starts syncing on its own as soon as a place is free — no restart needed. Maps that were already running are not affected. Need more maps on one licence? Ask through support.
Moving to a new host
Shut the maps on the old host down normally — that frees their places straight away — then start them on the new host with the same key. If a map was killed rather than shut down, release its place from your licences page (up to five a day), or wait a few hours for it to free itself. A map still running elsewhere takes its place back, so stop it before you release it.
Debug logging
DebugLogging (default false) writes much more detail to the server log. It only takes effect while debug logging is allowed for your licence; your licences page shows whether it is, and until when. If support asks for detailed logs, the permission is switched on for you: set DebugLogging to true and restart the map. When the permission ends, debug logging turns off, at the latest when the map next restarts.
If DebugLogging is on without the permission, it stays off and the map's log says so once.
When a licence ends
Maps that are already running keep syncing. A map that restarts more than three days after the end date stops syncing until the licence is renewed, and its log says why. Changes made on a map while it is not syncing may be undone when syncing resumes. Once the licence is active again, syncing resumes on its own within about an hour — or restart the map to resume at once — with no change to your config.