Config

The configuration file is generated at config/apibalego.jsonc on first launch, and can also be edited through the in-game mod menu.

Configuration changes require a world reload to take effect unless noted otherwise. Changes made via the /gmaster command take effect immediately.

Caution

Only connect to trusted sources. A connected server can execute commands, load datapacks, and control mod behavior in your game

HTTP Polling (Server)

Option	Default	Description
`webDataSync`	`false`	Enables gamemaster mode. The server polls the gamemaster URL periodically for API entries.
`dataSyncUrl`	`http://localhost:5000`	Base URL of the gamemaster server.
`dataSyncEndpoint`	`server_data`	Endpoint path. The mod sends GET requests to `<dataSyncUrl>/<dataSyncEndpoint>`.
`dataSyncApiKey`	`""`	API key sent in the request header. Leave empty if the server does not require one.
`dataSyncReloadTime`	`5` (minutes)	How often the mod polls the server, in minutes. Minimum is 10 seconds.

Option	Default	Description
`liveUpdateService`	`false`	Enables a real-time Socket.IO connection to the gamemaster server.
`liveUpdateUrl`	`http://localhost:5000`	URL of the WebSocket server (usually the same as `dataSyncUrl`).
`liveUpdatePort`	`-1`	Port override for the WebSocket connection. `-1` uses the port in the URL.

Option	Default	Description
`remoteCommandExecution`	`false`	Allows the gamemaster to execute arbitrary server commands via the `apibalego:command` API entry and the `cmd` live event.
`remoteDatapackSync`	`false`	Allows the gamemaster to download and activate datapacks via the `apibalego:datapack` API entry. Newly loaded content may not reach already-connected clients until they rejoin.
`remoteDatapackAllowExternalUrl`	`false`	If disabled, datapack download URLs must be on the same origin as `dataSyncUrl`. Enable to allow downloads from any URL.

Option	Default	Description
`clientDataSync`	`false`	Allows the client to poll the gamemaster independently, even from the main menu before joining a world.
`clientDataSyncUrl`	`http://localhost:5000`	Base URL for the client-side connection.
`clientDataSyncEndpoint`	`client_data`	Endpoint path for client data. The client sends GET requests to `<clientDataSyncUrl>/<clientDataSyncEndpoint>`.
`clientDataSyncApiKey`	`""`	API key for the client endpoint.
`clientDataSyncReloadTime`	`5` (minutes)	Poll interval for the client, in minutes. Minimum is 10 seconds.

Option	Default	Description
`clientResourcePackSync`	`false`	Allows the gamemaster to download and activate resource packs on the client via the `apibalego:resourcepack` client API entry.
`clientResourcePackAllowExternalUrl`	`false`	If disabled, resource pack download URLs must be on the same origin as `clientDataSyncUrl`.

Option	Default	Description
`generateApiDocs`	`false`	On server start, writes all currently registered server and client API entries and live events to markdown files in the `apibalego-docs/` folder. Useful when writing a gamemaster integration.