VeeFriends.UI 5.0.8

VeeFriends.UI

A powerful .NET library for generating dynamic, comic-book style text images with professional effects. Perfect for creating eye-catching headings, logos, and promotional graphics with stroke outlines, drop shadows, and custom transformations.

✨ Features

• 🎯 Comic-Book Style Text - Professional stroke outlines and drop shadows
• 🌈 Rich Color Support - Full RGB/RGBA with smart color encoding
• 🔄 CSS-Like Transforms - Rotation and skew transformations
• 📱 URL Serialization - Compact, URL-friendly parameter encoding
• ⚡ High Performance - Optimized memory management and auto-cropping
• 🎨 Custom Typography - Multiple font weights and styles
• 🔧 Dependency Injection Ready - First-class DI support
• 🧪 Thoroughly Tested - Comprehensive test suite

🚀 Quick Start

Installation

dotnet add package VeeFriends.UI

Basic Usage

using Microsoft.Extensions.DependencyInjection;
using VeeFriends.UI;
using VeeFriends.UI.Options;

// Setup DI
var services = new ServiceCollection();
services.AddVeeFriendsUI();
var provider = services.BuildServiceProvider();

// Create headings
var headings = provider.GetRequiredService<Headings>();

// Simple text with defaults
using var image = headings.Create("COLLECTIBLES");
await image.SaveAsPngAsync("output.png");

🎨 Examples

Default Comic-Book Style

using var image = headings.Create("AWESOME TEXT");

Creates white text with black stroke outline and drop shadow, with subtle skew and rotation for dynamic comic-book appearance.

Custom Styling

var options = new HeadingOptions
{
    Text = "CUSTOM STYLE",
    FontSize = 96,
    TextColor = Color.Yellow,
    StrokeColor = Color.Red,
    StrokeWidth = 4f,
    ShadowDepth = 12f,
    ShadowSmoothness = 1.2f
};

using var image = headings.Create(options);

Transformed Text

var options = new HeadingOptions
{
    Text = "ROTATED & SKEWED",
    FontSize = 80,
    Rotation = -15f,    // Rotate 15 degrees counter-clockwise
    SkewX = -20f,       // Skew left for dynamic effect
    TextColor = Color.Blue,
    StrokeColor = Color.White
};

using var image = headings.Create(options);

Minimal Clean Text

var options = new HeadingOptions
{
    Text = "CLEAN TEXT",
    HasShadow = false,
    HasStroke = false,
    TextColor = Color.Black,
    FontSize = 64,
    Rotation = 0,
    SkewX = 0
};

using var image = headings.Create(options);

🛠️ Advanced Features

URL Serialization

Perfect for web applications - serialize styling options to compact URLs:

var options = new HeadingOptions
{
    Text = "Hello World",
    FontSize = 96,
    TextColor = Color.Red,
    Rotation = -5f
};

// Serialize to URL path
string urlPath = options.ToUrlPath();
// Result: "/txt:Hello+World,fs:96,tc:R,rot:-5/"

// Deserialize back
var restored = urlPath.FromUrlPath();

Color Encoding:

• Common colors use short codes: R (Red), B (Blue), Y (Yellow)
• Custom colors use hex: 7B2D43 (RGB) or FF000080 (RGBA)
• Transparent colors supported with alpha channel

Dependency Injection

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddVeeFriendsUI();
        // FontLoader, LogoLoader, and Headings are now available
    }
}

📋 Configuration Options

🎯 Use Cases

• Marketing Graphics - Eye-catching promotional text
• Social Media - Branded content and memes
• Gaming UI - Dynamic game titles and notifications
• Web Applications - Generated heading images
• Print Media - High-quality text graphics
• Merchandise - T-shirt and product designs

🔧 Requirements

• .NET 9+
• SixLabors.ImageSharp 3.x

🏗️ Architecture

Built on enterprise-grade foundations:

• Memory Safe - Proper resource disposal and exception handling
• Performance Optimized - Zero-allocation string operations where possible
• Thread Safe - Concurrent operations supported
• Extensible - Clean separation of concerns

🤝 Contributing

We welcome contributions! Please see our contributing guidelines for details.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

Built with ❤️ for the VeeFriends community