Text Formatting - ZeroG-Network/NeoEssentials GitHub Wiki

Complete text formatting guide for NeoEssentials v1.0.1.89+ including animation-optimized colors and gradient effects.

NeoEssentials supports multiple color formats for maximum flexibility:

# Perfect for smooth animations
&#FF0000  # Pure Red
&#00FF00  # Pure Green  
&#0066CC  # Professional Blue
&#FF6B35  # Vibrant Orange
&#7B2CBF  # Rich Purple

Create seamless color transitions:

animations:
  smooth_gradient:
    interval: 30
    frames:
      - "&#FF0000G&#FF3300r&#FF6600a&#FF9900d&#FFCC00i&#FFFF00e&#CCFF00n&#99FF00t"
      - "&#FF3300G&#FF6600r&#FF9900a&#FFCC00d&#FFFF00i&#CCFF00e&#99FF00n&#66FF00t"
      - "&#FF6600G&#FF9900r&#FFCC00a&#FFFF00d&#CCFF00i&#99FF00e&#66FF00n&#33FF00t"

NeoEssentials supports hex color codes for precise color control:

&#RRGGBB

Examples:

• &#ff0000 - Pure red
• &#00ff00 - Pure green
• &#0000ff - Pure blue
• &#ff00ff - Magenta
• &#123456 - Custom shade

Create smooth color transitions:

{gradient:#start_color:#end_color}Your Text Here{/gradient}

Example:

{gradient:#ff0000:#0000ff}Welcome to the server!{/gradient}

This creates a smooth transition from red to blue across the text.

Create animated rainbow text:

{rainbow:speed}Your Text Here{/rainbow}

The speed parameter is optional (1-10, default is 5).

Example:

{rainbow:3}Welcome to the server!{/rainbow}

Create text that changes color over time:

{animate:#color1:#color2:#color3}Your Text Here{/animate}

Example:

{animate:#ff0000:#00ff00:#0000ff}Welcome to the server!{/animate}

NeoEssentials allows you to create reusable format templates in config/neoessentials/formats.toml:

[formats]
warning = "&c&l[WARNING] &r&c"
info = "&b&l[INFO] &r&b"
success = "&a&l[SUCCESS] &r&a"
error = "&4&l[ERROR] &r&c"
staff = "&5&l[STAFF] &r&d"

These can then be used in any message by using:

{format:warning}This is a warning message!

You can use all formatting options in any NeoEssentials configuration file:

[messages]
welcome = "{gradient:#00aaff:#ff00aa}Welcome to the server, {player}!{/gradient}"
goodbye = "&cGoodbye, &e{player}&c! We hope to see you again soon!"

[tablist]
header = """
&6&l===== {gradient:#ffaa00:#ff5500}YOUR SERVER NAME{/gradient} &6&l=====
&eWelcome, &b{player}&e!
"""
footer = """
&7Players online: &a{online_players}&7/&a{max_players}
&7Website: &b&nwww.yourserver.com
"""

NeoEssentials provides special character codes:

Control text alignment in multi-line messages:

{center}This text will be centered{/center}
{right}This text will be right-aligned{/right}
{left}This text will be left-aligned{/left}

Display different text based on conditions:

{if:condition}Text if true{else}Text if false{/if}

Available conditions:

• {if:permission:neoessentials.vip}VIP Content{else}Regular Content{/if}
• {if:group:admin}Admin Content{else}Regular Content{/if}
• {if:online:playername}Online{else}Offline{/if}

Create interactive text:

{hover:text:Hover text here}Text to hover over{/hover}
{click:command:/say Hello}Click to run command{/click}
{click:suggest:/msg }Click to suggest command{/click}
{click:url:https://example.com}Click to open URL{/click}

You can combine hover and click events:

{hover:text:Click to visit our website}{click:url:https://example.com}Visit our website{/click}{/hover}

Insert dynamic content with placeholders:

You have {balance} coins.
Server time: {server_time:HH:mm:ss}
Your coordinates: {x}, {y}, {z}

See the Placeholders guide for all available placeholders.

1. Readability: Don't overuse formatting; keep text readable
2. Consistency: Maintain consistent formatting across your server
3. Color Meaning: Use colors consistently for specific types of messages
   • Green for success/confirmation
   • Red for errors/warnings
   • Blue/Aqua for information
   • Gold/Yellow for important notes
4. Accessibility: Ensure text remains readable for all players
5. Performance: Avoid excessive animation in frequently updated text

{gradient:#00aaff:#ff00aa}&l=== Welcome to the Server ==={/gradient}
&eHello, &b{player}&e! We're glad to have you here!

&7» &aPlayers online: &f{online_players}/{max_players}
&7» &aServer TPS: &f{tps}

{center}&6Type &f/help &6for a list of commands{/center}

{format:staff}&l=== ANNOUNCEMENT ===
{hover:text:Sent by {staff_member}}{animate:#ff0000:#ff7700:#ffff00}{message}{/animate}{/hover}
&7» Click to acknowledge: {click:command:/acknowledge}[✓]{/click}

&l&9Server Rules
&r&c1. No griefing
&c2. Be respectful
&c3. No cheating
&c4. Have fun!

• Formatting Not Working: Ensure you're using the correct syntax and valid color codes
• Missing Placeholders: Check that placeholders are spelled correctly and available
• Animations Not Visible: Confirm client supports animated text (some mods may interfere)
• Hex Colors Not Working: Verify you're using the correct syntax (&#RRGGBB)

For server admins, NeoEssentials provides commands to test formatting:

/neoessentials:format test "Your formatted text here"
/neoessentials:format reload
/neoessentials:format list

• NeoEssentials Placeholders
• Custom Templates
• Animation System
• NeoEssentials Discord for formatting support