RoomConfigObject

Room configuration object.

Description

Room configuration object.

Properties
Name Type Attributes Description
roomName string

The name for the room.

playerName string

The name for the host player.

password string <optional>

The password for the room (no password if ommited).

maxPlayers number

Max number of players the room accepts.

public boolean

If true the room will appear in the room list.

geo Object

GeoLocation override for the room. See https://developers.google.com/public-data/docs/canonical/countries_csv

Name Type Description
code string

Two character country code.

lat number

GPS Latitude value.

lon number

GPS longitude value.

token string

Can be used to skip the recaptcha by setting it to a token that can be obtained here. These tokens will expire after a few minutes.