Cobblemon Boosters - Configuration

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

Configuration files:

cache.toml - This file contains cached data for the boosters. It is automatically generated and should not be edited manually.
core.toml - This file contains the core configuration options for Cobblemon Boosters.
permissions.toml - This file contains the permission nodes for Cobblemon Boosters.
webhooks.toml - This file contains the configuration options for Discord webhooks. This file is only used if the matthiesen_core_webhooks mod is installed.

Core Configuration

#General Configuration
[general]
  saveIntervalTicks = 600
  verboseCacheLogging = false
  displayMode = "BOSSBAR"
  queuePriorityEnabled = true
  queuePriorityMode = "FIFO"
  timePriorityDirection = "SHORTEST_FIRST"
  activePreemptionEnabled = false

#Messages Configuration
[messages]
  prefix = "&7[&6Boosters&7]"
  sidebarTitle = "&6&lBoosters"
  commandReload = "%prefix% &aReloaded Cobblemon Boosters!"
  queuePriorityStatus = "%prefix% &7Queue priority -> enabled: &f%s&7, mode: &f%s&7, timeDirection: &f%s&7, preemption: &f%s"
  queuePriorityUpdated = "%prefix% &aUpdated queue priority setting: &f%s"

  #Shiny Boost Messages
  [messages.shinyMessages]
    barColor = "YELLOW"
    barOverlay = "PROGRESS"
    barText = "&6%multiplier%x Shiny Boost &7| &a%time_remaining% Remaining"
    sidebarLine = "&7%time_remaining_short2% &6Shiny &f%multiplier%x"
    noActiveBoosts = "%prefix% &aThere are currently no active Shiny Boosts!"
    boostStarted = "%prefix% &aStarted an Shiny %multiplier%x boost for %duration%!"
    boostAddedToQueue = "%prefix% &aAdded an 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!"

  #Catch Boost Messages
  [messages.catchBoostMessages]
    barColor = "PURPLE"
    barOverlay = "PROGRESS"
    barText = "&d%multiplier%x Catch Boost &7| &a%time_remaining% Remaining"
    sidebarLine = "&7%time_remaining_short2% &dCatch &f%multiplier%x"
    noActiveBoosts = "%prefix% &aThere are currently no active Catch Boosts!"
    boostStarted = "%prefix% &aStarted an Catch %multiplier%x boost for %duration%!"
    boostAddedToQueue = "%prefix% &aAdded an 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!"

  #Experience Boost Messages
  [messages.experienceBoostMessages]
    barColor = "GREEN"
    barOverlay = "PROGRESS"
    barText = "&a%multiplier%x Experience Boost &7| &a%time_remaining% Remaining"
    sidebarLine = "&7%time_remaining_short2% &aExp &f%multiplier%x"
    noActiveBoosts = "%prefix% &aThere are currently no active Experience Boosts!"
    boostStarted = "%prefix% &aStarted an Experience %multiplier%x boost for %duration%!"
    boostAddedToQueue = "%prefix% &aAdded an 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!"

  #Spawn Bucket Boost Messages
  [messages.spawnBucketBoostMessages]
    barColor = "BLUE"
    barOverlay = "PROGRESS"
    barText = "&b%bucket% Spawn Bucket Boost &7| &a%time_remaining% Remaining"
    sidebarLine = "&7%time_remaining_short2% &b%bucket% &f%multiplier%x"
    noActiveBoosts = "%prefix% &aThere are currently no active Spawn Bucket Boosts!"
    boostStarted = "%prefix% &aStarted a %bucket% Spawn Bucket boost for %duration%!"
    boostAddedToQueue = "%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!"

General Configuration

saveIntervalTicks

The interval in ticks at which the server saves data. The default value is 600 ticks (30 seconds). This value must be greater than 1.

Default Value: 600

verboseCacheLogging

Enables or disables verbose logging for the cache. When enabled, the server will log detailed information about cache operations.

Default Value: false

displayMode

Specifies the display mode of the boosts for the server.

Allowed Values:

BOSSBAR
SIDEBAR
NONE
Default Value: BOSSBAR

queuePriorityEnabled

Enables or disables the queue priority system. When enabled, boosts will be processed based on the specified priority mode.

Default Value: true

queuePriorityMode

Specifies the mode for queue priority. This determines how boosts are prioritized in the queue.

Allowed Values:

FIFO - First In, First Out
MULTIPLIER - Prioritize based on the multiplier value
TIME_REMAINING - Prioritize based on the remaining time of the boost
Default Value: FIFO

timePriorityDirection

Specifies the direction for time-based priority when queuePriorityMode is set to TIME_REMAINING.

Allowed Values:

SHORTEST_FIRST - Prioritize boosts with the shortest remaining time
LONGEST_FIRST - Prioritize boosts with the longest remaining time
Default Value: SHORTEST_FIRST

activePreemptionEnabled

Enables or disables active preemption in the queue. When enabled, new boosts can preempt currently active boosts based on the priority settings.

Default Value: false

Messages Configuration

prefix

The prefix for all messages sent by the mod. This is typically used to identify messages related to Cobblemon Boosters.

Default Value: &7[&6Boosters&7]

sidebarTitle

The title displayed on the sidebar for the boosts. This is used when the display mode is set to SIDEBAR.

Default Value: &6&lBoosters

commandReload

The message displayed when the booster services are reloaded. This message is sent to the player who executed the reload command.

Default Value: &7Booster services reloaded successfully.

queuePriorityStatus

The message displayed to show the current status of the queue priority system. This includes whether it is enabled, the current mode, time direction, and preemption status.

Default Value: &7Queue priority -> enabled: &f%s&7, mode: &f%s&7, timeDirection: &f%s&7, preemption: &f%s

queuePriorityUpdated

The message displayed when the queue priority settings are updated. This message includes the new settings for the queue priority system.

Default Value: &7Updated queue priority setting: &f%s

Boost Messages

Shiny Boost Messages, Catch Boost Messages, Experience Boost Messages, and Spawn Bucket Boost Messages each have their own set of messages for various events such as starting a boost, adding to the queue, stopping a boost, clearing the queue, and displaying information about the boost. Each of these message sets includes customizable text for the boss bar, sidebar, and chat messages.

barColor

The color of the boss bar for the respective boost type.

Allowed Values:

PINK
BLUE
RED
GREEN
YELLOW
PURPLE
WHITE

barOverlay

The overlay style of the boss bar for the respective boost type.

Allowed Values:

PROGRESS
NOTCHED_6
NOTCHED_10
NOTCHED_12
NOTCHED_20

barText

The text displayed on the boss bar for the respective boost type. This can include placeholders such as %multiplier% and %time_remaining%.

sidebarLine

The line text for the sidebar display for the respective boost type. This can include placeholders such as %time_remaining_short2% and %multiplier%.

noActiveBoosts

The message displayed when there are no active boosts of the respective type.

boostStarted

The message displayed when a boost of the respective type is started. This can include placeholders such as %multiplier% and %duration%.

boostAddedToQueue

The message displayed when a boost of the respective type is added to the queue. This can include placeholders such as %multiplier% and %duration%.

boostStopped

The message displayed when a boost of the respective type is stopped.

boostQueueCleared

The message displayed when the queue for boosts of the respective type is cleared.

boostInfo

The message displayed to show information about the current boost of the respective type. This can include placeholders such as %multiplier%, %time_remaining%, and %duration%.

noQueuedBoosts

The message displayed when there are no queued boosts of the respective type.

Permissions Configuration

#Permission Configuration
[permissions]

  #Command Permissions
  [permissions.command]
    reload = "ALL_COMMANDS"
    clear_queues = "ALL_COMMANDS"
    check_queues = "ALL_COMMANDS"
    queue_priority = "ALL_COMMANDS"

    #Spawn Bucket Permissions
    [permissions.command.spawnBucket]
      bucket = "NONE"
      bucket_start = "ALL_COMMANDS"
      bucket_stop = "ALL_COMMANDS"
      bucket_status = "NONE"

    #Catch Permissions
    [permissions.command.catch]
      catch = "NONE"
      catch_start = "ALL_COMMANDS"
      catch_stop = "ALL_COMMANDS"
      catch_status = "NONE"

    #Experience Permissions
    [permissions.command.experience]
      experience = "NONE"
      experience_start = "ALL_COMMANDS"
      experience_stop = "ALL_COMMANDS"
      experience_status = "NONE"

    #Shiny Permissions
    [permissions.command.shiny]
      shiny = "NONE"
      shiny_start = "ALL_COMMANDS"
      shiny_stop = "ALL_COMMANDS"
      shiny_status = "NONE"

Command Permissions

Allowed Values:

NONE - No permission required to use the command.
SPAWN_PROTECTION_BYPASS - Requires the player to have the spawn protection bypass permission to use the command.
CHEAT_COMMANDS_AND_COMMAND_BLOCKS - Requires the player to have the cheat commands and command blocks permission to use the command.
MULTIPLAYER_MANAGEMENT - Requires the player to have the multiplayer management permission to use the command.
ALL_COMMANDS - Requires the player to have the all commands permission to use the command.

reload

The permission level required to use the /boosters reload command. This command reloads the booster services.

Default Value: ALL_COMMANDS

clear_queues

The permission level required to use the /boosters clear-queues command. This command clears all queued boosts.

Default Value: ALL_COMMANDS

check_queues

The permission level required to use the /boosters check-queues command. This command checks the status of all queued boosts.

Default Value: ALL_COMMANDS

queue_priority

The permission level required to use the /boosters queue-priority command. This command manages the queue priority settings.

Default Value: ALL_COMMANDS

Spawn Bucket Permissions

Permission levels required to use the /boosters bucket command and its subcommands. This command manages spawn bucket boosts.

bucket

The permission level required to use the /boosters bucket command. This command manages spawn bucket boosts.

Default Value: NONE

bucket_start

The permission level required to use the /boosters bucket start command. This command starts a spawn bucket boost.

Default Value: ALL_COMMANDS

bucket_stop

The permission level required to use the /boosters bucket stop command. This command stops a spawn bucket boost.

Default Value: ALL_COMMANDS

bucket_status

The permission level required to use the /boosters bucket status command. This command checks the status of a spawn bucket boost.

Default Value: NONE

Catch Permissions

The permission levels required to use the /boosters catch command and its subcommands. This command manages catch boosts.

catch

The permission level required to use the /boosters catch command. This command manages catch boosts.

Default Value: NONE

catch_start

The permission level required to use the /boosters catch start command. This command starts a catch boost.

Default Value: ALL_COMMANDS

catch_stop

The permission level required to use the /boosters catch stop command. This command stops a catch boost.

Default Value: ALL_COMMANDS

catch_status

The permission level required to use the /boosters catch status command. This command checks the status of a catch boost.

Default Value: NONE

Experience Permissions

The permission levels required to use the /boosters experience command and its subcommands. This command manages experience boosts.

experience

The permission level required to use the /boosters experience command. This command manages experience boosts.

Default Value: NONE

experience_start

The permission level required to use the /boosters experience start command. This command starts an experience boost.

Default Value: ALL_COMMANDS

experience_stop

The permission level required to use the /boosters experience stop command. This command stops an experience boost.

Default Value: ALL_COMMANDS

experience_status

The permission level required to use the /boosters experience status command. This command checks the status of an experience boost.

Default Value: NONE

Shiny Permissions

The permission levels required to use the /boosters shiny command and its subcommands. This command manages shiny boosts.

shiny

The permission level required to use the /boosters shiny command. This command manages shiny boosts.

Default Value: NONE

shiny_start

The permission level required to use the /boosters shiny start command. This command starts a shiny boost.

Default Value: ALL_COMMANDS

shiny_stop

The permission level required to use the /boosters shiny stop command. This command stops a shiny boost.

Default Value: ALL_COMMANDS

shiny_status

The permission level required to use the /boosters shiny status command. This command checks the status of a shiny boost.

Default Value: NONE

Webhooks Configuration

#Discord Webhooks Configuration
[discordWebhooks]
  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"

#Bucket Event Webhook Configuration
[bucketEvent]

  #Bucket Start Event
  [bucketEvent.bucketStart]
    title = "Spawn Bucket Event Started!"
    description = "A new Spawn Bucket Boost event has started! Here are the details:"
    embedColor = "BLUE"

  #Bucket End Event
  [bucketEvent.bucketEnd]
    title = "Spawn Bucket Event Ended!"
    description = "The %bucket% Spawn Bucket Boost event has ended!"
    embedColor = "BLUE"

#Catch Event Webhook Configuration
[catchEvent]

  #Catch Start Event
  [catchEvent.catchStart]
    title = "Catch Event Started!"
    description = "A new Catch Boost event has started! Here are the details:"
    embedColor = "PURPLE"

  #Catch End Event
  [catchEvent.catchEnd]
    title = "Catch Event Ended!"
    description = "The %multiplier%x Catch Boost event has ended!"
    embedColor = "PURPLE"

#Experience Event Webhook Configuration
[experienceEvent]

  #Experience Start Event
  [experienceEvent.experienceStart]
    title = "Experience Event Started!"
    description = "A new Experience Boost event has started! Here are the details:"
    embedColor = "GREEN"

  #Experience End Event
  [experienceEvent.experienceEnd]
    title = "Experience Event Ended!"
    description = "The %multiplier%x Experience Boost event has ended!"
    embedColor = "GREEN"

#Shiny Event Webhook Configuration
[shinyEvent]

  #Shiny Start Event
  [shinyEvent.shinyStart]
    title = "Shiny Event Started!"
    description = "A new Shiny Boost event has started! Here are the details:"
    embedColor = "GOLD"

  #Shiny End Event
  [shinyEvent.shinyEnd]
    title = "Shiny Event Ended!"
    description = "The %multiplier%x Shiny Boost event has ended!"
    embedColor = "GOLD"

Discord Webhooks Configuration

enabled

Enables or disables Discord webhooks for booster events. When enabled, the mod will send notifications to the specified Discord webhook URL for various booster events.

Default Value: false

webhookUrl

The Discord Webhook URL to send booster event notifications to. This should be a valid Discord webhook URL.

Default Value: DISCORD_WEBHOOK_URL_HERE

discordAuthorName

The name to display as the author of the Discord webhook messages. This is the name that will appear in the webhook message.

Default Value: Cobblemon Boosters

discordAuthorIconUrl

The URL of the icon to display as the author of the Discord webhook messages. This should be a valid URL to an image.

Default Value: https://raw.githubusercontent.com/Matthiesen-Dev/cobblemon-boosters/refs/heads/main/assets/logo.png

Bucket Event Webhook Configuration

Spawn Bucket Boost events can trigger Discord webhooks when they start and end. The configuration options for these events allow you to customize the messages sent to Discord.

Start Event

The configuration for the start of a Spawn Bucket Boost event includes the title, description, and embed color for the Discord webhook message.

title

The title of the Discord webhook message for the start of a Spawn Bucket Boost event.

Default Value: Spawn Bucket Event Started!

description

The description of the Discord webhook message for the start of a Spawn Bucket Boost event.

Default Value: A new Spawn Bucket Boost event has started! Here are the details:

embedColor

The color of the Discord webhook embed for the start of a Spawn Bucket Boost event. Allowed values include: RED, GREEN, BLUE, PURPLE, ORANGE, GOLD, GREY, DARK_RED, DARK_GREEN, DARK_BLUE, BLACK, WHITE.

Default Value: BLUE

End Event

The configuration for the end of a Spawn Bucket Boost event includes the title, description, and embed color for the Discord webhook message.

title

The title of the Discord webhook message for the end of a Spawn Bucket Boost event.

Default Value: Spawn Bucket Event Ended!

description

The description of the Discord webhook message for the end of a Spawn Bucket Boost event.

Default Value: The %bucket% Spawn Bucket Boost event has ended!

embedColor

The color of the Discord webhook embed for the end of a Spawn Bucket Boost event. Allowed values include: RED, GREEN, BLUE, PURPLE, ORANGE, GOLD, GREY, DARK_RED, DARK_GREEN, DARK_BLUE, BLACK, WHITE.

Default Value: BLUE

Catch Event Webhook Configuration

The Catch Boost events can trigger Discord webhooks when they start and end. The configuration options for these events allow you to customize the messages sent to Discord.

Start Event

The configuration for the start of a Catch Boost event includes the title, description, and embed color for the Discord webhook message.

title

The title of the Discord webhook message for the start of a Catch Boost event.

Default Value: Catch Event Started!

description

The description of the Discord webhook message for the start of a Catch Boost event.

Default Value: A new Catch Boost event has started! Here are the details:

embedColor

The color of the Discord webhook embed for the start of a Catch Boost event. Allowed values include: RED, GREEN, BLUE, PURPLE, ORANGE, GOLD, GREY, DARK_RED, DARK_GREEN, DARK_BLUE, BLACK, WHITE.

Default Value: PURPLE

End Event

The configuration for the end of a Catch Boost event includes the title, description, and embed color for the Discord webhook message.

title

The title of the Discord webhook message for the end of a Catch Boost event.

Default Value: Catch Event Ended!

description

The description of the Discord webhook message for the end of a Catch Boost event.

Default Value: The %multiplier%x Catch Boost event has ended!

embedColor

The color of the Discord webhook embed for the end of a Catch Boost event. Allowed values include: RED, GREEN, BLUE, PURPLE, ORANGE, GOLD, GREY, DARK_RED, DARK_GREEN, DARK_BLUE, BLACK, WHITE.

Default Value: PURPLE

Experience Event Webhook Configuration

The Experience Boost events can trigger Discord webhooks when they start and end. The configuration options for these events allow you to customize the messages sent to Discord.

Start Event

The configuration for the start of an Experience Boost event includes the title, description, and embed color for the Discord webhook message.

title

The title of the Discord webhook message for the start of an Experience Boost event.

Default Value: Experience Event Started!

description

The description of the Discord webhook message for the start of an Experience Boost event.

Default Value: A new Experience Boost event has started! Here are the details:

embedColor

The color of the Discord webhook embed for the start of an Experience Boost event. Allowed values include: RED, GREEN, BLUE, PURPLE, ORANGE, GOLD, GREY, DARK_RED, DARK_GREEN, DARK_BLUE, BLACK, WHITE.

Default Value: GREEN

End Event

The configuration for the end of an Experience Boost event includes the title, description, and embed color for the Discord webhook message.

title

The title of the Discord webhook message for the end of an Experience Boost event.

Default Value: Experience Event Ended!

description

The description of the Discord webhook message for the end of an Experience Boost event.

Default Value: The %multiplier%x Experience Boost event has ended!

embedColor

The color of the Discord webhook embed for the end of an Experience Boost event. Allowed values include: RED, GREEN, BLUE, PURPLE, ORANGE, GOLD, GREY, DARK_RED, DARK_GREEN, DARK_BLUE, BLACK, WHITE.

Default Value: GREEN

Shiny Event Webhook Configuration

The Shiny Boost events can trigger Discord webhooks when they start and end. The configuration options for these events allow you to customize the messages sent to Discord.

Start Event

The configuration for the start of a Shiny Boost event includes the title, description, and embed color for the Discord webhook message.

title

The title of the Discord webhook message for the start of a Shiny Boost event.

Default Value: Shiny Event Started!

description

The description of the Discord webhook message for the start of a Shiny Boost event.

Default Value: A new Shiny Boost event has started! Here are the details:

embedColor

The color of the Discord webhook embed for the start of a Shiny Boost event. Allowed values include: RED, GREEN, BLUE, PURPLE, ORANGE, GOLD, GREY, DARK_RED, DARK_GREEN, DARK_BLUE, BLACK, WHITE.

Default Value: GOLD

End Event

The configuration for the end of a Shiny Boost event includes the title, description, and embed color for the Discord webhook message.

title

The title of the Discord webhook message for the end of a Shiny Boost event.

Default Value: Shiny Event Ended!

description

The description of the Discord webhook message for the end of a Shiny Boost event.

Default Value: The %multiplier%x Shiny Boost event has ended!

embedColor

The color of the Discord webhook embed for the end of a Shiny Boost event. Allowed values include: RED, GREEN, BLUE, PURPLE, ORANGE, GOLD, GREY, DARK_RED, DARK_GREEN, DARK_BLUE, BLACK, WHITE.

Default Value: GOLD