1
0
mirror of https://github.com/vcmi/vcmi.git synced 2024-12-16 10:19:47 +02:00
vcmi/config/schemas/lobbyProtocol/activeGameRooms.json
2024-03-08 16:32:40 +02:00

60 lines
1.5 KiB
JSON

{
"type" : "object",
"$schema" : "http://json-schema.org/draft-06/schema",
"title" : "Lobby protocol: activeGameRooms",
"description" : "Sent by server to initialized or update list of game rooms",
"required" : [ "type", "gameRooms" ],
"additionalProperties" : false,
"properties" : {
"type" :
{
"type" : "string",
"const" : "activeGameRooms"
},
"gameRooms" :
{
"type" : "array",
"description" : "List of currently available game rooms",
"items" :
{
"type" : "object",
"additionalProperties" : false,
"required" : [ "gameRoomID", "hostAccountID", "hostAccountDisplayName", "description", "playersCount", "playersLimit" ],
"properties" : {
"gameRoomID" :
{
"type" : "string",
"description" : "Unique ID of game room"
},
"hostAccountID" :
{
"type" : "string",
"description" : "ID of account that created and hosts this game room"
},
"hostAccountDisplayName" :
{
"type" : "string",
"description" : "Display name of account that created and hosts this game room"
},
"description" :
{
"type" : "string",
"description" : "Auto-generated description of this room"
},
"playersCount" :
{
"type" : "number",
"description" : "Current number of players in this room, including host"
},
"playersLimit" :
{
"type" : "number",
"description" : "Maximum number of players that can join this room, including host"
}
}
}
}
}
}