Configuration

TextEffect keeps the public config intentionally small.

settings:
  enabled: true
  debug: false

# Resource pack settings.
# TextEffect generates a shader resource pack into:
# plugins/TextEffect/generated/TextEffect-Pack.zip
resource-pack:
  # Generate the TextEffect resource pack automatically when the server starts.
  # For most servers, manual generation with /texteffect zip is recommended.
  generate-on-startup: false

  # plugins/TextEffect/generated/debug/
  debug-dump-generated-files: false

  # Resource pack version profile.
  #
  # auto = detect from the server version.
  #
  # Supported profiles:
  # 1_21_0_1  = Minecraft 1.21 - 1.21.1
  # 1_21_2_3  = Minecraft 1.21.2 - 1.21.3
  # 1_21_4    = Minecraft 1.21.4
  # 1_21_5    = Minecraft 1.21.5
  # 1_21_6    = Minecraft 1.21.6
  # 1_21_7_8  = Minecraft 1.21.7 - 1.21.8
  # 1_21_9_10 = Minecraft 1.21.9 - 1.21.10
  # 1_21_11   = Minecraft 1.21.11
  version-profile: "auto"

  # Automatically send a hosted resource pack URL to players when they join.
  # This must be a direct download URL to the generated TextEffect-Pack.zip.
  send-on-join: false
  send-delay-ticks: 40
  resource-pack-url: ""

  # If true, Minecraft treats the pack as required.
  # Players who decline required server packs may be disconnected.
  required: false

  # Tracks whether players accepted, declined, loaded or failed the resource pack.
  # Only enable this if send-on-join is enabled.
  status-tracking:
    enabled: false
    log-to-console: true
    notify-player: true

shader:
  # game_time = animated effects
  # static = no animation, timeSeconds is always 0.0
  time-source: "game_time"

  # Global animation speed multiplier.
  #
  # 0.5 = half speed
  # 0.25 = very slow
  # 1.0 = default speed
  # 2.0 = double speed
  time-scale: 1.0

features:
  player-chat:
    enabled: false

    # If true, TextEffect will try to read LuckPerms prefix/suffix meta
    # and render it through TextEffect before the player's chat message.
    use-luckperms-prefix-suffix: true

    # Basic chat format used when player-chat is enabled.
    # Available placeholders:
    # {prefix}, {player}, {suffix}, {message}
    format: "{prefix}<white>{player}</white>{suffix} <dark_gray>»</dark_gray> {message}"

  signs:
    enabled: false
    require-permission: true

  books:
    enabled: false
    require-permission: true

  anvils:
    enabled: false
    require-permission: true

Release defaults

Player-facing features are disabled by default:

features:
  player-chat:
    enabled: false
  signs:
    enabled: false
  books:
    enabled: false
  anvils:
    enabled: false

This means TextEffect will not take over chat, signs, books or anvils until the server owner enables those features.