⚙ Configuration

The main configuration file is config.yml in the plugin's data folder.

---

Complete config.yml Reference

# Prefix for all plugin messages
# Set to "" to disable the prefix
prefix: "&8[&6CustomAchievements1653&8] &r"

# Language setting
# Available: en_US, de_DE, nl_NL, es_ES, fr_FR, pt_BR, ar_SA,
#            cs_CZ, tr_TR, pl_PL, ru_RU, it_IT, ko_KR, hu_HU,
#            ja_JP, zh_CN, vi_VN, sv_SE, sk_SK, hi_IN, id_ID
# You can also create custom language files in the lang/ folder.
language: en_US

# Message format system
# MINI_MESSAGE: Uses MiniMessage tags like <red>, <green>, <gold>
# LEGACY: Uses legacy color codes like &a, &c, &6, &#RRGGBB
message-format: LEGACY

# Database settings
database:
  type: SQLITE       # SQLITE or MYSQL
  mysql:
    host: localhost
    port: 3306
    database: customachievements
    username: root
    password: ""
    pool:
      maximum-pool-size: 10
      minimum-idle: 2
      connection-timeout: 30000
      idle-timeout: 600000
      max-lifetime: 1800000

# Auto-save interval in minutes
auto-save-interval: 5

# Toast notification settings
toast:
  enabled: true
  default-frame: TASK   # TASK, GOAL, CHALLENGE

# BossBar settings
bossbar:
  enabled: true
  duration: 5           # Duration in seconds
  color: GREEN          # PINK, BLUE, RED, GREEN, YELLOW, PURPLE, WHITE
  style: SOLID          # SOLID, SEGMENTED_6, SEGMENTED_10, SEGMENTED_12, SEGMENTED_20

# ActionBar settings
actionbar:
  enabled: true
  duration: 3           # Duration in seconds

# Chat notifications
chat:
  broadcast-completion: true       # Broadcast when someone completes an advancement
  show-progress-updates: true      # Show progress updates to the player
  progress-notify-interval: 0      # Fixed interval: notify every N progress steps (0 = use percent)
  progress-notify-percent: 10      # Percentage interval: notify every N% (milestones 25/50/75/90% always shown)

# Movement settings
movement:
  sprint-counts-as-walk: true      # Sprinting also counts for WALK_DISTANCE
  sneak-counts-as-walk: true       # Sneaking also counts for WALK_DISTANCE

# Title settings for completion
title:
  enabled: true
  fade-in: 10           # Ticks
  stay: 70              # Ticks
  fade-out: 20          # Ticks

# Sound settings
sound:
  completion-sound: ENTITY_PLAYER_LEVELUP
  progress-sound: ENTITY_EXPERIENCE_ORB_PICKUP
  completion-volume: 1.0
  completion-pitch: 1.0
  progress-volume: 0.5
  progress-pitch: 1.2

# Effects on completion
effects:
  enabled: true
  firework: true
  particles: true
  particle-type: TOTEM_OF_UNDYING
  particle-count: 50

# Performance settings
performance:
  distance-check-interval: 10     # Ticks (20 = 1 second)
  time-check-interval: 20         # Ticks
  cache-player-data: true

# Debug mode
debug: false

---

Configuration Sections Explained

Prefix

The prefix appears before every plugin message. You can change the color or set it to an empty string to disable it completely.

Language

Choose from 21 built in languages or create your own custom file in the lang/ folder. See Language System for details.

Message Format

Choose between LEGACY (traditional &a color codes) and MINI_MESSAGE (modern <red> tags with gradients and more).

Database

Choose between SQLite (local file) and MySQL (remote server). SQLite is recommended for single servers. MySQL is recommended for networks. See Database for details.

Toast / BossBar / ActionBar / Title

Control how advancement progress and completion is displayed to players. Each can be globally enabled or disabled. Individual advancements can also override these settings with per-advancement toggles, and even set custom text, colors, and duration for ActionBar and BossBar per advancement.

Chat / Progress Notifications

Control when progress messages are shown. The progress-notify-interval and progress-notify-percent settings prevent spam for high-target advancements. Milestones at 25%, 50%, 75%, and 90% are always shown regardless of interval.

Movement

Configure whether sprinting and sneaking count towards WALK_DISTANCE advancements.

Sound / Effects

Configure the sounds and visual effects that play when a player completes an advancement. Per-advancement progress sounds can also be configured. See Rewards for per-advancement overrides.

Performance

Fine tune how often distance based and time based triggers are checked. Lower intervals mean more frequent checks (more precise but slightly more CPU usage).

---

Config Migration

When updating the plugin, new config options are automatically added to your existing config.yml without overwriting your current settings. The same applies to language files.

---