Configuration

CocoVouchers uses multiple configuration files for flexibility and organization.

Main Configuration (config.yml)

prefix: "&8[&#08ACFBC&#07A8F5o&#07A3EFc&#069FE9o&#059BE3V&#0496DDo&#0492D6u&#038DD0c&#0289CAh&#0185C4e&#0180BEr&#007CB8s&8] &7»"

language-file: "messages_en.yml"

# Cooldown settings
cooldown:
  bypass-permission-enabled: true

database:
  enabled: true
  type: "sqlite"  # sqlite, mysql
  prefix: "cocovouchers_"
  mysql:
    host: "localhost"
    port: 3306
    database: "cocovouchers"
    username: "root"
    password: ""

config-version: 1

Configuration Options

prefix

The prefix used in all plugin messages. Supports hex colors!

prefix: "&8[&#08ACFBC&#07A8F5o&#07A3EFc&#069FE9o&#059BE3V&#0496DDo&#0492D6u&#038DD0c&#0289CAh&#0185C4e&#0180BEr&#007CB8s&8] &7»"

---

language-file

The language file to use from the locale/ folder.

language-file: "messages_en.yml"

---

cooldown

Cooldown system settings:

cooldown:
  bypass-permission-enabled: true

• bypass-permission-enabled - If true, players with cocovouchers.cooldown.bypass skip cooldowns

---

database

Database configuration for storing cooldown data:

database:
  enabled: true
  type: "sqlite"  # sqlite, mysql
  prefix: "cocovouchers_"

SQLite (Default):

• No additional configuration needed
• Data stored in plugins/CocoVouchers/data.db

MySQL:

database:
  enabled: true
  type: "mysql"
  prefix: "cocovouchers_"
  mysql:
    host: "localhost"
    port: 3306
    database: "cocovouchers"
    username: "root"
    password: "your_password"

---

Voucher Configuration

Each voucher is a separate YAML file in the vouchers/ folder.

Basic Structure

# Click type required (RIGHT, LEFT, SHIFT_RIGHT, SHIFT_LEFT)
click-type: "RIGHT"

# Unique voucher name
name: template

# Cooldown in seconds (0 = disabled)
cooldown: 60

# Confirmation settings
confirm:
  enabled: true
  timeout: 30

# Item appearance
item:
  material: "PAPER"
  name: "&6&lExample Voucher"
  custom-model-data: 1001
  max-stack: 64
  lore:
    - "&7Right-click to redeem!"
  enchantments:
    - "DURABILITY:1"
  hide-attributes: true

# Usage requirements
requirements:
  - "[PERMISSION] cocovouchers.use.example"

# Actions to execute
actions:
  - "[MESSAGE] &aYou redeemed the voucher!"
  - "[CONSOLE] give %player% diamond 64"

# Chance-based actions
chance-actions:
  - chance: 50
    actions:
      - "[MESSAGE] &eRare reward!"

# Random weighted actions
random-actions:
  - amount: 1
    actions:
      - "[MESSAGE] {10} Reward 1"
      - "[MESSAGE] {90} Reward 2"

# Custom messages
messages:
  success: "&aSuccessfully used!"
  failure: "&cCannot use this voucher!"

# Crafting recipe
crafting:
  enabled: false
  output-amount: 1
  permission: "cocovouchers.craft.template"
  shape:
    - "BAB"
    - "ABA"
    - "BAB"
  ingredients:
    A: "STONE"
    B: "AIR"

---

Item Configuration

Configure the voucher item appearance:

item:
  material: "PAPER"
  name: "&6&lVIP Voucher"
  custom-model-data: 1001
  max-stack: 64
  lore:
    - "&7Click to claim VIP rank!"
    - ""
    - "&eRewards:"
    - "&7• VIP Rank"
    - "&7• 1000 Coins"
  enchantments:
    - "DURABILITY:1"
    - "MENDING:1"
  hide-attributes: true

Option	Description
material	Bukkit material name
name	Display name with colors
custom-model-data	For resource packs
max-stack	Maximum stack size (1-64)
lore	Item lore lines
enchantments	List of ENCHANT:LEVEL
hide-attributes	Hide item flags

---

Click Types

Configure which click activates the voucher:

Type	Description
RIGHT	Right-click
LEFT	Left-click
SHIFT_RIGHT	Shift + Right-click
SHIFT_LEFT	Shift + Left-click

click-type: "RIGHT"

---

Confirmation System

Require double-click to prevent accidental use:

confirm:
  enabled: true
  timeout: 30

• enabled - Require confirmation click
• timeout - Seconds to click again before timeout

---

Color Codes

CocoVouchers supports:

Legacy Codes: &a, &b, &c, etc.

Hex Colors: &#RRGGBB or &#RGB

Gradient Example:

&#FF0000H&#FF4400e&#FF8800l&#FFCC00l&#FFFF00o