broadcast

broadcast sends a formatted message to players across the proxy.

It is best for announcements, alerts, notices, event messages, and staff broadcasts.

Required fields


type: "broadcast"
command: /alert [message:greedy_string]
message: "<red>%message%"
enabled: true

Optional broadcast-only field


view_permission: "velocitycommands.view"

If view_permission is set, only players with that permission receive the broadcast.

Example: public alert


commands:
  alert:
    type: "broadcast"
    aliases: ["broadcast"]
    command: /alert [message:greedy_string]
    message: "<dark_gray>[<aqua>ALERT</aqua><dark_gray>] <white>%message%"
    permission: "velocitycommands.alert"
    enabled: true

Usage:


/alert Server restart in 5 minutes

Example: staff-only broadcast


commands:
  staffalert:
    type: "broadcast"
    command: /staffalert [message:greedy_string]
    message: "<red><bold>STAFF ALERT</bold></red> <gray>%message%"
    permission: "velocitycommands.staffalert.send"
    view_permission: "velocitycommands.staffalert.view"
    enabled: true

This creates two separate permission layers:

permission controls who can use the command
view_permission controls who can see the message

How placeholders work

Parameter placeholders work as expected:


command: /announce [title:word] [message:greedy_string]
message: "<gold>[%title%]</gold> <white>%message%"

Built-in placeholders such as %player_name% are resolved from the player who executed the command.

Example: sender-aware broadcast


commands:
  showcase:
    type: "broadcast"
    command: /showcase
    message: |
      <gradient:#55ffff:#0088ff>━━━━━━━━━━━━━━━━━━━━━━━━━━━━</gradient>
      
      <white>Hello <aqua><bold>%player_name%</bold></aqua>!
      <gray>Server: <white>%server_name%</white>
      <gray>Proxy players: <white>%proxy_total_players%</white>
      
      <gradient:#55ffff:#0088ff>━━━━━━━━━━━━━━━━━━━━━━━━━━━━</gradient>
    enabled: true

Because the base placeholders come from the executor, this style is best when the broadcast is intentionally about the person running it.

Automatic links

If the message contains a URL, the plugin turns it into a clickable link automatically.


message: "<green>Read the update: docs.example.com/update"

Notes

Broadcasts are sent to players, not the console

The command loops through online players and sends them a formatted component.

Empty `view_permission` means everyone can see it

If view_permission is missing or blank, the plugin sends the broadcast to all connected players.