Skip to main content

config.yml

This page documents the main config.yml sections included with FioAchievements.

settings

KeyDefaultDescription
languageenLoads lang/lang_<key>.yml.
timezoneAsia/JakartaJava ZoneId used by date placeholders and time checks.
debugfalseEnables extra console warnings.

categoryAlias

Maps achievement category folder ids to menu-facing names.

Default categories:

  • survive
  • mining
  • farming
  • hunting
  • exploration
  • building
  • fishing
  • enchanting
  • nether
  • community

vanillaOptions

KeyDefaultDescription
shouldWeDisableVanillafalseBlocks vanilla achievements when enabled.
shouldWeRespectVanillaAchievementstrueMakes FioAchievements respect Minecraft's default achievements.
shouldWeDisableAdvancementMsgfalseDisables vanilla advancement chat messages.

number-format

Controls short number formatting for placeholders and menus.

KeyDefaultDescription
enabledtrueEnables compact suffixes.
decimals1Decimal digits for compact values.
trim-zero-decimaltrueShows 1k instead of 1.0k.
suffixes.thousandkSuffix for thousands.
suffixes.millionsmSuffix for millions.

progress-bar

Controls %fioachievements_achievements_<category>_progress_bar%.

KeyDefaultDescription
length30Number of rendered symbols.
symbolconfigured block symbolSymbol used for each segment.
complete-color<green>Color for completed progress.
remaining-color<gray>Color for remaining progress.
reset-afterfalseAppends <reset> after the bar.

database

KeyDefaultDescription
typeSQLITEStorage driver. Supports SQLITE and MYSQL.
sqlite-fileplayer_data.dbSQLite database file.
mysql.hostlocalhostMySQL host.
mysql.port3306MySQL port.
mysql.databaseminecraftMySQL schema/database.
mysql.usernamerootMySQL username.
mysql.passwordemptyMySQL password.
mysql.use-sslfalseEnables SSL in the JDBC URL.
mysql.table-prefixfioach_Prefix for FioAchievements tables.

achievements

KeyDefaultDescription
enabledtrueMaster toggle for all progress tracking.
short_logging_achievementsfalseHides per-file startup status lines.
category-default-enabledtrueDefault category state for generators and metadata.
skip-disabled-categoriestrueSkips disabled categories during loading.
id-format%category%:%id%Loaded achievement id format.
otherUniqueAchievements.enable-seasonal-achievementstrueShows seasonal achievement menus.
otherUniqueAchievements.enable-exclusive-achievementstrueShows exclusive achievement menus.

progress

KeyDefaultDescription
save-interval-seconds60Autosave interval.
save-on-quittrueSaves progress when a player leaves.
save-on-disabletrueSaves cached progress during shutdown.
trackers.jointrueTracks join achievements.
trackers.block-breaktrueTracks block break achievements.
trackers.mob-killtrueTracks mob kill achievements.
trackers.player-killtrueTracks player kill achievements.
trackers.walktrueTracks walk achievements.
walk.interval-ticks20Movement sample interval.
walk.max-distance-per-sample12Large movement jump clamp.
walk.count-world-changefalseCounts world changes as walk progress.

world

world.whitelist and world.blacklist control where progress can happen. Entries can be global world names or scoped to one achievement id:

world:
whitelist:
- "world"
- "event_world[survive:survive_example_1]"

regions

regions.whitelist and regions.blacklist work like world filters, but compare against region placeholder outputs.

completion

KeyDefaultDescription
date-formatdd/mmm/yy hh:mm aFormat used by completion date placeholders.
prevent-duplicate-completiontruePrevents completed achievements from completing again.
set-progress-to-required-on-unlocktrueAdmin unlock sets progress to required amount.
broadcast-enabledtrueAllows achievement broadcast messages.
reward-commands-enabledtrueAllows reward commands.
reward-commands-run-as-consoletrueRuns reward commands from console instead of player.
execute-rewards-on-admin-setfalseRuns normal rewards when admin sets an achievement unlocked.

bedrock

KeyDefaultDescription
enabledtrueEnables Bedrock player detection support.
geyser-prefix.Fallback Bedrock name prefix.

performance

KeyDefaultDescription
cache-player-progresstrueKeeps player progress in memory.
async-database-workertrueUses a dedicated database worker thread.
batch-save-on-disabletrueFlushes cached data together on shutdown.
autosave-enabledtrueRuns periodic autosaves.
reduce-move-event-worktrueKeeps movement tracking lightweight.