YEmojis Documentation

YEmojis is a native chat enhancement and visual item rendering plugin built for Paper, Purpur, and Folia 1.21+ servers. It renders over 1,200 vanilla 2D item and block sprites, 212 sovereign country and territory flags, dynamic player heads, and interactive gear showcases directly in chat without requiring client-side mods or resource pack downloads.

Supported Platforms

• Minecraft Version: Paper 1.21.11 and above (1.21.11+)
• Server Engines: Paper, Purpur, Folia (native regional scheduler support)
• Chat Plugins: LPC (Lightning Placeholders Chat) or any other v5 MiniMessage chat plugin
• Client Compatibility: 100% Vanilla Minecraft clients (no resource packs or OptiFine required)
• Dependencies:
  • ProtocolLib (Optional: Enables packet-level Shulker Box inventory hover previews)
  • PlaceholderAPI (Optional: Enables IP-based country flag expansion placeholders)

Core Capabilities

• 1,200+ Native Item Sprites: Type standard vanilla names like :diamond_sword:, :golden_apple:, or :elytra: to insert 2D item graphics directly into chat lines and hover cards.
• 212 World & Territory Flags: Complete country flag heads (USA, Egypt, Saudi Arabia, UK, France, Germany, Japan, Brazil, Palestine, Canada, and more) stored as permanent Base64 head textures with zero external API calls or Mojang rate limits.
• Interactive Gear Showcase: Let players broadcast held items ([item], [hand]), equipped armor sets ([armor]), or inventory summaries ([inv]) with full Adventure MiniMessage hover tooltips showing enchantments, trims, and durability.
• Shulker Box Sprite Previews: Hovering over Shulker Boxes in inventories, chests, or chat displays an organized 2D sprite grid of stored contents.
• Paper 1.21 Dialog GUI Picker: A responsive, zero-latency 48-item Dialog picker with category tabs, pagination, and click-to-insert chat shortcuts. Also includes a classic 54-slot chest menu fallback.
• Signs & Anvils Support: Parse emoji tags when placing signs or renaming gear in anvils.
• GeoIP Flag Integration: Automatically detect player countries by IP and expose %yemoji_country_flag%, %yemoji_country_code%, and %yemoji_country_name% placeholders.

Documentation Structure

• Start Here:
  • Getting Started: Installation steps, dependencies, and initial configuration.
  • Troubleshooting: Listener priorities, ProtocolLib packet handling, and FAQ.
• Features:
  • Item Sprites & World Flags: Catalog of item sprites, flags, mob heads, and custom smileys.
  • Item, Armor & Inventory Showcase: Gear broadcasts, hand shortcuts, and interactive hover cards.
  • Shulker Box 2D Sprite Previews: Packet-level tooltip rewriting and quantity format styles.
  • Paper 1.21 Dialog Picker: High-density GUI browser, live search, and chest mode.
  • Signs & Anvils Integration: Placing emojis on signboards and custom item renames.
• Configuration:
  • Configuration Reference: Full breakdown of config.yml, aliases.yml, and custom_emojis.yml.
  • Commands & Permissions: Command syntax, permission node hierarchy, and PlaceholderAPI reference.