Skip to main content

Streaks Module

Streak Mechanics​

  • Each player’s streak count increments by 1 upon each kill.
  • When a player dies, if their streak ≥ minimum-streak-death-to-be-notified, a notification is broadcast to other players.
  • If reset-streak-on-log-out is true, the streak resets to zero when the player logs out; if false, the streak persists across sessions.
  • streaks-rewards mappings trigger when a player reaches exactly the specified kill count, executing configured broadcast and actions.

Features​

  • Broadcast notifications at configurable streak thresholds
  • Optional streak reset on player logout
  • Define rewards (broadcast and actions) per streak count

Configuration Reference​

KeyTypeDefaultDescription
enabledbooleantrueEnable or disable the streaks module
minimum-streak-death-to-be-notifiednumber5Minimum streak count at death to trigger a notification
reset-streak-on-log-outbooleantrueReset streak count when a player logs out
streaks-rewardsobjectMap of streak counts to reward definitions (broadcast, actions[])

Example​

settings.yml
streaks:
  enabled: true
  minimum-streak-death-to-be-notified: 5
  reset-streak-on-log-out: true
  streaks-rewards:
    2:
      broadcast: true
      actions:
        - "chat: %player_name% is on a 2-kill streak!"
    5:
      broadcast: true
      actions:
        - "chat: %player_name% is on a 5-kill streak!"