ratatoulli

<h1>🎨 Ratatoulli - Colored Names &amp; Ranks</h1> <p><strong>Transform your server's player nametags with custom colors, stunning effects, and rank titles!</strong></p> <p>Ratatoulli is the ultimate nametag customization mod for Vintage Story servers. Reward your supporters, distinguish staff members, and add visual flair to your community with fully customizable colored names and rank displays.</p> <h2>✨ Key Features</h2> <ul> <li><strong>Custom Colored Names</strong> - Assign unique colors to any player using hex codes or named colors</li> <li><strong>Rank System</strong> - Display titles like "Supporter", "VIP", "Moderator" above or below player names</li> <li><strong>Easy Commands</strong> - Simple admin commands for managing all aspects of nametags</li> <li><strong>Highly Configurable</strong> - Customize colors, sizes, positions, backgrounds, borders, and more</li> </ul> <h2>🎯 Perfect For</h2> <ul> <li><strong>Ko-fi Rewards</strong> - Give supporters custom colors and exclusive ranks</li> <li><strong>Staff Identification</strong> - Distinguish moderators, admins, and helpers</li> <li><strong>VIP Systems</strong> - Highlight premium members with flashy effects</li> <li><strong>Event Winners</strong> - Reward competition champions with special titles</li> </ul> <h2>👑 Rank System</h2> <p>Display custom titles above or below player names to show roles, achievements, or supporter status. Ranks are fully customizable and work seamlessly with all color effects.</p> <p><strong>Example Ranks:</strong></p> <ul> <li>Supporter</li> <li>VIP Member</li> <li>Moderator</li> <li>Gold Patron</li> <li>Event Champion</li> <li>Master Builder</li> </ul> <h2>🎨 Available Colors</h2> <p><strong>Named Colors:</strong><br />red, green, blue, yellow, cyan, magenta, white, orange, pink, purple, lime, gold, silver, darkred, darkgreen, darkblue, lightblue, lightgreen</p> <p><strong>Hex Colors:</strong><br />Use any color with #RRGGBB format (e.g., #FF0000 for red)<br />Supports transparency with #RRGGBBAA format</p> <h2>⚙️ Commands</h2> <p><em>All commands require server admin privileges</em></p> <h3>Basic Color Commands</h3> <p><code>/colorname add &lt;player&gt; &lt;color&gt;</code><br />Assign a solid color to a player's name</p> <p><code>/colorname remove &lt;player&gt;</code><br />Remove custom color from a player</p> <p><code>/colorname list</code><br />View all players with custom colors and ranks</p> <h3>Rank Commands</h3> <p><code>/colorname rank &lt;player&gt; &lt;rankName&gt;</code><br />Set a rank/title for a player</p> <p><code>/colorname removerank &lt;player&gt;</code><br />Remove a rank from a player</p> <h3>Information Commands</h3> <p><code>/colorname codes</code><br />Display all available color codes</p> <p><code>/colorname effects</code><br />Show information about all effects</p> <h2>💡 Usage Examples</h2> <h3>Ko-fi Supporter Setup</h3> <p><code>/colorname add Alice Red<br />/colorname rank Alice Supporter</code><br />Result: Alice gets a gold name with "Supporter" displayed above it</p> <h2>🔧 Configuration</h2> <p>The mod creates a configuration file at <code>ModConfig/Ratatoulli.json</code> with extensive customization options:</p> <h3>Nametag Appearance</h3> <ul> <li><strong>Background Color</strong> - Customize the nametag background</li> <li><strong>Text Padding</strong> - Adjust spacing around text</li> <li><strong>Border Style</strong> - Configure border width, color, and radius</li> <li><strong>Drop Shadow</strong> - Enable or disable shadows</li> </ul> <h3>Rank Display</h3> <ul> <li><strong>Rank Position</strong> - Display ranks above or below names</li> <li><strong>Rank Color</strong> - Customize rank text color</li> <li><strong>Rank Scale</strong> - Adjust rank text size (default 75% of name size)</li> </ul> <h2>📋 Configuration Example</h2> <pre>{ "EnableColoredNames": true, "NameTagSettings": { "BackgroundColor": [0.0, 0.0, 0.0, 0.6], "DefaultTextColor": [1.0, 1.0, 1.0, 1.0], "TextPadding": 3, "BorderRadius": 3.0, "DropShadow": true, "BorderWidth": 1.0, "BorderColor": [0.0, 0.0, 0.0, 0.8], "RankPosition": "Above", "RankColor": [0.8, 0.8, 0.8, 1.0], "RankScale": 0.75 } }</pre> <p>&nbsp;</p> <h2>🔒 Permissions</h2> <p>All commands require the <code>controlserver</code> privilege (admin access). Players cannot modify their own names - this keeps the system fair and exclusive.</p> <h2>🌟 Technical Highlights</h2> <ul> <li><strong>Performance Optimized</strong> - Efficient caching for smooth animations</li> <li><strong>Cairo Graphics</strong> - High-quality text rendering with proper anti-aliasing</li> <li><strong>Harmony Patches</strong> - Clean integration without conflicts</li> <li><strong>Backwards Compatible</strong> - Works with existing VS entitlement system</li> <li><strong>Persistent Storage</strong> - Colors and ranks saved across server restarts</li> </ul> <h2>⚡ Priority System</h2> <p>The mod applies nametag styles in this order:</p> <ol> <li><strong>Custom Colors</strong> - Set via mod commands (highest priority)</li> <li><strong>VS Entitlements</strong> - Official supporter/dev colors (if no custom color)</li> <li><strong>Default White</strong> - Standard color for everyone else</li> </ol> <h2>💬 Support &amp; Feedback</h2> <p>Found a bug? Have a feature request? Want to show off your awesome nametag designs?<br />Join the discussion and share your feedback!</p> <h2>🎯 Quick Start Guide</h2> <p><strong>Want to get started immediately?</strong></p> <ol> <li>Install the mod</li> <li>Join your server as admin</li> <li>Try: <code>/colorname add YourName gold</code></li> <li>Try: <code>/colorname rank YourName Admin</code></li> <li>Explore more effects with <code>/colorname effects</code></li> </ol> <p><br /><strong>Transform your server today with Ratatoulli!</strong> 🎨✨</p>