schema_version: 1
id: palworld-official
version: 1.0.0

source:
  type: official
  url: https://github.com/pocketpairjp/palworld-dedicated-server-docker

game:
  id: palworld
  name: Palworld
  description: Official Palworld dedicated server reference for DoGaMa.
  website: https://www.palworldgame.com/
  artwork:
    attribution: Palworld and related artwork are property of Pocketpair, Inc.; no affiliation is implied.

requirements:
  minimum:
    cpu_cores: 4
    memory_mb: 8192
    storage_gb: 30
  recommended:
    cpu_cores: 4
    memory_mb: 32768
    storage_gb: 50

container:
  image: ghcr.io/pocketpairjp/palserver
  tag: v1.0.2.101103
  entrypoint:
    - /pal/helper.sh
  arguments:
    - -port=8211
    - -useperfthreads
    - -NoAsyncLoadingThread
    - -UseMultithreadForDS
  assets:
    - source: assets/helper.sh
      destination: /pal/helper.sh
      sha256: 52e58fe4e22654d0d312fe2bb6195db61dad5ffce78e0440a951d33d20f2c36f
      read_only: true
  stop_timeout_seconds: 120
  ports:
    - id: game
      container_port: 8211
      protocol: udp
      purpose: game
      publish: true
      required: true
    - id: rest_api
      container_port: 8212
      protocol: tcp
      purpose: integration
      publish: false
      required: true

storage:
  mounts:
    - id: saved
      container_path: /pal/Package/Pal/Saved
      category: player_data
      backup: true
      user_configurable: true
      read_only: false

configuration:
  fields:
    - id: server_name
      label: Server name
      type: string
      target:
        kind: ini
        name: ServerName
      apply: restart_required
      visibility: members
      required: true
      default: DoGaMa Palworld Server
    - id: server_description
      label: Server description
      type: string
      target:
        kind: ini
        name: ServerDescription
      apply: restart_required
      visibility: members
      required: false
      default: Managed by DoGaMa
    - id: max_players
      label: Maximum players
      type: integer
      target:
        kind: ini
        name: ServerPlayerMaxNum
      apply: restart_required
      visibility: members
      required: true
      default: 16
      minimum: 1
      maximum: 32
    - id: server_password
      label: Player password
      type: secret
      target:
        kind: ini
        name: ServerPassword
      apply: restart_required
      visibility: secret
      required: false
    - id: admin_password
      label: Administrator and REST API password
      type: secret
      target:
        kind: ini
        name: AdminPassword
      apply: restart_required
      visibility: secret
      required: true
    - id: rest_api_enabled
      label: Enable private REST API
      type: boolean
      target:
        kind: ini
        name: RESTAPIEnabled
      apply: restart_required
      visibility: admin
      required: true
      default: true
    - id: rest_api_port
      label: Private REST API port
      type: integer
      target:
        kind: ini
        name: RESTAPIPort
      apply: restart_required
      visibility: admin
      required: true
      default: 8212
      minimum: 1
      maximum: 65535

capabilities:
  - server_info
  - metrics
  - player_list
  - online_save
  - graceful_shutdown
  - announcement
  - kick
  - ban
  - unban

integration:
  module_id: palworld-rest
  version_range: ">=1.0.0 <2.0.0"
  port_id: rest_api
  required: false

backup:
  strategy: online_save
  source_mounts:
    - saved
  restart_after_backup: true

healthcheck:
  type: module
  port_id: rest_api
  startup_timeout_seconds: 300
  interval_seconds: 10

mods:
  supported: false

imports:
  supported: true
  accepted_formats:
    - zip
    - tar
    - tar.gz
    - tar.zst
    - directory
  max_extracted_size_gb: 50
  required_paths:
    - Level.sav
    - Players
  destination_mount: saved
  destination_relative_path: SaveGames/0
  requires_stopped_server: true

updates:
  backup_before_update: true
  automatic_default: false
  rollback_on_failure: true
  health_timeout_seconds: 300

compatibility:
  minimum_manager_version: 1.0.0
  requires_instance_migration: false