Skip to main content

Configuration

Main Config

config.yml controls global behavior.

OptionDescription
languageMessage and generated config language.
max-levelGlobal maximum upgrade level.
upgrade-cooldownCooldown in seconds between upgrade attempts.
storage.typePlayer data storage backend.
name-suffix.enabledWhether upgraded items receive a visible level suffix.
name-suffix.formatText format appended to the item name.
name-suffix.repeat-symbolSymbol used by {symbol} and {stars} placeholders.

Storage

storage:
type: FILE

Supported values:

ValueBehavior
FILEStores player data in local YAML files.
SQLITEStores player data in a local SQLite database.
DATABASEUses the shared MySQL or MariaDB settings from database.yml.
MYSQL / MARIADBAccepted as compatibility aliases for DATABASE.

Use database.yml when using a shared database backend.

Name Suffix

name-suffix:
enabled: true
format: " &e[+{level}]"
repeat-symbol: "★"

Supported placeholders:

PlaceholderMeaning
{level}Current upgrade level.
{count}Current upgrade level.
{symbol}The configured repeat-symbol.
{stars}repeat-symbol repeated by level.

Failure Penalty

failure-penalty:
enabled: true
level-drop-threshold: 5
level-drop-amount: 1
item-destruction:
enabled: false
destruction-threshold: 8
destruction-chance: 0.3

When enabled, failed upgrades can drop levels after the configured threshold. Optional item destruction can be enabled for high-risk upgrade ranges.

Feedback

failure-feedback controls title feedback after failure.

feedback-sounds controls success, failure, level-drop, and item-destroyed sounds. Sound names support Bukkit enum names and namespaced custom sound keys:

feedback-sounds:
success:
enabled: true
name: "ENTITY_PLAYER_LEVELUP"
volume: 1.0
pitch: 1.0

MMOItems Native Upgrade Compatibility

mmoitems-upgrade-compat:
enabled: false
native-upgrade-coexist: false
use-item-max-level: true
stat-source: TEMPLATE

This section controls compatibility with MMOItems' native upgrade data.

OptionDescription
enabledUses MMOItems UpgradeTemplate behavior when enabled.
native-upgrade-coexistKeeps MMOItems native upgrade and plugin upgrade as separate systems when enabled.
use-item-max-levelUses the item's own MMOItems max-level data when available.
stat-sourceTEMPLATE uses MMOItems templates; PLUGIN uses contents/upgrade-gains/ while syncing level data.

Keep this disabled when you want MMOitemsUpgrade to be the primary upgrade system and only use its configured gains.