Notify Plugin

All information about this project can be found in our detailed documentation.

Keep your staff informed about server state changes with real-time notifications using MiniMessage formatting.

Features

• [x] Ingame Notifiction: Get chat messages about server changes
• [x] Customize Messages: Configurable messages (minimessage supported)
• [x] Velocity & BungeeCord support

Configuration

Here you can see the configuration file for the plugin. All possible options are explained in the comments.

version: 1

# ───────────────────────────────────────────────────────────────────────────────
# Format Settings
# ───────────────────────────────────────────────────────────────────────────────
format:
    date: "dd.MM.yyyy HH:mm:ss"

# ───────────────────────────────────────────────────────────────────────────────
# Variables
# Reusable variables that can be used throughout the messages.
# Usage: <variable_name> will be replaced with the defined value.
# ───────────────────────────────────────────────────────────────────────────────
variables:
    prefix: "<color:#0EA5E9><bold>⚡</bold></color>"

# ───────────────────────────────────────────────────────────────────────────────
# Command Messages
# ───────────────────────────────────────────────────────────────────────────────
command:
    help:
        title: "<prefix> <#0EA5E9>SimpleCloud Notify commands"
        entry: "<#E2E8F0><command>"
        empty: "<prefix> <#F59E0B>No notify commands are available for you."

    usage:
        invalid: "<prefix> <#DC2626>Use <#F8FAFC><command> <#DC2626>instead."
        entry: "<#E2E8F0><command>"
        invalid-state: "<prefix> <#DC2626>Use <#F8FAFC>enable <#DC2626>or <#F8FAFC>disable<#DC2626>."
        invalid-toggle-value: "<prefix> <#DC2626>Use <#F8FAFC>true <#DC2626>or <#F8FAFC>false<#DC2626>."
        missing-player: "<prefix> <#DC2626>Missing player <#F8FAFC><playername><#DC2626>."

    permission:
        denied: "<prefix> <#DC2626>You do not have permission to use this command."

    notify:
        enabled: "<prefix> <#A3E635>Server notifications are now <#F8FAFC>enabled<#A3E635>."
        disabled: "<prefix> <#A3E635>Server notifications are now <#F8FAFC>disabled<#A3E635>."
        already-enabled: "<prefix> <#F59E0B>Server notifications are already <#F8FAFC>enabled<#F59E0B>."
        already-disabled: "<prefix> <#F59E0B>Server notifications are already <#F8FAFC>disabled<#F59E0B>."

    set:
        enabled: "<prefix> <#A3E635>Server notifications are now <#F8FAFC>enabled <#A3E635>for <white><head:<playername>:true> <#F8FAFC><displayname><#A3E635>."
        disabled: "<prefix> <#A3E635>Server notifications are now <#F8FAFC>disabled <#A3E635>for <white><head:<playername>:true> <#F8FAFC><displayname><#A3E635>."
        already-enabled: "<prefix> <#F59E0B>Server notifications are already <#F8FAFC>enabled <#F59E0B>for <white><head:<playername>:true> <#F8FAFC><displayname><#F59E0B>."
        already-disabled: "<prefix> <#F59E0B>Server notifications are already <#F8FAFC>disabled <#F59E0B>for <white><head:<playername>:true> <#F8FAFC><displayname><#F59E0B>."

    reload:
        config:
            success: "<prefix> <#A3E635>Notify configuration was reloaded."
            failed: "<prefix> <#DC2626>Notify configuration could not be reloaded."

    error:
        player-not-found: "<prefix> <#DC2626>Player <#F8FAFC><playername> <#DC2626>was not found."
        player-not-online: "<prefix> <#DC2626>Player <#F8FAFC><playername> <#DC2626>is not online."
        only-players: "<prefix> <#DC2626>This command can only be used by players."
        storage-unavailable: "<prefix> <#DC2626>Notify settings are currently unavailable."
        internal: "<prefix> <#DC2626>An internal error occurred. Try again later."

# ───────────────────────────────────────────────────────────────────────────────
# Notifications
# Notification messages for different server and group states.
#
# NOTE: If you delete a state entry, the corresponding notification will not be sent.
# ───────────────────────────────────────────────────────────────────────────────
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> <#0EA5E9>is now <#F8FAFC>starting<#0EA5E9>."
        available: "<prefix> <#A3E635>Server <hover:show_text:'<notifications.hover.server>'><#F8FAFC><server></hover> <#A3E635>is now <#F8FAFC>available<#A3E635>."
        stopping: "<prefix> <#F59E0B>Server <hover:show_text:'<notifications.hover.server>'><#F8FAFC><server></hover> <#F59E0B>is now <#F8FAFC>stopping<#F59E0B>."
        stopped: "<prefix> <#DC2626>Server <hover:show_text:'<notifications.hover.server>'><#F8FAFC><server></hover> <#DC2626>is now <#F8FAFC>stopped<#DC2626>."
    group:
        created: "<prefix> <#0EA5E9>Group <hover:show_text:'<notifications.hover.group>'><#F8FAFC><group></hover> <#0EA5E9>was created."
        deleted: "<prefix> <#DC2626>Group <hover:show_text:'<notifications.hover.group>'><#F8FAFC><group></hover> <#DC2626>was deleted."

Contributing

Contributions to SimpleCloud are welcome and highly appreciated. However, before you jump right into it, we would like you to read our Contribution Guide.

License

This repository is licensed under Apache 2.0.