schema_version: 1
id: palworld-rest
name: Palworld REST API adapter
version: 1.0.0
description: Lightweight adapter from the private Palworld REST API to DoGaMa's normalized module API.
license: Apache-2.0
homepage: https://docs.palworldgame.com/category/rest-api/

game_ids:
  - palworld

runtime:
  type: wasm
  abi: dogama:game-module@1.0.0

compatibility:
  manager_api: ">=1.0.0 <2.0.0"
  module_api: ">=1.0.0 <2.0.0"

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

permissions:
  network:
    scope: instance_only
    protocols:
      - http
    port_ids:
      - rest_api
    http_methods:
      - GET
      - POST

limits:
  memory_mb: 32
  timeout_ms: 10000
  max_response_bytes: 1048576
  max_concurrent_calls: 2

configuration:
  - id: username
    type: string
    required: true
    description: Palworld REST Basic Authentication username.
    default: admin
  - id: admin_password
    type: secret
    required: true
    description: Palworld AdminPassword used for private REST Basic Authentication.

artifacts:
  wasm: module.wasm
  sha256: "e4b19ecfe66f4d9fb2c6451b82e6989c6eaf8887ec12cef2e97811527b1ff4ea"