Status embed

Status embed

A single message in a Discord channel that auto-edits with the current server state. The embed shows status, server IP, player count, an online list, TPS, and memory.

Configuration

status:
  enabled: true
  update-interval: 30
  embed:
    title: "Server Status"
    color: "#5865F2"
    show-players: true
    show-tps: true
    show-memory: true
    server-ip: "play.yourserver.com"

Behaviour

The first time the embed is sent, ZDiscord creates a new message in channels.status and saves the message ID to channels.status-message in config.yml. On every subsequent interval the message is edited in place.

If the original message is deleted, ZDiscord will detect the edit failure (404) and post a new one. The old channels.status-message is replaced.

When the plugin shuts down, the embed is edited one final time to show the server as offline.

Intervals

update-interval is in seconds. The minimum useful value is 5; very low intervals can hit Discord's rate limit on message edits.

Using /setup

/setup can post a status panel for you and configure the channel in one step.

---

ZDiscord v1.1.0 · Home · Issues · Source