vcmi/config/schemas/lobbyProtocol/serverLogin.json

{
	"type" : "object",
	"$schema" : "http://json-schema.org/draft-06/schema",
	"title" : "Lobby protocol: serverLogin",
	"description" : "Sent by match server when starting up in lobby mode",

	"required" : [ "type", "gameRoomID", "accountID", "accountCookie", "version" ],
	"additionalProperties" : false,

	"properties" : {
		"type" :
		{
			"type" : "string",
			"const" : "serverLogin"
		},
		"gameRoomID" :
		{
			"type" : "string",
			"description" : "UUID generated by server to represent this game room"
		},
		"accountID" :
		{
			"type" : "string",
			"description" : "Account ID of game host"
		},
		"accountCookie" :
		{
			"type" : "string",
			"description" : "Security cookie of host account"
		},
		"version" :
		{
			"type" : "string",
			"description" : "Version of match server, e.g. 1.5.0"
		},
		"mods" : 
		{
			"type" : "array",
			"description" : "List of gameplay-affecting mods active on server",
			"items" : {
				"type" : "object",
				"additionalProperties" : false,
				"required" : [ "modId", "name", "version" ],
				"properties" : {
					"modId" :
					{
						"type" : "string",
						"description" : "Unique identifier of the mod"
					},
					"name" :
					{
						"type" : "string",
						"description" : "Human-readable name of the mod"
					},
					"parent" :
					{
						"type" : "string",
						"description" : "Unique ID of parent mod, only for submods"
					},
					"version" :
					{
						"type" : "string",
						"description" : "Version of mod, as specified in mod config"
					}
				}
			}
		}
	}
}