Tools / Docs / serverpack.json

serverpack.json

A portable game-server recipe format. Every tool on this site that produces a server config can emit one. Any panel or script can consume one.

Top-level fields

  • schema_version — current version is "0.2".
  • game — game slug, e.g. "project-zomboid", "7-days-to-die", "palworld".
  • game_version — optional game version string (e.g. "42" for PZ Build 42).
  • source — where this pack came from. Object with kind (e.g. steam_workshop_collection, recipe, manual), optional id and url. May be null.
  • compat — object with min_game_version / max_game_version.
  • provenance — required. Object with tool (which tool produced this), generated_by, generated_at (ISO-8601).
  • install — install hints. Currently requires_restart (bool).
  • mods — array of mod entries (see below).
  • configs — map of config filename to key/value pairs.

Mod entry

  • source — one of steam_workshop, thunderstore, factorio_mod_portal, modrinth, curseforge, url.
  • id — source-specific ID (numeric for Steam Workshop, string slug elsewhere).
  • source_url — canonical link back to the mod's page on its source platform.
  • mod_id — optional game-side mod identifier (e.g. the PZ Mod ID: value).
  • notes — optional free-form per-mod note.
  • version_policy"latest-compatible" (default) or "pinned".
  • version — required when version_policy=pinned.

JSON Schema

Machine-validatable schema: /static/serverpack.schema.json (Draft 2020-12).

Example

{
  "schema_version": "0.2",
  "game": "project-zomboid",
  "game_version": "42",
  "source": {
    "kind": "steam_workshop_collection",
    "id": "3725160942",
    "url": "https://steamcommunity.com/sharedfiles/filedetails/?id=3725160942"
  },
  "compat": {
    "min_game_version": "42",
    "max_game_version": null
  },
  "provenance": {
    "tool": "project-zomboid-workshop-to-server-config",
    "generated_by": "tools.supercraft.host",
    "generated_at": "2026-05-26T12:00:00+00:00"
  },
  "install": {
    "requires_restart": true
  },
  "mods": [
    {
      "source": "steam_workshop",
      "id": "123456789",
      "source_url": "https://steamcommunity.com/sharedfiles/filedetails/?id=123456789",
      "version_policy": "latest-compatible"
    }
  ],
  "configs": {
    "servertest.ini": {
      "WorkshopItems": "123456789",
      "Mods": "ExampleMod",
      "Map": "Muldraugh, KY"
    }
  }
}

What this is NOT

serverpack.json describes desired server state: which mods, what config, what compatibility. It is not a diagnosis or a report. Findings, warnings, and observations belong in tool result panels (and shareable /r/<id> reports later), not in this artifact.

Stability

Schema 0.2 is the current published version. Breaking changes will bump the major version. Tools on this site emit schema_version on every artifact so consumers can branch on it.