Creating Your First Crate

1. Use /sqca crate create <name> to create a new crate
2. Open the crate editor with /sqca editor and select your crate
3. Configure the crate settings:
   • Set display name, key name, and permissions
   • Choose between roll mode or direct selection
   • Configure reroll chances
4. Place the crate in the world:
   • In the editor, click "Place Crate"
   • Click on a block in the world to set it as the crate location
5. Add rewards to the crate:
   • In the editor, click "Edit Rewards"
   • Put items you want to add as rewards in your inventory
   • Click on these items to add them as rewards
   • Configure reward settings (display, commands, etc.)

Giving Keys to Players

• For virtual keys: /sqca give key <key_name> <player> <amount>
• For physical keys: Enable physical-items: true in config.yml and use the same command

# ╔════════════════════════════════════════════════════════╗
# ║             ░░ GENERAL PLUGIN SETTINGS ░░              ║
# ╚════════════════════════════════════════════════════════╝

plugin:
  # Language setting for messages (currently only 'en' is supported)
  language: "en"
  # Enable to check for plugin updates on startup
  check-updates: true

# Debug mode configuration
# - Set to true to enable detailed logging for troubleshooting
# - Set to false for normal operation (recommended)
debug: false

# ╔════════════════════════════════════════════════════════╗
# ║                 ░░ DATABASE SETTINGS ░░                ║
# ╚════════════════════════════════════════════════════════╝

database:
  # Enable database storage for virtual keys
  enabled: true
  # Database type (currently only 'sqlite' is supported)
  type: "sqlite"
  # Database file name
  file: "crates.db"

# ╔════════════════════════════════════════════════════════╗
# ║                   ░░ KEY SETTINGS ░░                   ║
# ╚════════════════════════════════════════════════════════╝

keys:
  # Set to true for physical key items, false for virtual keys
  physical-items: false
  # Material to use for physical key items
  key-material: "TRIPWIRE_HOOK"
  # Name format for keys (%key_name% will be replaced with the crate's key name)
  # Supports both traditional color codes (&6) and hex colors (#aaa8a8)
  key-name: "&6%key_name% Key"
  # Example with hex color: key-name: "#aaa8a8%key_name% Key"
  # Lore for key items (supports both traditional color codes and hex colors)
  key-lore:
    - "&7Use this to open a %crate_name% crate!"
    - "&eRight-click on the crate to begin."
    # Example with hex colors:
    # - "#aaa8a8Use this to open a %crate_name% crate!"
    # - "#ffd700Right-click on the crate to begin."

# ╔════════════════════════════════════════════════════════╗
# ║                  ░░ SOUND SETTINGS ░░                  ║
# ╚════════════════════════════════════════════════════════╝

sounds:
  # Sound played when opening a crate
  open: "BLOCK_CHEST_OPEN"
  # Sound played when claiming a reward
  claim: "ENTITY_PLAYER_LEVELUP"
  # Sound played when an error occurs
  error: "BLOCK_NOTE_BLOCK_BASS"

# ╔════════════════════════════════════════════════════════╗
# ║                   ░░ GUI SETTINGS ░░                   ║
# ╚════════════════════════════════════════════════════════╝

gui:
  # Number of rows in the crate GUI (1-6)
  # Waring: If you change this with active crates you will need to redo them.
  rows: 3
  # Default number of reroll chances for crates
  default-reroll-chances: 1
  # Filler item settings for empty slots
  filler:
    # Enable or disable filler items
    enabled: true
    # Material for filler items
    material: "GRAY_STAINED_GLASS_PANE"
    # Display name for filler items
    name: " "

# ╔════════════════════════════════════════════════════════╗
# ║                  ░░ CHAT SETTINGS ░░                   ║
# ╚════════════════════════════════════════════════════════╝

chat:
  # Chat prefix configuration
  prefix:
    # Enable or disable the chat prefix
    enabled: true
    # Text to use as prefix (supports color codes and hex colors like #aaa8a8)
    text: "&6[SqizleCrates]:"
    # Example with hex color: text: "#aaa8a8[SqizleCrates]:"

crate:
  name: "Example"
  display-name: "&eExample Crate"
  key: "Example Key"
  permission: ""
  key-required: true
  # Set to true to use the roll animation, false for direct selection
  roll-mode: true
  # Number of reroll chances for this crate (overrides default)
  reroll-chances: 2
  gui:
    title: "&eExample Crate Rewards"
    rows: 3
    filler:
      enabled: true
      material: "BLACK_STAINED_GLASS_PANE"
      name: " "
  sound:
    on-open: "BLOCK_ENDER_CHEST_OPEN"
    on-claim: "ENTITY_ENDER_DRAGON_GROWL"
  location:
    world: "world"
    x: 0
    y: 70
    z: 0
  rewards:
    reward1:
      slot: 10
      display:
        material: "DIAMOND"
        name: "&bDiamond Reward"
        lore:
          - "&7Win a diamond!"
      give:
        type: "item"
        item:
          material: "DIAMOND"
          amount: 1
    reward2:
      slot: 11
      display:
        material: "EXPERIENCE_BOTTLE"
        name: "&aXP Reward"
        lore:
          - "&7Get some XP!"
      give:
        type: "command"
        command: "xp add %player% 100"