Default config.yml

Shipped defaults from SoapsHungerStamina 1.1.6. After first run, this file lives in plugins/SoapsHungerStamina/.

Updating the jar does not overwrite your live copy. Use this page to compare or reset.

See also: Config Reference · Configuration

# SoapsHungerStamina main settings.
# Global rules, hunger, integration, engine, HUD, and combat context.
#
# Quick start:
# 1) Sprint, jump, attack, winded, and bed-rest in actions.yml
# 2) general.disabled-worlds
# 3) hunger.mode
# 4) integration.stamina-provider and recovery scales
# 5) ui.type
# 6) context.pvp-pve if you split PvP and PvE costs
#
# Intended loop: act, spend stamina, combat slows regen, empty taps hunger,
# then rest, food, or bed recovers.

# Bypass, debug, and world disable lists.
general:
  # Permission that skips stamina systems for a player.
  bypass-permission: "soapsstamina.bypass"
  # When true, operators skip stamina. New installs default false so OP testers feel the system.
  op-bypass: false
  # Skip stamina while flying in creative or spectator. Elytra is separate.
  ignore-flying: true
  # Extra console logging for tuning and support.
  debug: false
  disabled-worlds:
    # No stamina drain, regen, or stamina UI in these worlds.
    stamina: []
    # No encumbrance or weight drain rules in these worlds.
    weight: []


# Empty stamina and food.
# overflow: spend food after the stamina bar is empty.
# bar: the food bar shows stamina percent. Eating restores stamina.
# disabled: SHS does not change food or saturation.
hunger:
  mode: overflow
  # Food points lost per second while you keep exerting at empty stamina.
  drain-per-second: 0.28
  # Lowest food level overflow drain will leave.
  min-hunger: 0
  # Spend saturation before food on overflow drain.
  drain-saturation: true
  # Instant actions at empty stamina: leftover stamina demand times this ratio becomes food demand.
  overflow-to-food-ratio: 0.12


# Which RPG plugin stores the stamina bar, and how SHS recovery pairs with it.
# Install MMOCore and/or MythicRPG. SHS will not run without a working store.
#
# Recovery knobs that work together:
# - actions.yml sneak and idle regen
# - activity-regen-scale below
# - block-native-regen-while-active (MMOCore only)
# - weight.yml encumbrance regen multipliers
integration:
  # auto prefers MMOCore when both are present. Use mmocore or mythicrpg to force one store.
  stamina-provider: auto
  mmocore:
    # Use MMOCore combat state for combat regen and dodge rules. Falls back to context.in-combat.
    use-combat-state: true
    # Scales SHS sneak and idle regen. Lower this if resting feels too strong.
    activity-regen-scale: 0.9
    # Pause MMOCore STA_REGEN while sprinting, fighting, or otherwise busy.
    # Food, bed, and second wind grants still apply. No effect on MythicRPG.
    block-native-regen-while-active: true
  mythicrpg:
    # Reagent name from the Mythic pack reagents.yml. Case does not matter. Default Stamina.
    reagent: Stamina
  worldguard:
    # Registers the soaps-stamina region flag (default allow). Deny turns stamina off in a region.
    enabled: true


# How often the stamina engine runs.
engine:
  # Ticks between full player updates. 4 is about five times per second.
  tick-interval: 4
  # Max players processed per engine pass. 0 means everyone. Raise on very large servers.
  players-per-tick: 0
  # Movement distance that counts as "moving" for drain and regen rules.
  movement-threshold: 0.05
  # After taking damage, ignore movement for this many ms so knockback does not fake sprint.
  damage-movement-suppress-ms: 500
  # When true, floating in water blocks idle and sneak regen even if still.
  # When false, only swimming while moving blocks that regen.
  regen-block-idle-while-swimming: false


# Damage after empty stamina when the player keeps pushing.
# This is the hard stop after hunger overflow.
overexertion:
  enabled: true
  threshold: 40.0
  base-damage: 0.35
  scaling-enabled: true
  scaling-divisor: 10.0
  max-damage: 2.0
  recovery-rate: 7.0
  warning-threshold: 0.8


# Stamina HUD for players.
ui:
  # Master switch for action bar, boss bar, and chat stamina display.
  enabled: true
  # BOSS_BAR, ACTION_BAR, or CHAT. Format strings live in messages.yml.
  type: BOSS_BAR
  # Minimum stamina change before the HUD refreshes.
  update-threshold: 0.5
  # Minimum ms between HUD updates. CHAT also enforces a 1500 ms floor in code.
  message-cooldown: 40
  low-stamina-warning: true
  low-stamina-threshold: 25.0
  bar:
    # Used by %stamina_bar% and %shs_stamina_bar%.
    length: 10
    filled-char: "█"
    empty-char: "░"


# In-game admin settings menu (/shs gui).
gui:
  enabled: true


# Let players pick their own stamina display with /stamina display.
player-display-choice:
  enabled: true
  # One tip on first join about stamina and /stamina display.
  first-join-tip: true


# Combat context, rate limits, and new-player easing.
# When MMOCore combat state is on, that tag drives combat regen and dodge. duration-ms is the fallback.
context:
  pvp-pve:
    attack:
      pvp-multiplier: 1.0
      pve-multiplier: 1.0
    projectiles:
      pvp-multiplier: 1.0
      pve-multiplier: 1.0
    winded:
      pvp-multiplier: 1.0
      pve-multiplier: 1.0
    damage-intake:
      pvp-multiplier: 1.0
      pve-multiplier: 1.0
  in-combat:
    duration-ms: 4500
    regen-multiplier: 0.6
    allow-dodge: false
  rate-limits:
    jump:
      max-actions: 0
      window-ms: 2000
    dodge:
      max-actions: 3
      window-ms: 4000
    throwables:
      max-actions: 12
      window-ms: 2500
  # Lower drain for the first minutes after a player joins for the first time.
  new-players:
    enabled: true
    duration-minutes: 30
    drain-multiplier: 0.65