config.yml

Every season, display, health, inventory and integration option.

Full reference for plugins/RankedSMPX/config.yml. Defaults shown.

General

Key	Default	Meaning
`small-caps-messages`	`true`	Show messages in small caps
`message-prefix`	`false`	Put the prefix (from `messages.yml`) before messages
`titles`	`true`	Show title messages. `false` turns all off.
`debug`	`false`	Extra console logging

Season

season:
  rank-stealing:
    enabled: true
    max-rank-difference: 0   # 0 = no limit
    cooldown: 0              # seconds between steals
  inactivity:
    enabled: false
    after: 7d
    action: reroll
    check-interval: 30m
    exempt: []
  death-effects:
    lightning-on-kill: false
 
auto-assign-ranks:
  enabled: true

Inactivity

When enabled, a player offline longer than after loses their rank. It works while they are offline.

Key	Meaning
`after`	Time offline. Examples: `12h`, `3d`, `1d12h`.
`action`	`remove` frees the rank. `reroll` gives it to a random online player without a rank.
`check-interval`	How often to check
`exempt`	Names or UUIDs that never lose a rank

Time the server itself was down does not count.

Display

rank-display:
  show-in-chat: false
  show-on-join: true
  show-on-leave: true
  show-on-death: true
 
tab-integration:
  enabled: true

tab-integration uses the TAB plugin if installed, otherwise vanilla scoreboard teams. See Tab list.

Health

health:
  mode: MODIFIER
  apply-on-respawn: true
  aggressive:
    recheck-interval: 5
    remove-other-modifiers: true

Mode	Behavior
`MODIFIER`	Attribute modifier. Works alongside other plugins.
`DIRECT`	Sets base max health. Use if nothing else changes health.
`AGGRESSIVE`	Removes other health modifiers and re-checks on a timer. Only if another plugin keeps overriding health.

Potions

potions:
  extend-custom-effects: true
  ignored-effects: [DARKNESS, POISON, WITHER, HUNGER, WEAKNESS, SLOWNESS,
    MINING_FATIGUE, NAUSEA, BLINDNESS, INSTANT_DAMAGE, UNLUCK, BAD_OMEN,
    RAID_OMEN, LEVITATION]

extend-custom-effects also boosts effects from other plugins and custom items. ignored-effects are never boosted.

Extra inventory

inventory:
  enabled: true
  anti-dupe: true
  drop-on-death: true
  combat:
    disabled-during-combat: false
    combat-duration: 10

Slots per rank are in ranks.yml.

Rank transfer

rank-transfer:
  enabled: false
  allow-offline: false

Sounds

Four sounds, each with enabled, sound, volume, pitch:

Key	When	Default sound
`sounds.season-start`	Season starts	`ENTITY_ENDER_DRAGON_GROWL`
`sounds.rank-reveal`	A rank is revealed	`ENTITY_PLAYER_LEVELUP`
`sounds.rank-broadcast`	Rank announced in chat	`BLOCK_NOTE_BLOCK_PLING`
`sounds.season-stop`	Season stops	`ENTITY_WITHER_DEATH`

Integrations

luckperms:
  enabled: false
  register-contexts: true
  sync-on-rank-change: true
 
locator-bar:
  hide-players: true
 
bedrock:
  enabled: true

See LuckPerms and Bedrock. locator-bar.hide-players hides other players from everyone's locator bar (1.21.6+). The Dragon Egg carrier still shows when the locator is on.

Database

See Database.