Sign In
View Source Code

Lobbies

OverviewConfigScripts
13
Errors
14
Dependencies
2

Config

  • lobbies
    object
    • lobbies.regions
      array of strings
    • lobbies.destroyOnEmptyAfter
      optional number
    • lobbies.unreadyExpireAfter
      number
    • lobbies.maxPlayers
      number
    • lobbies.maxPlayersDirect
      number
    • lobbies.enableDynamicMaxPlayers
      optional object
      • lobbies.enableDynamicMaxPlayers.min
        number
      • lobbies.enableDynamicMaxPlayers.max
        number
    • lobbies.enableDynamicMaxPlayersDirect
      optional object
      • lobbies.enableDynamicMaxPlayersDirect.min
        number
      • lobbies.enableDynamicMaxPlayersDirect.max
        number
    • lobbies.enableCreate
      boolean
    • lobbies.enableDestroy
      boolean
    • lobbies.enableFind
      boolean
    • lobbies.enableFindOrCreate
      boolean
    • lobbies.enableJoin
      boolean
    • lobbies.enableList
      boolean
    • lobbies.backend
      union of objects
        • lobbies.backend.test
          empty object
        • lobbies.backend.localDevelopment
          object
          • lobbies.backend.localDevelopment.version
            optional string
          • lobbies.backend.localDevelopment.tags
            optional combination of empty object and record of strings
          • lobbies.backend.localDevelopment.maxPlayers
            optional number
          • lobbies.backend.localDevelopment.maxPlayersDirect
            optional number
          • lobbies.backend.localDevelopment.ports
            combination of empty object and record of objects
        • lobbies.backend.server
          object
          • lobbies.backend.server.resources
            object
            • lobbies.backend.server.resources.cpu
              number
            • lobbies.backend.server.resources.memory
              number
          • lobbies.backend.server.arguments
            optional array of strings
          • lobbies.backend.server.environment
            optional combination of empty object and record of strings
          • lobbies.backend.server.networkMode
            optional union of literals
          • lobbies.backend.server.ports
            combination of empty object and record of objects
  • lobbyRules
    array of objects
    • lobbyRules.tags
      combination of empty object and record of strings
    • lobbyRules.config
      combination of object and record of objects
      • lobbyRules.config.regions
        nullable array of strings
      • lobbyRules.config.destroyOnEmptyAfter
        nullable number
      • lobbyRules.config.unreadyExpireAfter
        nullable number
      • lobbyRules.config.maxPlayers
        nullable number
      • lobbyRules.config.maxPlayersDirect
        nullable number
      • lobbyRules.config.enableDynamicMaxPlayers
        nullable object
        • lobbyRules.config.enableDynamicMaxPlayers.min
          number
        • lobbyRules.config.enableDynamicMaxPlayers.max
          number
      • lobbyRules.config.enableDynamicMaxPlayersDirect
        nullable object
        • lobbyRules.config.enableDynamicMaxPlayersDirect.min
          number
        • lobbyRules.config.enableDynamicMaxPlayersDirect.max
          number
      • lobbyRules.config.enableCreate
        nullable boolean
      • lobbyRules.config.enableDestroy
        nullable boolean
      • lobbyRules.config.enableFind
        nullable boolean
      • lobbyRules.config.enableFindOrCreate
        nullable boolean
      • lobbyRules.config.enableJoin
        nullable boolean
      • lobbyRules.config.enableList
        nullable boolean
      • lobbyRules.config.backend
        nullable union of objects
          • lobbyRules.config.backend.test
            empty object
          • lobbyRules.config.backend.localDevelopment
            object
            • lobbyRules.config.backend.localDevelopment.version
              optional string
            • lobbyRules.config.backend.localDevelopment.tags
              optional combination of empty object and record of strings
            • lobbyRules.config.backend.localDevelopment.maxPlayers
              optional number
            • lobbyRules.config.backend.localDevelopment.maxPlayersDirect
              optional number
            • lobbyRules.config.backend.localDevelopment.ports
              combination of empty object and record of objects
          • lobbyRules.config.backend.server
            object
            • lobbyRules.config.backend.server.resources
              object
              • lobbyRules.config.backend.server.resources.cpu
                number
              • lobbyRules.config.backend.server.resources.memory
                number
            • lobbyRules.config.backend.server.arguments
              optional array of strings
            • lobbyRules.config.backend.server.environment
              optional combination of empty object and record of strings
            • lobbyRules.config.backend.server.networkMode
              optional union of literals
            • lobbyRules.config.backend.server.ports
              combination of empty object and record of objects
  • players
    object
    • players.maxPerIp
      optional number
    • players.maxUnconnected
      optional number
    • players.unconnectedExpireAfter
      number
    • players.autoDestroyAfter
      optional number

Default Config

{
  "lobbies": {
    "regions": [
      "atl",
      "fra"
    ],
    "destroyOnEmptyAfter": 60000,
    "unreadyExpireAfter": 300000,
    "maxPlayers": 16,
    "maxPlayersDirect": 16,
    "enableCreate": false,
    "enableDestroy": false,
    "enableFind": true,
    "enableFindOrCreate": true,
    "enableJoin": true,
    "enableList": true
  },
  "lobbyRules": [],
  "players": {
    "maxPerIp": 8,
    "maxUnconnected": 128,
    "unconnectedExpireAfter": 60000,
    "autoDestroyAfter": 4147200000
  }
}
JSON