Skip to main content

DS Hosting Placer

1. Overview

The file dshosting_placer.yaml in exported package contains all configuration of Placer from exported title region. You can add, delete or update some items in the file and then re-import to the title region.

2. An Example of The File Content

# AUTO-GENERATED FILE.
#
# Export information
# @export_time: Tue, 21 Feb 2023 07:08:16 GMT
#
# This file was automatically generated by PGOS Portal.
# Copyright 2023 Proxima Beta, Inc. All Rights Reserved.

dshosting_placer:
snapshot_tag: "20230220155842028"
title_id: 4gnsz
title_region_id: apgz_4gnsz_186575
list:
- identification:
name: will-test-placer-1
fleet_name: will-test-fleet-1121
battlesession_active_timeout: 200
player_max_latency_ms: 400
placement_strategy:
placement_rules:
- max_latency_ms: 999
waiting_period_sec: 10
latency_algorithm: 1
min_player_num: 0
trim_percent: 0
trim_enforce_one: false
round_type: 0

3. Field Description

  • identification: The unique identifier for the current resource, it contains multiple fields:

    • name: The name of placer. Type: string.
  • fleet_name: The name of fleet. Type: string.

  • battlesession_active_timeout: The timeout of battlesession active. Type: int. Range: 10-600.

  • player_max_latency_ms: The max latency of player, If any player has a latency > the value, no DS will be assigned for the placement. (0 means ignore this limit). Type: int.

  • placement_strategy:

    • placement_rules: The algorithm step list

      • latency_algorithm: The algorithm of the step. Type: int. optional data: 1-Avg Latency, 2-Max Latency, 3-Leader Latency, 4-Avg Latency after Trimmed.

      • max_latency_ms: The max latency millisecond. Type: int. Range: 0-9999.

      • waiting_period_sec: The wait seconds of the step, Type: int. Range: 0-600.

      • min_player_num: The minimum player count for the step, only for Avg Latency after Trimmed LatencyAlgorithm, Type: int.

      • trim_percent: The trim player percent for the step, only for Avg Latency after Trimmed LatencyAlgorithm, Type: int.

      • trim_enforce_one: Whether trim player for the step, only for Avg Latency after Trimmed LatencyAlgorithm, Type: boolean.

      • round_type: The rounding type for the step, only for Avg Latency after Trimmed LatencyAlgorithm, Type: string. optional data: 0-Round Off,1-Round Up,2-Round Down.