DoGaMa-serv/catalog/vrising/template.yaml

schema_version: 1
id: vrising-didstopia
version: 1.0.0

source:
  type: verified_community
  url: https://github.com/Didstopia/vrising-server

game:
  id: vrising
  name: V Rising
  description: DoGaMa template for a V Rising dedicated server using the Didstopia Docker image.
  website: https://playvrising.com/
  artwork:
    logo: assets/icon.png
    image: assets/banner.jpg
    poster: assets/poster.jpg
    attribution: V Rising and related artwork are property of Stunlock Studios; no affiliation is implied.

requirements:
  minimum:
    cpu_cores: 2
    memory_mb: 4096
    storage_gb: 15
  recommended:
    cpu_cores: 4
    memory_mb: 8192
    storage_gb: 25

container:
  image: didstopia/vrising-server
  tag: latest
  user_mode: image
  stop_timeout_seconds: 120
  capabilities:
    add:
      - CHOWN
      - FOWNER
      - DAC_OVERRIDE
      - SETUID
      - SETGID
  environment:
    V_RISING_SERVER_BIND_IP: ""
    V_RISING_SERVER_BIND_IP_AUTO_DETECT: "false"
    V_RISING_SERVER_PASSWORD: ""
    V_RISING_SERVER_GAME_SETTINGS_PRESET: Custom

  ports:
    - id: game
      container_port: 9876
      protocol: udp
      purpose: game
      publish: true
      required: true

    - id: query
      container_port: 9877
      protocol: udp
      purpose: query
      publish: true
      required: true

    - id: rcon
      container_port: 9878
      protocol: tcp
      purpose: integration
      publish: false
      required: true

capabilities: []

storage:
  mounts:
    - id: persistent
      container_path: /app/vrising
      category: player_data
      backup: true
      user_configurable: true
      read_only: false

    - id: server
      container_path: /steamcmd/vrising
      category: runtime
      backup: false
      user_configurable: false
      read_only: false

configuration:
  fields:
    - id: persistent_data_path
      label: Persistent data path
      type: string
      target:
        kind: environment
        name: V_RISING_SERVER_PERSISTENT_DATA_PATH
      apply: restart_required
      visibility: admin
      required: true
      default: /app/vrising

    - id: branch
      label: Steam branch
      type: string
      target:
        kind: environment
        name: V_RISING_SERVER_BRANCH
      apply: restart_required
      visibility: admin
      required: true
      default: public

    - id: start_mode
      label: Server start mode
      type: integer
      target:
        kind: environment
        name: V_RISING_SERVER_START_MODE
      apply: restart_required
      visibility: admin
      required: true
      default: 0
      minimum: 0
      maximum: 2

    - id: update_mode
      label: Automatic server updates
      type: boolean
      target:
        kind: environment
        name: V_RISING_SERVER_UPDATE_MODE
      apply: restart_required
      visibility: admin
      required: true
      default: false

    - id: default_host_settings
      label: Manage host settings from DoGaMa
      type: boolean
      target:
        kind: environment
        name: V_RISING_SERVER_DEFAULT_HOST_SETTINGS
      apply: restart_required
      visibility: admin
      required: true
      default: true

    - id: default_game_settings
      label: Manage game settings from DoGaMa
      type: boolean
      target:
        kind: environment
        name: V_RISING_SERVER_DEFAULT_GAME_SETTINGS
      apply: restart_required
      visibility: admin
      required: true
      default: true

    - id: server_name
      label: Server name
      type: string
      target:
        kind: environment
        name: V_RISING_SERVER_NAME
      apply: restart_required
      visibility: members
      required: true
      default: DoGaMa V Rising Server

    - id: server_description
      label: Server description
      type: string
      target:
        kind: environment
        name: V_RISING_SERVER_DESCRIPTION
      apply: restart_required
      visibility: members
      required: false
      default: Managed by DoGaMa

    - id: server_password
      label: Player password
      type: secret
      target:
        kind: environment
        name: V_RISING_SERVER_PASSWORD
      apply: restart_required
      visibility: secret
      required: false

    - id: game_port
      label: Game port
      type: integer
      target:
        kind: environment
        name: V_RISING_SERVER_GAME_PORT
      apply: restart_required
      visibility: admin
      required: true
      default: 9876
      minimum: 1
      maximum: 65535

    - id: query_port
      label: Query port
      type: integer
      target:
        kind: environment
        name: V_RISING_SERVER_QUERY_PORT
      apply: restart_required
      visibility: admin
      required: true
      default: 9877
      minimum: 1
      maximum: 65535

    - id: rcon_enabled
      label: Enable RCON
      type: boolean
      target:
        kind: environment
        name: V_RISING_SERVER_RCON_ENABLED
      apply: restart_required
      visibility: admin
      required: true
      default: true

    - id: rcon_port
      label: RCON port
      type: integer
      target:
        kind: environment
        name: V_RISING_SERVER_RCON_PORT
      apply: restart_required
      visibility: admin
      required: true
      default: 9878
      minimum: 1
      maximum: 65535

    - id: rcon_password
      label: RCON password
      type: secret
      target:
        kind: environment
        name: V_RISING_SERVER_RCON_PASSWORD
      apply: restart_required
      visibility: secret
      required: true

    - id: max_players
      label: Maximum players
      type: integer
      target:
        kind: environment
        name: V_RISING_SERVER_MAX_CONNECTED_USERS
      apply: restart_required
      visibility: members
      required: true
      default: 40
      minimum: 1
      maximum: 60

    - id: max_admins
      label: Maximum administrators
      type: integer
      target:
        kind: environment
        name: V_RISING_SERVER_MAX_CONNECTED_ADMINS
      apply: restart_required
      visibility: admin
      required: true
      default: 4
      minimum: 1
      maximum: 20

    - id: save_name
      label: Save name
      type: string
      target:
        kind: environment
        name: V_RISING_SERVER_SAVE_NAME
      apply: restart_required
      visibility: admin
      required: true
      default: dogama

    - id: list_on_steam
      label: List server on Steam
      type: boolean
      target:
        kind: environment
        name: V_RISING_SERVER_LIST_ON_STEAM
      apply: restart_required
      visibility: members
      required: true
      default: true

    - id: list_on_epic_eos
      label: List server on Epic Online Services
      type: boolean
      target:
        kind: environment
        name: V_RISING_SERVER_LIST_ON_EPIC_EOS
      apply: restart_required
      visibility: members
      required: true
      default: false

    - id: auto_save_count
      label: Autosave count
      type: integer
      target:
        kind: environment
        name: V_RISING_SERVER_AUTO_SAVE_COUNT
      apply: restart_required
      visibility: admin
      required: true
      default: 50
      minimum: 1
      maximum: 100

    - id: auto_save_interval
      label: Autosave interval
      type: integer
      target:
        kind: environment
        name: V_RISING_SERVER_AUTO_SAVE_INTERVAL
      apply: restart_required
      visibility: admin
      required: true
      default: 300
      minimum: 60
      maximum: 3600

    - id: game_settings_preset
      label: Game settings preset
      type: string
      target:
        kind: environment
        name: V_RISING_SERVER_GAME_SETTINGS_PRESET
      apply: restart_required
      visibility: members
      required: false
      default: ""

    - id: clan_size
      label: Clan size
      type: integer
      target:
        kind: environment
        name: V_RISING_SERVER_CLAN_SIZE
      apply: restart_required
      visibility: members
      required: true
      default: 4
      minimum: 1
      maximum: 10

    - id: pvp
      label: Enable PvP
      type: boolean
      target:
        kind: environment
        name: V_RISING_SERVER_GAME_ENABLE_PVP
      apply: restart_required
      visibility: members
      required: true
      default: false

    - id: disable_blood_drain
      label: Disable castle blood drain
      type: boolean
      target:
        kind: environment
        name: V_RISING_SERVER_GAME_DISABLE_BLOOD_DRAIN
      apply: restart_required
      visibility: members
      required: true
      default: false

    - id: disable_decay
      label: Disable castle decay
      type: boolean
      target:
        kind: environment
        name: V_RISING_SERVER_GAME_DISABLE_DECAY
      apply: restart_required
      visibility: members
      required: true
      default: false

    - id: job_worker_count
      label: Unity job worker count
      type: integer
      target:
        kind: environment
        name: V_RISING_SERVER_JOB_WORKER_COUNT
      apply: restart_required
      visibility: admin
      required: true
      default: 8
      minimum: 1
      maximum: 32

module:
  path: module/manifest.yaml

integration:
  module_id: vrising-rcon
  version_range: ">=1.0.0 <2.0.0"
  port_id: rcon
  required: false

backup:
  strategy: stop_then_archive
  source_mounts:
    - persistent
  restart_after_backup: true

healthcheck:
  type: tcp
  port_id: rcon
  startup_timeout_seconds: 600
  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: []
  destination_mount: persistent
  destination_relative_path: Saves
  requires_stopped_server: true

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

compatibility:
  minimum_manager_version: 1.0.0
  requires_instance_migration: false