DoGaMa-serv/catalog/palworld/README.md

Palworld reference template

This template demonstrates every important V1 contract: official image, public UDP game port, private REST integration port, persistent save data, write-only credentials, online-save backup, import and an independently versioned WebAssembly adapter.

Verified upstream facts

• Pocketpair publishes the official image and example Compose deployment at pocketpairjp/palworld-dedicated-server-docker.
• Pocketpair publishes versioned image tags and a latest tag for the current official ghcr.io/pocketpairjp/palserver release. The official template uses latest for normal pulls and new deployments, with UDP 8211, /pal/Package/Pal/Saved and the packaged helper.sh pattern.
• The official requirements specify four or more CPU cores, 16 GB memory with over 32 GB recommended for stability, and UDP 8211. The template's 8 GB minimum is an explicit lower bootable boundary mentioned upstream, not a stability recommendation; the UI must warn below 16 GB.
• The configuration reference documents AdminPassword, RESTAPIEnabled, RESTAPIPort, server name/password and maximum players.
• The REST API documentation documents information, players, metrics, announce, save, shutdown and moderation operations. REST API credentials and port must remain private.

The upstream API may change. A template snapshot version remains independent from the game-server image tag; existing instances remain pinned to their chosen configuration and DoGaMa does not automatically replace running containers.

Reference limitations

• The template ships separate local logo and horizontal artwork assets. The source URL and attribution remain in the template so the cached raster can be audited without loading third-party content in the UI.
• The schema's storage sizes are conservative product defaults because upstream specifies SSD performance but not a fixed disk-size requirement.
• Local hosted-world migration may require player identity conversion. The generic V1 importer detects structure and warns; it does not silently convert identities.
• module/ contains the complete Palworld REST adapter: its manifest, source, fixture, license and compiled module.wasm. It is declared by template.yaml and is loaded from the template snapshot, not a global module registry. Rebuild it with the command in module/README.md.