Skip to main content

Lobby Config

1. Overview​

The file lobby_config.yaml in export package contains all the configuration of Lobby Config 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: Thu, 17 Mar 2022 07:26:50 GMT
#
# This file was automatically generated by PGOS Portal.
# Copyright 2022 Proxima Beta, Inc. All Rights Reserved.
#
# Constant Definitions:
# status: 0-Enable, -1-Disable.
# provider: local or empty string.

lobby_config:
  snapshot_tag: "20220317152639198"
  title_id: "5"
  title_region_id: d_5_812179_dev
  list:
    - identification:
        name: lobbyconfig
      preparing_timeout: 30
      placer: placer1
      teams:
        - name: Red
          capacity: 1
      status: 0
      start_battle_condition: 0
      provider: local
      team_selection_strategy:0
      lobby_modes:
        gamemode: ""
        placer_name: ""
        placer_provider: ""
      lobby_team_groups:
        - group_name: ""
          teams:
            - name: Red
              capacity: 1
          start_battle_condition: 0

3. Field Description​

  • identification: The unique identifier for the current resource. It contains multiple fields:
    • name: The name of lobby config. Type: string. Length: 1-128.
  • preparing_timeout: Timeout of lobby config. Type: number. Length: 1-3600.
  • placer: The placer of lobby config. Type: string.
  • teams: The teams of lobby config. Type: array.
    • name: The name of team. Type: string. Limit: 0-128;
    • capacity: The capacity of team. Type: number. Limit: 0-9999;
  • status: The status of lobby config. Type: number, 0-Enable, -1-Disable.
  • provider: The provider of lobby config. Type: string, local or empty string.
  • start_battle_condition: The start battle condition type. Type: number, 0- All Ready Otherwise Waiting, 1- All Ready Otherwise Error ,2- Ignoring Ready Flag
  • team_selection_strategy: The type of Team Selection Strategy.Type: number, 0-Balance Player Count, 1- Concentrate Players
  • lobby_modes:
    • gamemode: The name of the game mode. Type: string
    • placer_name:The name of the placer. Type: string
    • placer_provider:The provider of the placer. Type: string, pgos or pgos_local_placer
  • lobby_team_groups:
    • group_name: The name of group. Type: string
    • teams: The name array of temas. Type: array\<string>
    • start_battle_condition:The start battle condition type. Type: number, 0- All Ready Otherwise Waiting, 1- All Ready Otherwise Error ,2- Ignoring Ready Flag