Web Dashboard

Features

Web Dashboard

Config Editor

XAnnounce registers a module with XCore's web panel. Its Config page is a full editor for the entire config.yml: it loads the raw file, and saving validates the YAML, writes it to disk and reloads the addon.

Invalid YAML is rejected before anything is written, so a syntax error in the editor can never break your live config.

API Endpoints

EndpointDescription
GET /api/xannounce/config/rawRaw config.yml text
POST /api/xannounce/config/rawValidate, write & reload the config
GET /api/xannounce/messagesList all configured messages
GET /api/xannounce/statusCounts, scheduler state, PAPI availability, display stats
GET /api/xannounce/player/<name>A player's toggle states
POST /api/xannounce/reloadReload the addon
POST /api/xannounce/toggleEnable/disable a configured message
POST /api/xannounce/player/toggleToggle a player's preference

All endpoints use the same Bearer token as XCore's web panel.

Still need help?

Ask our team on Discord or browse the source.