Skip to content

config.yml

config.yml

The main configuration file. Located at plugins/BKGradients/config.yml. Apply changes with /bkg reload — no restart required.

`gui`

gui:
  states:
    enabled:  "<gradient:#55FF55:#00AA00>✔ Enabled</gradient>"
    disabled: "<gradient:#FF5555:#AA0000>✘ Disabled</gradient>"

MiniMessage text shown on style toggle buttons. Edit to match your language or style.

`command-aliases`

command-aliases:
  - bkg
  - bkgrad
  - gradients

Additional aliases for /bkgradients. Changes take effect on reload.

`database`

database:
  type: SQLITE   # SQLITE or MYSQL

  sqlite:
    file: data.db

  mysql:
    host: localhost
    port: 3306
    database: bkgradients
    username: root
    password: ""
    pool:
      maximum-pool-size: 10
      minimum-idle: 2
      connection-timeout: 30000
      idle-timeout: 600000
      max-lifetime: 1800000

`modules`

modules:
  prefix:
    enabled: true
    default:
      text:   "Player"
      color1: "#A855F7"
      color2: "#EC4899"
    validation:
      min-length: 1
      max-length: 16
      allowed-characters: "^[a-zA-Z0-9 _\\-\\[\\]\\(\\)]+$"
      blacklist:
        - "admin"
        - "mod"
        - "owner"
    cooldown:
      enabled: true
      time: 300        # seconds between saves
    history-size: 10   # entries stored per player

  nick:
    enabled: true
    default:
      color1: "#FFFFFF"
      color2: "#FFFFFF"
    # validation and cooldown use the same structure as prefix

  suffix:
    enabled: true
    # same structure as prefix

  tags:
    enabled: true
    history-size: 10
    max-favourites: 9

Key	Description
`enabled`	Disables the module without deleting player data
`allowed-characters`	Java regex — default allows A–Z, a–z, 0–9, spaces, `_`, `-`, `[]`, `()`
`bypass` permission	Skips blacklist and regex — does not bypass length limits
`history-size`	Past cosmetics stored per player per module

`sounds`

sounds:
  open:    { enabled: true, name: BLOCK_CHEST_OPEN,      volume: 0.6, pitch: 1.2 }
  close:   { enabled: true, name: BLOCK_CHEST_CLOSE,     volume: 0.6, pitch: 1.2 }
  click:   { enabled: true, name: UI_BUTTON_CLICK,       volume: 1.0, pitch: 1.0 }
  toggle:  { enabled: true, name: UI_BUTTON_CLICK,       volume: 1.0, pitch: 2.0 }
  success: { enabled: true, name: ENTITY_PLAYER_LEVELUP, volume: 1.0, pitch: 2.0 }
  error:   { enabled: true, name: BLOCK_NOTE_BLOCK_BASS, volume: 1.0, pitch: 0.5 }
  cancel:  { enabled: true, name: UI_TOAST_OUT,          volume: 1.0, pitch: 1.0 }

Set enabled: false on any key to silence that specific UI action.

`input`

input:
  timeout-seconds: 30
  cancel-keyword: "cancel"
  cancel-button:
    text:    " <bold><#FF0040>[CANCEL]"
    hover:   "<gray>Click to cancel editing"
    command: "/prefix cancel"
  text:
    title:    "<#D500F9>Pʀᴇꜰɪx Eᴅɪᴛɪɴɢ"
    subtitle: "<gray>Type your new prefix in chat"
  color:
    title:    "<#00FF88>Cᴏʟᴏʀ Eᴅɪᴛɪɴɢ"
    subtitle: "<gray>Type a HEX code or color name"

`colors` — HEX aliases

colors:
  rose:      "#FF007F"
  sky:       "#87CEEB"
  mint:      "#98FF98"
  lavender:  "#E6E6FA"
  coral:     "#FF7F50"
  turquoise: "#40E0D0"
  violet:    "#EE82EE"
  amber:     "#FFBF00"
  emerald:   "#50C878"

Players can type these names instead of a full HEX code during color prompts. Add as many custom aliases as needed.