Client‐API

Client API

Client API entries are polled from <clientDataSyncUrl>/<clientDataSyncEndpoint> (default endpoint: client_data) and processed client-side. Requires clientDataSync to be enabled in the config.

The data format is the same as Server API Entries.

See also: Server API Entries, Server Live Updates, Client Live Updates

---

apibalego:toast

Same schema as the server toast, but processed directly on the client without going through the server. Useful for showing toasts from the main menu before joining a world.

Note

You can also directly send toasts via Client Live Updates, this is meant when you want them in sync with something else

---

apibalego:resourcepack

Downloads a resource pack and activates it on the client. Parallel to the server-side datapack entry.

Requires clientResourcePackSync to be enabled. By default the download URL must be on the same origin as clientDataSyncUrl. Set clientResourcePackAllowExternalUrl to allow any URL.

Field	Type	Description
downloadUrl	string	URL to download the resource pack zip from.
version	string	Version string used to identify the file on disk. Change this to force a re-download. Defaults to "".

Example:

{
  "downloadUrl": "https://my-server.example/packs/custom-textures.zip",
  "version": "2"
}

---

apibalego:menu_message

Replaces the main menu splash text with messages from a pool. One message is picked at random each time the main menu loads.

Field	Type	Description
messages	Component[]	List of text components to use as the splash pool.

Example:

{
  "messages": [
    "The expedition awaits!",
    "Survive the unknown."
  ]
}