Getting Started with YEmojis

This guide walks through installing YEmojis, configuring dependencies, and verifying chat sprite rendering.

Requirements

Before installing YEmojis, ensure your server environment meets these requirements:

• Java Version: Java 21 or higher.
• Server Software: Paper, Purpur, or Folia running Minecraft 1.21.11 and above (1.21.11+).
• Chat Plugins: LPC (Lightning Placeholders Chat) or any other v5 MiniMessage chat plugin.

Installation Steps

1. Download the Plugin: Obtain the latest YEmojis-1.0.0.jar build.
2. Install Soft Dependencies (Recommended):
   • Download ProtocolLib (5.3.0+) if you want packet-level 2D sprite previews inside Shulker Box hover tooltips.
   • Download PlaceholderAPI (2.11.5+) if you want country flags in tablists, scoreboards, or nametags.
3. Deploy JAR File: Place YEmojis.jar into your server's plugins/ folder.
4. Start or Restart Server: Launch your server to generate the default configuration files under plugins/YEmojis/.
5. Verify Startup: Check your console logs for the startup banner:

   [YEmojis] Enabling YEmojis v1.0.0
   [YEmojis] Loaded 1240 item sprites, 212 country flags, 45 mob heads.
   [YEmojis] Folia regional scheduler enabled.
   

Quick Verification

Join your server and test the following chat commands:

1. Test Item Sprites: Type :diamond_sword: or :elytra: in chat. The text will convert into a 2D item icon.
2. Test World Flags: Type :flag_us: or :flag_eg: to verify Base64 country head rendering.
3. Open the GUI Picker: Run /yemojis to open the Paper 1.21 Dialog menu or chest picker.
4. Test Gear Showcase: Hold an item in your main hand and type [item] in chat. Hover over the broadcast message to inspect the full Adventure tooltip.

Initial Configuration Checks

Open plugins/YEmojis/config.yml to verify key options:

# Menu format: "dialog" for Paper 1.21 native screens, or "chest" for 54-slot inventories
general:
  enabled: true
  menu-type: "dialog"

# Event priority for chat processing
chat:
  event-priority: "HIGHEST"
  case-insensitive: true
  max-emojis-per-message: 15

If you make changes to YAML files, run /yemojis reload to apply them instantly without restarting the server.