config.yml

Every option in config.yml explained, block by block, with its default value and what it changes on your server.

config.yml is the plugin's main settings file. It controls the language, the storage backend, the ability HUD, the activation controls, and the cosmetic side of abilities (particles and sounds). Edit it, then apply your changes with /ascend reload or a server restart.

ℹ️

All of the plugin's files update themselves: when you upgrade, new options are merged into your existing file without wiping your settings. The config-version line at the top is what makes that work, so never edit it by hand.

Both & color codes and &#rrggbb hex colors work in every message the plugin sends.

Language

Key	What it controls	Default
`language`	Which language file from the `lang/` folder is used (`english`, `french`, `german`, `spanish`). A bad or missing value falls back to `english`.	`english`

See Languages for how the language files work and how to edit them.

Metrics

Key	What it controls	Default
`metrics.enabled`	Anonymous usage statistics through bStats. Set to `false` to opt out; it is safe to disable.	`true`

Storage

Where player data is saved. SQLITE works out of the box with no setup; MYSQL lets you use a shared database server.

Key	What it controls	Default
`storage.type`	The storage backend: `SQLITE` or `MYSQL`.	`SQLITE`
`storage.mysql.host`	The MySQL server address.	`localhost`
`storage.mysql.port`	The MySQL server port.	`3306`
`storage.mysql.database`	The database name to use.	`ascendsmp`
`storage.mysql.username`	The database login name.	`root`
`storage.mysql.password`	The database login password.	(empty)
`storage.mysql.table-prefix`	Text added to the front of every table name, so several plugins can share one database.	`ascend_`
`storage.mysql.pool.max-pool-size`	The maximum number of open database connections.	`10`
`storage.mysql.pool.connection-timeout`	How long (in milliseconds) to wait for a connection before giving up.	`30000`

The MySQL settings only matter when storage.type is MYSQL. For a full walkthrough, see Storage.

HUD

The action bar display that shows your abilities, levels, and cooldowns.

Key	What it controls	Default
`hud.mode`	`persistent` always shows the ability bar; `on-change` only shows it briefly after activations.	`persistent`
`hud.icon-mode`	The icon style: `TEXT` (no resource pack), `VANILLA` (resource pack glyphs), or `ITEMSADDER`.	`TEXT`
`hud.refresh-ticks`	How often the action bar is refreshed, in server ticks (20 ticks = 1 second).	`10`
`hud.on-change-seconds`	In `on-change` mode, how many seconds the bar stays visible after an activation or level-up.	`4`

See HUD for the icon modes and resource pack setup.

Controls

How players trigger their abilities, and where ability use is blocked.

Key	What it controls	Default
`controls.swap-mode`	How the offhand-swap key (F by default) fires abilities. `always` means pressing it always casts (F for primary, Shift+F for secondary). `empty-offhand` means it only casts when your offhand is empty, so players can still swap items normally.	`always`
`controls.block-spectator`	Blocks ability use while in spectator mode.	`true`
`controls.block-creative`	Blocks ability use while in creative mode.	`false`
`controls.world-change-grace-seconds`	Seconds after changing worlds during which abilities are blocked, to avoid accidental casts.	`3`

Disabled worlds

Key	What it controls	Default
`disabled-worlds`	A list of worlds where abilities are turned off entirely. Use the exact world folder names.	`[]` (none)

disabled-worlds:
  - creative_world
  - lobby

Particles

Key	What it controls	Default
`particles.density-multiplier`	Scales how many particles each ring draws. Lower this on weaker servers.	`1.0`
`particles.ring-radius`	The radius of the activation ring drawn around the caster, in blocks.	`1.5`

Sounds

Key	What it controls	Default
`sounds.activate`	The sound played when an ability activates.	`block.beacon.activate`
`sounds.deny`	The sound played when a cast is denied (for example, still on cooldown).	`entity.villager.no`

These take Minecraft sound keys (resource names). An unknown key simply plays nothing, and leaving a value blank plays no sound at all.

💡

Balance numbers (cooldowns, damage, ranges) live in a separate file. See Balance (abilities.yml) for those, and Custom Recipes for crafting changes.

Questions? Ask on Discord: discord.arrowtan.cc.