Cobblemon Boosters - Configuration

All of the configuration files for Cobblemon Boosters are located in the <game_directory>/config/cobblemon_boosters/ directory.

Here is a brief overview of the configuration files and their purposes:

cache.json: This file is used to store cached data for the mod, such as booster information and player data. It is automatically generated and updated by the mod, and should not be edited manually.
messages.json: This file contains all of the customizable messages used by the mod. You can edit this file to change the text of messages sent to players, such as booster activation messages, error messages, and more.
permissions.json: This file contains the permission nodes used by the mod. You can edit this file to change the permission nodes required for various commands and actions related to boosters.
webhooks.json: This file contains the configuration for any webhooks that the mod may use. You can edit this file to customize webhook settings.

Cache File

The cache.json file is used to store cached data for the mod, such as booster information and player data. It is automatically generated and updated by the mod, and should not be edited manually. If you need to clear the cache, you can simply delete this file and it will be recreated the next time the server is started.

{
  "queuedShinyBoosts": [],
  "queuedCatchBoosts": [],
  "queuedExperienceBoosts": [],
  "queuedSpawnBucketBoosts": []
}

queuedShinyBoosts: This array stores information about any shiny boosts that are currently queued to be activated. Each boost in the queue will have details such as the multiplier, duration, and time remaining until activation.
queuedCatchBoosts: This array stores information about any catch boosts that are currently queued to be activated. Similar to shiny boosts, each catch boost will have details about the multiplier, duration, and time remaining until activation.
queuedExperienceBoosts: This array stores information about any experience boosts that are currently queued to be activated. Each experience boost will have details about the multiplier, duration, and time remaining until activation.
queuedSpawnBucketBoosts: This array stores information about any spawn bucket boosts that are currently queued to be activated. Each spawn bucket boost will have details about the bucket type, duration, and time remaining until activation.

Messages File

The messages.json file contains all of the customizable messages used by the mod. You can edit this file to change the text of messages sent to players, such as booster activation messages, error messages, and more.

{
  "messages": {
    "prefix": "&7[&6Boosters&7]",
    "commandReload": "%prefix% &aReloaded the config!",
    "shinyMessages": {
      "barColor": "YELLOW",
      "barOverlay": "PROGRESS",
      "barText": "&6%multiplier%x Shiny Boost &7| &a%time_remaining% Remaining",
      "noActiveBoosts": "%prefix% &aThere are currently no active Shiny Boosts!",
      "boostStarted": "%prefix% &aStarted a Shiny %multiplier%x boost for %duration%!",
      "boostAddedToQueued": "%prefix% &aAdded a Shiny %multiplier%x boost with a %duration% duration to queue!",
      "boostStopped": "%prefix% &aStopped the current Shiny boost!",
      "boostQueueCleared": "%prefix% &aCleared the Shiny queued boosts!",
      "boostInfo": "%prefix% &f&lMultiplier: &r&6%multiplier%x &7&l| &r&f&lTimer: &r&a%time_remaining% &7/ &a%duration%",
      "noQueuedBoosts": "%prefix% &aThere are currently no Shiny Boosts in the queue!"
    },
    "catchBoostMessages": {
      "barColor": "PURPLE",
      "barOverlay": "PROGRESS",
      "barText": "&d%multiplier%x Catch Boost &7| &a%time_remaining% Remaining",
      "noActiveBoosts": "%prefix% &aThere are currently no active Catch Boosts!",
      "boostStarted": "%prefix% &aStarted a Catch %multiplier%x boost for %duration%!",
      "boostAddedToQueued": "%prefix% &aAdded a Catch %multiplier%x boost with a %duration% duration to queue!",
      "boostStopped": "%prefix% &aStopped the current Catch boost!",
      "boostQueueCleared": "%prefix% &aCleared the Catch queued boosts!",
      "boostInfo": "%prefix% &f&lMultiplier: &r&d%multiplier%x &7&l| &r&f&lTimer: &r&a%time_remaining% &7/ &a%duration%",
      "noQueuedBoosts": "%prefix% &aThere are currently no Catch Boosts in the queue!"
    },
    "experienceBoostMessages": {
      "barColor": "GREEN",
      "barOverlay": "PROGRESS",
      "barText": "&a%multiplier%x Experience Boost &7| &a%time_remaining% Remaining",
      "noActiveBoosts": "%prefix% &aThere are currently no active Experience Boosts!",
      "boostStarted": "%prefix% &aStarted a Experience %multiplier%x boost for %duration%!",
      "boostAddedToQueued": "%prefix% &aAdded a Experience %multiplier%x boost with a %duration% duration to queue!",
      "boostStopped": "%prefix% &aStopped the current Experience boost!",
      "boostQueueCleared": "%prefix% &aCleared the Experience queued boosts!",
      "boostInfo": "%prefix% &f&lMultiplier: &r&a%multiplier%x &7&l| &r&f&lTimer: &r&a%time_remaining% &7/ &a%duration%",
      "noQueuedBoosts": "%prefix% &aThere are currently no Experience Boosts in the queue!"
    },
    "spawnBucketBoostMessages": {
      "barColor": "BLUE",
      "barOverlay": "PROGRESS",
      "barText": "&b%bucket% Spawn Bucket Boost &7| &a%time_remaining% Remaining",
      "noActiveBoosts": "%prefix% &aThere are currently no active Spawn Bucket Boosts!",
      "boostStarted": "%prefix% &aStarted a %bucket% Spawn Bucket Boost for %duration%!",
      "boostAddedToQueued": "%prefix% &aAdded a %bucket% Spawn Bucket Boost with a %duration% duration to queue!",
      "boostStopped": "%prefix% &aStopped the current Spawn Bucket boost!",
      "boostQueueCleared": "%prefix% &aCleared the Spawn Bucket queued boosts!",
      "boostInfo": "%prefix% &f&lBucket: &r&b%bucket% &7&l| &r&f&lTimer: &r&a%time_remaining% &7/ &a%duration%",
      "noQueuedBoosts": "%prefix% &aThere are currently no Spawn Bucket Boosts in the queue!"
    }
  }
}

messages.prefix: This is the prefix that will be used in all messages sent by the mod. You can customize this to fit the theme of your server.
messages.commandReload: This message is sent to players when the mod’s configuration is reloaded. You can customize this message to provide feedback to players when they reload the config.

The rest of the messages are organized into sections for each type of booster (shiny, catch, experience, and spawn bucket). Each section contains messages related to that specific booster type, such as activation messages, error messages, and information messages. You can customize these messages to provide a unique experience for your players when they interact with boosters on your server.

messages.<boosterType>Messages.barColor: This setting determines the color of the boss bar displayed for active boosts of this type. You can choose from standard Minecraft color names (e.g., “RED”, “GREEN”, “BLUE”) to customize the appearance of the boss bar.
messages.<boosterType>Messages.barOverlay: This setting determines the style of the boss bar overlay for active boosts of this type. You can choose from options like “PROGRESS”, “NOTCHED_6”, “NOTCHED_10”, etc., to customize the look of the boss bar.
messages.<boosterType>Messages.barText: This message is used to display information about the active boost in the boss bar. You can use placeholders such as %multiplier%, %time_remaining%, and %duration% to dynamically display the boost’s multiplier, remaining time, and total duration in the boss bar text.
messages.<boosterType>Messages.noActiveBoosts: This message is sent to players when they check for active boosts of this type and there are none currently active. You can customize this message to inform players that there are no active boosts of this type at the moment.
messages.<boosterType>Messages.boostStarted: This message is sent to players when a new boost of this type is started. You can customize this message to provide feedback to players when a boost is activated, including the multiplier and duration of the boost.
messages.<boosterType>Messages.boostAddedToQueued: This message is sent to players when a new boost of this type is added to the queue. You can customize this message to inform players that a boost has been queued for activation, including the multiplier and duration of the boost.
messages.<boosterType>Messages.boostStopped: This message is sent to players when the current active boost of this type is stopped. You can customize this message to provide feedback to players when a boost is deactivated.
messages.<boosterType>Messages.boostQueueCleared: This message is sent to players when the queue of boosts of this type is cleared. You can customize this message to inform players that all queued boosts of this type have been removed.
messages.<boosterType>Messages.boostInfo: This message is sent to players when they check for information about the active boost of this type. You can customize this message to display detailed information about the active boost, including the multiplier and remaining time.
messages.<boosterType>Messages.noQueuedBoosts: This message is sent to players when they check for queued boosts of this type and there are none currently in the queue. You can customize this message to inform players that there are no boosts of this type currently queued for activation.

Permissions File

{
  "permissionlevels": {
    "command.boosters.reload": 4,
    "command.boosters.catch": 0,
    "command.boosters.catch.start": 4,
    "command.boosters.catch.stop": 4,
    "command.boosters.catch.status": 0,
    "command.boosters.experience": 0,
    "command.boosters.experience.start": 4,
    "command.boosters.experience.stop": 4,
    "command.boosters.experience.status": 4,
    "command.boosters.shiny": 0,
    "command.boosters.shiny.start": 4,
    "command.boosters.shiny.stop": 4,
    "command.boosters.shiny.status": 0,
    "command.boosters.bucket": 0,
    "command.boosters.bucket.start": 4,
    "command.boosters.bucket.stop": 4,
    "command.boosters.bucket.status": 0,
    "command.boosters.clear_queues": 4,
    "command.boosters.check_queue": 0
  }
}

This file contains the permission nodes used by the mod. You can edit this file to change the permission nodes required for various commands and actions related to boosters. The permissionlevels object maps each permission node to a required permission level, which determines who can execute the associated command or action. For example, a permission level of 0 means that all players can use the command, while a permission level of 4 means that only server operators can use the command. You can customize these permission levels to fit the needs of your server and control who has access to booster-related commands and actions.

Webhooks File

This file contains the configuration for any webhooks that the mod may use. You can edit this file to customize webhook settings, such as the URL of the webhook, the events that trigger the webhook, and the content of the messages sent by the webhook.

{
  "discordWebhookConfig": {
    "enabled": false,
    "webhookUrl": "DISCORD_WEBHOOK_URL_HERE",
    "discordAuthorName": "Cobblemon Boosters",
    "discordAuthorIconUrl": "https://raw.githubusercontent.com/Matthiesen-Dev/cobblemon-boosters/refs/heads/main/assets/logo.png",
    "catchEventStartEmbed": {
      "title": "Catch Event Started!",
      "description": "A new Catch Boost event has started! Here are the details:",
      "color": 10181046,
      "author": {
        "name": "%discord_webhook_author_name%",
        "icon_url": "%discord_webhook_author_icon_url%"
      },
      "fields": [
        {
          "name": "Multiplier",
          "value": "%multiplier%x",
          "inline": true
        },
        {
          "name": "Duration",
          "value": "%duration%",
          "inline": true
        }
      ],
      "timestamp": "%timestamp%"
    },
    "catchEventEndEmbed": {
      "title": "Catch Event Ended!",
      "description": "The %multiplier%x Catch Boost event has ended!",
      "color": 10181046,
      "author": {
        "name": "%discord_webhook_author_name%",
        "icon_url": "%discord_webhook_author_icon_url%"
      },
      "timestamp": "%timestamp%"
    },
    "experienceEventStartEmbed": {
      "title": "Experience Event Started!",
      "description": "A new Experience Boost event has started! Here are the details:",
      "color": 3066993,
      "author": {
        "name": "%discord_webhook_author_name%",
        "icon_url": "%discord_webhook_author_icon_url%"
      },
      "fields": [
        {
          "name": "Multiplier",
          "value": "%multiplier%x",
          "inline": true
        },
        {
          "name": "Duration",
          "value": "%duration%",
          "inline": true
        }
      ],
      "timestamp": "%timestamp%"
    },
    "experienceEventEndEmbed": {
      "title": "Experience Event Ended!",
      "description": "The %multiplier%x Experience Boost event has ended!",
      "color": 3066993,
      "author": {
        "name": "%discord_webhook_author_name%",
        "icon_url": "%discord_webhook_author_icon_url%"
      },
      "timestamp": "%timestamp%"
    },
    "shinyEventStartEmbed": {
      "title": "Shiny Event Started!",
      "description": "A new Shiny Boost event has started! Here are the details:",
      "color": 15844367,
      "author": {
        "name": "%discord_webhook_author_name%",
        "icon_url": "%discord_webhook_author_icon_url%"
      },
      "fields": [
        {
          "name": "Multiplier",
          "value": "%multiplier%x",
          "inline": true
        },
        {
          "name": "Duration",
          "value": "%duration%",
          "inline": true
        }
      ],
      "timestamp": "%timestamp%"
    },
    "shinyEventEndEmbed": {
      "title": "Shiny Event Ended!",
      "description": "The %multiplier%x Shiny Boost event has ended!",
      "color": 15844367,
      "author": {
        "name": "%discord_webhook_author_name%",
        "icon_url": "%discord_webhook_author_icon_url%"
      },
      "timestamp": "%timestamp%"
    },
    "spawnBucketEventStartEmbed": {
      "title": "Spawn Bucket Event Started!",
      "description": "A new Spawn Bucket Boost event has started! Here are the details:",
      "color": 3447003,
      "author": {
        "name": "%discord_webhook_author_name%",
        "icon_url": "%discord_webhook_author_icon_url%"
      },
      "fields": [
        {
          "name": "Bucket",
          "value": "%bucket%",
          "inline": true
        },
        {
          "name": "Duration",
          "value": "%duration%",
          "inline": true
        }
      ],
      "timestamp": "%timestamp%"
    },
    "spawnBucketEventEndEmbed": {
      "title": "Spawn Bucket Event Ended!",
      "description": "The %bucket% Spawn Bucket Boost event has ended!",
      "color": 3447003,
      "author": {
        "name": "%discord_webhook_author_name%",
        "icon_url": "%discord_webhook_author_icon_url%"
      },
      "timestamp": "%timestamp%"
    }
  }
}

discordWebhookConfig.enabled: This setting determines whether the Discord webhook integration is enabled or not. Set this to true to enable webhooks, or false to disable them.
discordWebhookConfig.webhookUrl: This is the URL of the Discord webhook that will receive the notifications. You should replace the placeholder URL with the actual URL of your Discord webhook.
discordWebhookConfig.discordAuthorName: This is the name that will be displayed as the author of the webhook messages in Discord. You can customize this to fit the theme of your server or mod.
discordWebhookConfig.discordAuthorIconUrl: This is the URL of the icon that will be displayed as the author of the webhook messages in Discord. You can customize this to fit the theme of your server or mod.

The rest of the settings in this file define the content and appearance of the webhook messages for different events related to boosters, such as when a boost starts or ends. Each event has its own embed configuration, which includes the title, description, color, author information, fields, and timestamp for the webhook message. You can customize these settings to create unique and informative webhook messages that will be sent to your Discord channel when booster events occur on your server.