Messages.json - Unariginal/MoreSparkles GitHub Wiki

Messages.json

All of the mod's text: command feedback, check-rate messages, boss bars, and Discord webhook content. Located at config/MoreSparkles/messages.json.

Warning

1.3.0 breaking changes in this file: the file was rewritten for the new boost types. Messages now use %boost_type% and the other Boost placeholders, boss bars are set per type, and the check_rate_messages and boost_webhooks sections are new. If you're updating from an older version, delete your messages.json and let MoreSparkles generate a new one, then copy your customizations back in.

Note

  • All text uses MiniMessage formatting, e.g. <green>, <bold>, <#FF66C4>.
  • Every placeholder is listed on the Placeholders page.
  • Missing keys are added with their default values the next time the file loads.
📄 Full default file 
{
  "prefix": "<gray>[<light_purple>MoreSparkles<gray>]",
  "messages": {
    "command_reload": "%prefix% <green>Reloaded!",
    "player_boost_started": "%prefix% <green>Started a %boost_multiplier%x %boost_type% boost for %boost_duration% for %player_name%!",
    "player_boost_added_to_queue": "%prefix% <green>Added a %boost_multiplier%x %boost_type% boost with a %boost_duration% duration to %player_name%'s queue!",
    "player_boost_stopped": "%prefix% <green>Stopped %player_name%'s current %boost_type% boost!",
    "player_queue_cleared": "%prefix% <green>Cleared %player_name%'s queued %boost_type% boosts!",
    "player_boost_information": "%prefix% <gray>Player: %player_name% | Boost: %boost_multiplier%x %boost_type% | Timer: %boost_time_remaining% / %boost_duration%",
    "global_boost_started": "%prefix% <green>Started a global %boost_multiplier%x %boost_type% boost for %boost_duration%!",
    "global_boost_added_to_queue": "%prefix% <green>Added a global %boost_multiplier%x %boost_type% boost with a %boost_duration% duration to queue!",
    "global_boost_stopped": "%prefix% <green>Stopped the current global %boost_type% boost!",
    "global_queue_cleared": "%prefix% <green>Cleared the global queued %boost_type% boosts!",
    "global_boost_information": "%prefix% <gray>Global Boost: %boost_multiplier%x %boost_type% | Timer: %boost_time_remaining% / %boost_duration%",
    "no_active_boosts": "%prefix% <red>No Active Boosts",
    "no_queued_boosts": "%prefix% <red>No Queued Boosts",
    "area_info": "%prefix% <gray>Area \"%boost_area_name%\": %boost_area_type% type | %boost_area_multiplier%x multiplier",
    "not_in_area": "%prefix% <red>You're not in an area!"
  },
  "check_rate_messages": {
    "SHINY": "%prefix% <gray>Shiny | Base: <yellow>1/%base_shiny_rate%<gray> | Effective: <yellow>1/%player_shiny_rate%",
    "EXPERIENCE": "%prefix% <gray>Experience | Multiplier: <yellow>%player_experience_multiplier%x",
    "HIDDEN_ABILITY": "%prefix% <gray>Hidden Ability | Multiplier: <yellow>%player_hidden_ability_multiplier%x<gray> | Chance per spawn: <yellow>%player_hidden_ability_chance%%",
    "EV": "%prefix% <gray>EV | Multiplier: <yellow>%player_ev_multiplier%x",
    "IV": "%prefix% <gray>IV | Multiplier: <yellow>%player_iv_multiplier%x<gray> | Strength Toward Perfect IVs: <yellow>%player_iv_strength%%",
    "BERRY": "%prefix% <gray>Berry | Multiplier: <yellow>%player_berry_multiplier%x",
    "CATCH_RATE": "%prefix% <gray>Catch Rate | Multiplier: <yellow>%player_catch_rate_multiplier%x",
    "MARK": "%prefix% <gray>Mark | Multiplier: <yellow>%player_mark_multiplier%x",
    "ALPHA": "%prefix% <gray>Alpha | Multiplier: <yellow>%player_alpha_multiplier%x<gray> | Alpha bucket chance: <yellow>%player_alpha_bucket_chance%%",
    "SPAWN_BUCKET": "%prefix% <gray>Spawn Bucket | Multiplier: <yellow>%player_spawn_bucket_multiplier%x<gray> | Chances | Common: <yellow>%player_bucket_chance common%<gray> | Uncommon: <yellow>%player_bucket_chance uncommon%<gray> | Rare: <yellow>%player_bucket_chance rare%<gray> | Ultra-Rare: <yellow>%player_bucket_chance ultra-rare%"
  },
  "global_boost_bossbars": {
    "SHINY": {
      "bar_color": "pink",
      "bar_overlay": "progress",
      "bar_text": "<gray>「</gray><aqua>🌐</aqua><gray>」</gray><#FF66C4><bold>✦ %boost_type% Boost</bold></#FF66C4> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <gray>%boost_time_remaining% left</gray>",
      "bar_text_paused": "<gray>「</gray><aqua>🌐</aqua><gray>」</gray><#FF66C4><bold>✦ %boost_type% Boost</bold></#FF66C4> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <red><bold>PAUSED</bold></red>"
    },
    "EXPERIENCE": {
      "bar_color": "green",
      "bar_overlay": "progress",
      "bar_text": "<gray>「</gray><aqua>🌐</aqua><gray>」</gray><#2ECC71><bold>✦ %boost_type% Boost</bold></#2ECC71> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <gray>%boost_time_remaining% left</gray>",
      "bar_text_paused": "<gray>「</gray><aqua>🌐</aqua><gray>」</gray><#2ECC71><bold>✦ %boost_type% Boost</bold></#2ECC71> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <red><bold>PAUSED</bold></red>"
    },
    "HIDDEN_ABILITY": {
      "bar_color": "purple",
      "bar_overlay": "notched_6",
      "bar_text": "<gray>「</gray><aqua>🌐</aqua><gray>」</gray><#9B59B6><bold>✦ %boost_type% Boost</bold></#9B59B6> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <gray>%boost_time_remaining% left</gray>",
      "bar_text_paused": "<gray>「</gray><aqua>🌐</aqua><gray>」</gray><#9B59B6><bold>✦ %boost_type% Boost</bold></#9B59B6> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <red><bold>PAUSED</bold></red>"
    },
    "EV": {
      "bar_color": "red",
      "bar_overlay": "notched_6",
      "bar_text": "<gray>「</gray><aqua>🌐</aqua><gray>」</gray><#E74C3C><bold>✦ %boost_type% Boost</bold></#E74C3C> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <gray>%boost_time_remaining% left</gray>",
      "bar_text_paused": "<gray>「</gray><aqua>🌐</aqua><gray>」</gray><#E74C3C><bold>✦ %boost_type% Boost</bold></#E74C3C> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <red><bold>PAUSED</bold></red>"
    },
    "IV": {
      "bar_color": "blue",
      "bar_overlay": "notched_6",
      "bar_text": "<gray>「</gray><aqua>🌐</aqua><gray>」</gray><#3498DB><bold>✦ %boost_type% Boost</bold></#3498DB> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <gray>%boost_time_remaining% left</gray>",
      "bar_text_paused": "<gray>「</gray><aqua>🌐</aqua><gray>」</gray><#3498DB><bold>✦ %boost_type% Boost</bold></#3498DB> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <red><bold>PAUSED</bold></red>"
    },
    "BERRY": {
      "bar_color": "yellow",
      "bar_overlay": "progress",
      "bar_text": "<gray>「</gray><aqua>🌐</aqua><gray>」</gray><#F1C40F><bold>✦ %boost_type% Boost</bold></#F1C40F> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <gray>%boost_time_remaining% left</gray>",
      "bar_text_paused": "<gray>「</gray><aqua>🌐</aqua><gray>」</gray><#F1C40F><bold>✦ %boost_type% Boost</bold></#F1C40F> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <red><bold>PAUSED</bold></red>"
    },
    "CATCH_RATE": {
      "bar_color": "red",
      "bar_overlay": "notched_10",
      "bar_text": "<gray>「</gray><aqua>🌐</aqua><gray>」</gray><#C0392B><bold>✦ %boost_type% Boost</bold></#C0392B> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <gray>%boost_time_remaining% left</gray>",
      "bar_text_paused": "<gray>「</gray><aqua>🌐</aqua><gray>」</gray><#C0392B><bold>✦ %boost_type% Boost</bold></#C0392B> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <red><bold>PAUSED</bold></red>"
    },
    "MARK": {
      "bar_color": "purple",
      "bar_overlay": "notched_20",
      "bar_text": "<gray>「</gray><aqua>🌐</aqua><gray>」</gray><#8E44AD><bold>✦ %boost_type% Boost</bold></#8E44AD> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <gray>%boost_time_remaining% left</gray>",
      "bar_text_paused": "<gray>「</gray><aqua>🌐</aqua><gray>」</gray><#8E44AD><bold>✦ %boost_type% Boost</bold></#8E44AD> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <red><bold>PAUSED</bold></red>"
    },
    "ALPHA": {
      "bar_color": "red",
      "bar_overlay": "notched_12",
      "bar_text": "<gray>「</gray><aqua>🌐</aqua><gray>」</gray><#922B21><bold>✦ %boost_type% Boost</bold></#922B21> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <gray>%boost_time_remaining% left</gray>",
      "bar_text_paused": "<gray>「</gray><aqua>🌐</aqua><gray>」</gray><#922B21><bold>✦ %boost_type% Boost</bold></#922B21> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <red><bold>PAUSED</bold></red>"
    },
    "SPAWN_BUCKET": {
      "bar_color": "blue",
      "bar_overlay": "progress",
      "bar_text": "<gray>「</gray><aqua>🌐</aqua><gray>」</gray><#16A085><bold>✦ %boost_type% Boost</bold></#16A085> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <gray>%boost_time_remaining% left</gray>",
      "bar_text_paused": "<gray>「</gray><aqua>🌐</aqua><gray>」</gray><#16A085><bold>✦ %boost_type% Boost</bold></#16A085> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <red><bold>PAUSED</bold></red>"
    }
  },
  "player_boost_bossbars": {
    "SHINY": {
      "bar_color": "pink",
      "bar_overlay": "progress",
      "bar_text": "<gray>「</gray><green>👤</green><gray>」</gray><#FF66C4><bold>✦ %boost_type% Boost</bold></#FF66C4> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <gray>%boost_time_remaining% left</gray>",
      "bar_text_paused": "<gray>「</gray><green>👤</green><gray>」</gray><#FF66C4><bold>✦ %boost_type% Boost</bold></#FF66C4> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <red><bold>PAUSED</bold></red>"
    },
    "EXPERIENCE": {
      "bar_color": "green",
      "bar_overlay": "progress",
      "bar_text": "<gray>「</gray><green>👤</green><gray>」</gray><#2ECC71><bold>✦ %boost_type% Boost</bold></#2ECC71> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <gray>%boost_time_remaining% left</gray>",
      "bar_text_paused": "<gray>「</gray><green>👤</green><gray>」</gray><#2ECC71><bold>✦ %boost_type% Boost</bold></#2ECC71> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <red><bold>PAUSED</bold></red>"
    },
    "HIDDEN_ABILITY": {
      "bar_color": "purple",
      "bar_overlay": "notched_6",
      "bar_text": "<gray>「</gray><green>👤</green><gray>」</gray><#9B59B6><bold>✦ %boost_type% Boost</bold></#9B59B6> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <gray>%boost_time_remaining% left</gray>",
      "bar_text_paused": "<gray>「</gray><green>👤</green><gray>」</gray><#9B59B6><bold>✦ %boost_type% Boost</bold></#9B59B6> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <red><bold>PAUSED</bold></red>"
    },
    "EV": {
      "bar_color": "red",
      "bar_overlay": "notched_6",
      "bar_text": "<gray>「</gray><green>👤</green><gray>」</gray><#E74C3C><bold>✦ %boost_type% Boost</bold></#E74C3C> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <gray>%boost_time_remaining% left</gray>",
      "bar_text_paused": "<gray>「</gray><green>👤</green><gray>」</gray><#E74C3C><bold>✦ %boost_type% Boost</bold></#E74C3C> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <red><bold>PAUSED</bold></red>"
    },
    "IV": {
      "bar_color": "blue",
      "bar_overlay": "notched_6",
      "bar_text": "<gray>「</gray><green>👤</green><gray>」</gray><#3498DB><bold>✦ %boost_type% Boost</bold></#3498DB> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <gray>%boost_time_remaining% left</gray>",
      "bar_text_paused": "<gray>「</gray><green>👤</green><gray>」</gray><#3498DB><bold>✦ %boost_type% Boost</bold></#3498DB> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <red><bold>PAUSED</bold></red>"
    },
    "BERRY": {
      "bar_color": "yellow",
      "bar_overlay": "progress",
      "bar_text": "<gray>「</gray><green>👤</green><gray>」</gray><#F1C40F><bold>✦ %boost_type% Boost</bold></#F1C40F> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <gray>%boost_time_remaining% left</gray>",
      "bar_text_paused": "<gray>「</gray><green>👤</green><gray>」</gray><#F1C40F><bold>✦ %boost_type% Boost</bold></#F1C40F> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <red><bold>PAUSED</bold></red>"
    },
    "CATCH_RATE": {
      "bar_color": "red",
      "bar_overlay": "notched_10",
      "bar_text": "<gray>「</gray><green>👤</green><gray>」</gray><#C0392B><bold>✦ %boost_type% Boost</bold></#C0392B> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <gray>%boost_time_remaining% left</gray>",
      "bar_text_paused": "<gray>「</gray><green>👤</green><gray>」</gray><#C0392B><bold>✦ %boost_type% Boost</bold></#C0392B> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <red><bold>PAUSED</bold></red>"
    },
    "MARK": {
      "bar_color": "purple",
      "bar_overlay": "notched_20",
      "bar_text": "<gray>「</gray><green>👤</green><gray>」</gray><#8E44AD><bold>✦ %boost_type% Boost</bold></#8E44AD> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <gray>%boost_time_remaining% left</gray>",
      "bar_text_paused": "<gray>「</gray><green>👤</green><gray>」</gray><#8E44AD><bold>✦ %boost_type% Boost</bold></#8E44AD> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <red><bold>PAUSED</bold></red>"
    },
    "ALPHA": {
      "bar_color": "red",
      "bar_overlay": "notched_12",
      "bar_text": "<gray>「</gray><green>👤</green><gray>」</gray><#922B21><bold>✦ %boost_type% Boost</bold></#922B21> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <gray>%boost_time_remaining% left</gray>",
      "bar_text_paused": "<gray>「</gray><green>👤</green><gray>」</gray><#922B21><bold>✦ %boost_type% Boost</bold></#922B21> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <red><bold>PAUSED</bold></red>"
    },
    "SPAWN_BUCKET": {
      "bar_color": "blue",
      "bar_overlay": "progress",
      "bar_text": "<gray>「</gray><green>👤</green><gray>」</gray><#16A085><bold>✦ %boost_type% Boost</bold></#16A085> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <gray>%boost_time_remaining% left</gray>",
      "bar_text_paused": "<gray>「</gray><green>👤</green><gray>」</gray><#16A085><bold>✦ %boost_type% Boost</bold></#16A085> <dark_gray>•</dark_gray> <gold>%boost_multiplier%x</gold> <dark_gray>•</dark_gray> <red><bold>PAUSED</bold></red>"
    }
  },
  "boost_webhooks": {
    "SHINY": {
      "username": "%boost_type% Boost",
      "avatar_url": "",
      "message": "",
      "title": "✨ %boost_type% Boost Activated!",
      "color": "#FF66C4",
      "thumbnail_url": "",
      "fields": [
        {
          "inline": true,
          "name": "Multiplier",
          "value": "%boost_multiplier%x"
        },
        {
          "inline": true,
          "name": "Time Remaining",
          "value": "%boost_time_remaining%"
        }
      ]
    },
    "EXPERIENCE": {
      "username": "%boost_type% Boost",
      "avatar_url": "",
      "message": "",
      "title": "📈 %boost_type% Boost Activated!",
      "color": "#2ECC71",
      "thumbnail_url": "",
      "fields": [
        {
          "inline": true,
          "name": "Multiplier",
          "value": "%boost_multiplier%x"
        },
        {
          "inline": true,
          "name": "Time Remaining",
          "value": "%boost_time_remaining%"
        }
      ]
    },
    "HIDDEN_ABILITY": {
      "username": "%boost_type% Boost",
      "avatar_url": "",
      "message": "",
      "title": "🎭 %boost_type% Boost Activated!",
      "color": "#9B59B6",
      "thumbnail_url": "",
      "fields": [
        {
          "inline": true,
          "name": "Multiplier",
          "value": "%boost_multiplier%x"
        },
        {
          "inline": true,
          "name": "Time Remaining",
          "value": "%boost_time_remaining%"
        }
      ]
    },
    "EV": {
      "username": "%boost_type% Boost",
      "avatar_url": "",
      "message": "",
      "title": "💪 %boost_type% Boost Activated!",
      "color": "#E74C3C",
      "thumbnail_url": "",
      "fields": [
        {
          "inline": true,
          "name": "Multiplier",
          "value": "%boost_multiplier%x"
        },
        {
          "inline": true,
          "name": "Time Remaining",
          "value": "%boost_time_remaining%"
        }
      ]
    },
    "IV": {
      "username": "%boost_type% Boost",
      "avatar_url": "",
      "message": "",
      "title": "🧬 %boost_type% Boost Activated!",
      "color": "#3498DB",
      "thumbnail_url": "",
      "fields": [
        {
          "inline": true,
          "name": "Multiplier",
          "value": "%boost_multiplier%x"
        },
        {
          "inline": true,
          "name": "Time Remaining",
          "value": "%boost_time_remaining%"
        }
      ]
    },
    "BERRY": {
      "username": "%boost_type% Boost",
      "avatar_url": "",
      "message": "",
      "title": "🍇 %boost_type% Boost Activated!",
      "color": "#F1C40F",
      "thumbnail_url": "",
      "fields": [
        {
          "inline": true,
          "name": "Multiplier",
          "value": "%boost_multiplier%x"
        },
        {
          "inline": true,
          "name": "Time Remaining",
          "value": "%boost_time_remaining%"
        }
      ]
    },
    "CATCH_RATE": {
      "username": "%boost_type% Boost",
      "avatar_url": "",
      "message": "",
      "title": "🎯 %boost_type% Boost Activated!",
      "color": "#C0392B",
      "thumbnail_url": "",
      "fields": [
        {
          "inline": true,
          "name": "Multiplier",
          "value": "%boost_multiplier%x"
        },
        {
          "inline": true,
          "name": "Time Remaining",
          "value": "%boost_time_remaining%"
        }
      ]
    },
    "MARK": {
      "username": "%boost_type% Boost",
      "avatar_url": "",
      "message": "",
      "title": "⭐ %boost_type% Boost Activated!",
      "color": "#8E44AD",
      "thumbnail_url": "",
      "fields": [
        {
          "inline": true,
          "name": "Multiplier",
          "value": "%boost_multiplier%x"
        },
        {
          "inline": true,
          "name": "Time Remaining",
          "value": "%boost_time_remaining%"
        }
      ]
    },
    "ALPHA": {
      "username": "%boost_type% Boost",
      "avatar_url": "",
      "message": "",
      "title": "👑 %boost_type% Boost Activated!",
      "color": "#922B21",
      "thumbnail_url": "",
      "fields": [
        {
          "inline": true,
          "name": "Multiplier",
          "value": "%boost_multiplier%x"
        },
        {
          "inline": true,
          "name": "Time Remaining",
          "value": "%boost_time_remaining%"
        }
      ]
    },
    "SPAWN_BUCKET": {
      "username": "%boost_type% Boost",
      "avatar_url": "",
      "message": "",
      "title": "🪣 %boost_type% Boost Activated!",
      "color": "#16A085",
      "thumbnail_url": "",
      "fields": [
        {
          "inline": true,
          "name": "Multiplier",
          "value": "%boost_multiplier%x"
        },
        {
          "inline": true,
          "name": "Time Remaining",
          "value": "%boost_time_remaining%"
        }
      ]
    }
  }
}

Top Level

Field Type Description
prefix string Text used by %prefix%, shown at the start of most messages.
messages object Command feedback. See Messages.
check_rate_messages object One message per boost type for /sparkles check-rate. See Check Rate Messages.
global_boost_bossbars object One boss bar per boost type for global boosts. See Boss Bars.
player_boost_bossbars object One boss bar per boost type for player boosts.
boost_webhooks object One Discord message per boost type for global boosts. See Boost Webhooks.

Messages — messages

The "Placeholders" column lists which placeholder groups each message can use, besides %prefix% and the Server placeholders, which work everywhere.

Field Sent When Placeholders
command_reload /sparkles reload finishes. —
player_boost_started A player boost starts. Sent once per player. Player, Boost
player_boost_added_to_queue A player boost is added to the queue. Player, Boost
player_boost_stopped A player boost is stopped with /sparkles boost stop. Player, Boost
player_queue_cleared A player's queue is cleared with /sparkles clear-queue. Player, %boost_type%
player_boost_information Once per boost for /sparkles boost status and /sparkles check-queue. Player, Boost
global_boost_started A global boost starts. Boost
global_boost_added_to_queue A global boost is added to the queue. Boost
global_boost_stopped A global boost is stopped with /sparkles boost stop. Boost
global_queue_cleared The global queue is cleared with /sparkles clear-queue <type> global. %boost_type%
global_boost_information Once per boost for /sparkles boost status global and /sparkles check-queue global. Boost
no_active_boosts /sparkles boost status finds no active boosts, or /sparkles boost stop <type> global finds no active global boost of that type. Player (when about a player)
no_queued_boosts /sparkles check-queue finds no queued boosts. Player (when about a player)
area_info /sparkles area info finds an area. Player, Boost Area
not_in_area /sparkles area info finds no area, or the area ID doesn't exist. Player

Note

These messages are sent to whoever ran the command, not to the boosted player. Players see their boosts through the boss bars below.

Check Rate Messages — check_rate_messages

A map of boost type → message, sent by /sparkles check-rate <type>. These messages can use Player placeholders, which read from the player being checked.

If a type is missing from this section, MoreSparkles uses a simple fallback that shows the type's multiplier:

%prefix% <gray><Display Name> | Multiplier: <yellow>%player_<type>_multiplier%x

Boss Bars — global_boost_bossbars / player_boost_bossbars

Each section is a map of boost type → boss bar. Global boost bars are shown to every player; player boost bars are shown only to the boosted player. A player can see several boss bars at once, one for each active boost.

If a type is missing from a section, boosts of that type have no boss bar.

Field Type Description
bar_color string pink, blue, red, green, yellow, purple or white.
bar_overlay string progress (a solid bar), notched_6, notched_10, notched_12 or notched_20.
bar_text string The bar's text while the boost is running. Can use Boost placeholders.
bar_text_paused string The bar's text while the boost is paused. See How-It-Works.

The bar empties as the boost's time runs out, and stops moving while the boost is paused.

Boost Webhooks — boost_webhooks

A map of boost type → Discord message content, used for global boosts when webhooks are enabled in Config.json. If a type is missing from this section, global boosts of that type aren't posted.

Field Type Description
username string The name the webhook posts as. Can use placeholders.
avatar_url string Profile picture URL for the webhook. Leave empty to use the webhook's own avatar.
message string Plain text sent above the embed. Can use placeholders. Leave empty for no text.
title string The embed's title. Can use placeholders.
color string The embed's side color, as a hex code like #FF66C4.
thumbnail_url string Image URL for the embed. Leave empty for no image.
fields list The embed's fields. See below.

Embed fields

Field Type Description
name string The field's heading. Can use placeholders.
value string The field's content. Can use placeholders.
inline boolean Show this field next to other inline fields instead of on its own line.

Webhook text can use Server and Boost placeholders. Discord doesn't understand MiniMessage, so use Discord's markdown (**bold**, *italic*) instead of tags like <bold>.

See Also

  • Placeholders: every placeholder available in this file.
  • Config.json: turning webhooks on and setting their update rate.
  • How-It-Works: when boosts start, pause, queue and end.
⚠️ **GitHub.com Fallback** ⚠️