Notify

Supported software

Software	Plugin Support
Velocity	Yes
BungeeCord	Yes

Install the plugin

Install Notify on the proxy

Download Notify from GitHub and place it in the proxy template’s plugins/ folder. Standard SimpleCloud templates already include simplecloud-api; add it through the target’s Plugins setting or the CLI if you use a custom template.

Generate the configuration

Start a matching proxy once. Notify creates plugins/simplecloud-notify/messages.yml in the running proxy directory.

Keep the configuration in the template

For a group proxy, copy plugins/simplecloud-notify/messages.yml from the running proxy to the same path in its template before stopping it. Changes that exist only in a temporary running directory disappear when that proxy stops.See Templates for the complete workflow.

Apply your changes

Run /scnotify reload config after editing the file on a running proxy. If you edited the template copy, restart the proxy instead.

A successful reload prints Notify configuration was reloaded.

Notifications

Notify subscribes to the Cloud API event stream and can send messages for:

Server state changes to STARTING, AVAILABLE, and STOPPING
Server stopped events
Group created events
Group deleted events

Set a notification message to null to disable that specific notification. Set the whole notifications.server or notifications.group section to null to disable that category. Staff can also disable notifications for themselves with /scnotify disable and turn them back on with /scnotify enable. Notify stores this choice in the player’s SimpleCloud properties, so it follows the player across proxies. Notifications are enabled by default.

Configuration

The generated messages.yml contains message text, reusable variables, and formatting options. Notify uses MiniMessage syntax for text formatting.

version: "1"

format:
  date: "dd.MM.yyyy HH:mm:ss"

variables:
  prefix: "<color:#0EA5E9><bold>⚡</bold></color>"

notifications:
  hover:
    server: |-
      <#E2E8F0>Server information
      <br><#94A3B8>Time<#475569>: <#E2E8F0><time>
      <br><#94A3B8>State<#475569>: <#E2E8F0><state>
      <br><#94A3B8>Address<#475569>: <#E2E8F0><ip>:<port>
      <br><#94A3B8>Players<#475569>: <#E2E8F0><players>/<max>
    group: |-
      <#E2E8F0>Group information
      <br><#94A3B8>Time<#475569>: <#E2E8F0><time>

  server:
    starting: "<prefix> <#0EA5E9>Server <hover:show_text:'<notifications.hover.server>'><#F8FAFC><server></hover> is now starting."
    available: "<prefix> <#A3E635>Server <hover:show_text:'<notifications.hover.server>'><#F8FAFC><server></hover> is now available."
    stopping: "<prefix> <#F59E0B>Server <hover:show_text:'<notifications.hover.server>'><#F8FAFC><server></hover> is now stopping."
    stopped: "<prefix> <#DC2626>Server <hover:show_text:'<notifications.hover.server>'><#F8FAFC><server></hover> is now stopped."

  group:
    created: "<prefix> <#0EA5E9>Group <hover:show_text:'<notifications.hover.group>'><#F8FAFC><group></hover> was created."
    deleted: "<prefix> <#DC2626>Group <hover:show_text:'<notifications.hover.group>'><#F8FAFC><group></hover> was deleted."

Placeholders

Server notifications

Placeholder	Description
`<server>`	Group or server base name
`<group>`	Group name
`<id>`	Numerical ID prefixed with a space when present
`<uuid>`	Server UUID
`<state>`	Current server state
`<ip>`	Server IP address
`<port>`	Server port
`<players>`	Current player count
`<max>`	Maximum players
`<time>`	Current timestamp using `format.date`
`<updated>`	Last update timestamp using `format.date`
`<create_date>`	Creation timestamp using `format.date`

Group notifications

Placeholder	Description
`<group>`	Group name
`<time>`	Current timestamp using `format.date`

Commands

Command	Description
`/scnotify` or `/scnotify help`	Show the commands available to you
`/scnotify enable`	Receive notifications again
`/scnotify disable`	Stop receiving notifications without changing permissions
`/scnotify set <player> <true\|false>`	Enable or disable notifications for an online player
`/scnotify reload config`	Reload `messages.yml`

The toggle controls all Notify messages for that player. Event permissions still decide which categories an enabled player receives.

Permissions

Permission	Description
`notify.state.server.starting`	Receive server starting messages
`notify.state.server.available`	Receive server available messages
`notify.state.server.stopping`	Receive server stopping messages
`notify.state.server.stopped`	Receive server stopped messages
`notify.state.group.created`	Receive group created messages
`notify.state.group.deleted`	Receive group deleted messages
`simplecloud.command.notify.help`	Use `/scnotify` and `/scnotify help`
`simplecloud.command.notify.reload.config`	Reload `messages.yml`
`simplecloud.command.notify.toggle.self`	Enable or disable your own notifications
`simplecloud.command.notify.toggle.other`	Change notifications for another online player

The permission check happens per notification. Give staff only the event categories they should receive.

Troubleshooting

The proxy cannot load Notify

Confirm that simplecloud-api is installed and enabled on the same proxy. Notify requires it to receive SimpleCloud events and access player properties.

A staff member receives no notifications

Run /scnotify enable as that player, then grant the permission for each event category they should receive. The personal toggle and the event permission must both allow the message.

Message changes disappear after a restart

Edit plugins/simplecloud-notify/messages.yml in the proxy template, or copy the tested file back before a temporary group proxy stops.

notify.state.server.deleted is still accepted as a legacy alias for stopped-server notifications.

Introduction

Setup

Configuration

Plugins

Supported software

Install the plugin

Notifications

Configuration

Placeholders

Server notifications

Group notifications

Commands

Permissions

Troubleshooting

​Supported software

​Install the plugin

​Notifications

​Configuration

​Placeholders

​Server notifications

​Group notifications

​Commands

​Permissions

​Troubleshooting

Supported software

Install the plugin

Notifications

Configuration

Placeholders

Server notifications

Group notifications

Commands

Permissions

Troubleshooting