Template System

Template System

Templates live under:

templates/<templateName>/

Each template may contain a template.json.

Example

{
  "displayName": "Spigot template",
  "buildToolExec": "bash build.sh",
  "serverVersion": "1.21.1",
  "jar": "server.jar",
  "readiness": {
    "type": "LOG_CONTAINS",
    "contains": "Done ("
  },
  "jvm": {
    "args": ["-Xms1G", "-Xmx2G"]
  },
  "pool": {
    "enabled": false
  },
  "data": {
    "persistent": true
  }
}

Important fields

displayName

Human-friendly template name.

buildToolExec

Command used when the jar does not already exist.

serverVersion

Default version for the template.

jar

The server jar file name expected in the instance.

readiness

How ServerFabric decides the server is ready.

jvm.args

Default JVM flags for instances created from this template.

Version override

A template can define a default version, while creation can override it.