Configuration Reference

This page provides an annotated breakdown of all configuration files generated in plugins/YEmojis/.

config.yml

# ==============================================================================
#                                YEmojis Configuration
# ==============================================================================

# General settings
general:
  enabled: true
  # "dialog" (Native Paper 1.21 Dialog) or "chest" (54-slot inventory)
  menu-type: "dialog"

# Chat Processing Settings
chat:
  # Event priority for Paper AsyncChatEvent listener
  # Options: LOWEST, LOW, NORMAL, HIGH, HIGHEST, MONITOR
  event-priority: "HIGHEST"

  # Match emoji codes case-insensitively (:COW:, :Cow:, and :cow: all match)
  case-insensitive: true

  # Maximum emojis allowed per single chat message (0 = unlimited)
  max-emojis-per-message: 15

  # Action when a player exceeds max-emojis-per-message:
  # TRUNCATE = converts up to the limit and leaves remainder as text
  # CANCEL = prevents sending the message entirely
  limit-action: "TRUNCATE"

  # MiniMessage hover tooltips on chat icons
  hover-tooltips:
    enabled: true
    item-format: "<yellow><display_name></yellow><newline><gray>Minecraft Item</gray>"
    mob-format: "<aqua><display_name></aqua><newline><gray>Mob Head</gray>"
    flag-format: "<green><display_name></green><newline><gray>Country Flag</gray>"
    emoji-format: "<light_purple><display_name></light_purple><newline><gray>Chat Emoji</gray>"
    player-format: "<gold><player_name>'s Head</gold><newline><gray>Player Skin</gray>"

# Item & Gear Showcase Settings ([item], [hand], [armor], [inv])
showcase:
  enabled: true
  cooldown-seconds: 3
  empty-hand-text: "<gray>[Empty Hand]</gray>"
  empty-offhand-text: "<gray>[Empty Offhand]</gray>"
  empty-armor-text: "<gray>[No Armor]</gray>"

# Shulker Box 2D Sprite Tooltips
shulker-previews:
  enabled: true
  inventory-tooltips: true  # Packet rewriting in inventories (requires ProtocolLib)
  chat-showcase: true       # Sprite grid during [item] chat showcase
  hide-vanilla-lore: true   # Hide vanilla plain text item listing
  quantity-style: "subscript" # "subscript", "superscript", "badge", "classic", "none"
  items-per-row: 9
  header: "<gray><!italic>Contents:</gray>"

# Automatic IP-based Country Detection
geoip:
  enabled: true
  fallback-country: "US"
  cache-results: true

# Extra Feature Toggles
features:
  signs: true   # Parse :emojis: on placed and edited signs
  anvils: true  # Parse :emojis: when renaming items in anvils

# Category Switches
categories:
  items: true        # 1,200+ vanilla items & blocks
  mobs: true         # Animal & monster heads
  flags: true        # 212 world country flags
  smileys: true      # Standard chat smileys
  custom: true       # Custom definitions in custom_emojis.yml
  player-heads: true # Dynamic player skin heads (:<player>:)

custom_emojis.yml

Define server-specific emojis and custom Unicode characters:

# ==============================================================================
#                            Custom Emojis Configuration
# ==============================================================================

emojis:
  coin:
    shortcut: ":coin:"
    replacement: "🪙"
    display-name: "<gold>Gold Coin</gold>"
    category: "custom"
    permission: "yemojis.use.custom.coin"

  verified:
    shortcut: ":verified:"
    replacement: "✔"
    display-name: "<aqua>Verified Staff</aqua>"
    category: "custom"
    permission: "yemojis.use.custom.verified"

aliases.yml

Configure custom shortcut aliases for existing vanilla items and flags:

aliases:
  gapple: "golden_apple"
  egapple: "enchanted_golden_apple"
  totem: "totem_of_undying"
  dsword: "diamond_sword"
  nchest: "netherite_chestplate"
  ely: "elytra"