config.schema.json

{
	"$schema": "http://json-schema.org/draft-07/schema#",
	"$id": "fivemanage-sdk-config-schema",
	"title": "Fivemanage SDK Config Schema",
	"description": "All configuration options for the fivemanage sdk.",
	"type": "object",
	"properties": {
		"$schema": {
			"description": "Schema validation link/path",
			"type": "string",
			"default": "./config.schema.json"
		},
		"logs": {
			"description": "Logs configuration",
			"type": "object",
			"properties": {
				"level": {
					"description": "Default logger level",
					"type": "string",
					"default": "info"
				},
				"levels": {
					"description": "Logger levels to register",
					"type": "array",
					"items": {
						"type": "string"
					},
					"default": ["error", "warn", "info", "debug"]
				},
				"console": {
					"description": "Toggle console logging",
					"type": "boolean",
					"default": false
				},
				"enableCloudLogging": {
					"description": "Should logs be sent to the Fivemanage backend?",
					"type": "boolean",
					"default": true
				},
				"appendPlayerIdentifiers": {
					"description": "Should player identifiers be appended to log metadata? See documentation for more info",
					"type": "boolean",
					"default": true
				},
				"excludedPlayerIdentifiers": {
					"description": "Player identifier types to exclude from appended identifier metadata",
					"type": "array",
					"items": {
						"type": "string",
						"enum": [
							"discord",
							"fivem",
							"ip",
							"license",
							"license2",
							"live",
							"steam",
							"xbl"
						]
					},
					"default": []
				},
				"playerEvents": {
					"description": "Enable player events like connecting and dropped.",
					"type": "boolean",
					"default": true
				},
				"chatEvents": {
					"description": "Enable chat events.",
					"type": "boolean",
					"default": true
				},
				"txAdminEvents": {
					"description": "Enable txAdmin events to be logged.",
					"type": "boolean",
					"default": false
				}
			},
			"required": [
				"level",
				"levels",
				"console",
				"enableCloudLogging",
				"appendPlayerIdentifiers",
				"excludedPlayerIdentifiers",
				"playerEvents",
				"chatEvents",
				"txAdminEvents"
			]
		}
	},
	"required": ["$schema", "logs"]
}