# ChromaticChat Documentation

ChromaticChat is a powerful and feature-rich Minecraft plugin that provides advanced chat customization options, including color management, gradients, presets, and floating chat messages.

## Table of Contents
- [Features](#features)
- [Commands](#commands)
- [Permissions](#permissions)
- [Configuration](#configuration)
- [Color Presets](#color-presets)
- [Floating Chat](#floating-chat)
- [API Version](#api-version)

## Features

- **Custom Colors**: Support for both standard Minecraft colors and custom HEX colors
- **Gradient Effects**: Create beautiful gradient text effects
- **Color Presets**: Save and load personal color combinations
- **Public Presets**: Share and discover color presets with other players
- **Floating Chat**: Display chat messages as floating text above players
- **Performance Optimized**: Built-in caching system for color calculations
- **Cooldown System**: Prevent spam with configurable cooldowns
- **Permission-Based**: Fine-grained control over feature access

## Commands

### Chat Color Command
- `/chatcolor` (aliases: `/cc`)
- `/chatcolor color <color>` - Set chat color (hex or name)
- `/chatcolor gradient <colors...>` - Create gradient effect
- `/chatcolor reset` - Reset to default
- `/chatcolor list` - Show available colors
- `/chatcolor bold` - Toggle bold text

### Preset Command
- `/preset` (aliases: `/presets`, `/ccpreset`, `/ccp`)
- `/preset save <name>` - Save current color settings
- `/preset load <name>` - Load a saved preset
- `/preset delete <name>` - Delete a preset
- `/preset list` - View your presets

### Public Preset Command
- `/publicpreset` (aliases: `/ccpublic`, `/ppreset`)
- `/publicpreset publish <name>` - Share a preset publicly
- `/publicpreset unpublish <name>` - Remove from public listing
- `/publicpreset browse` - Browse public presets
- `/publicpreset like <name>` - Like a public preset
- `/publicpreset info <name>` - View preset details

### Gradient Command
- `/gradients` (aliases: `/ccgs`, `/chatcolorgradients`)
- `/gradients <name>` - Apply a pre-made gradient

### Float Chat Command
- `/floatchat` (aliases: `/ccfloat`, `/fchat`)
- `/floatchat enable` - Enable floating chat
- `/floatchat disable` - Disable floating chat

## Permissions

### Basic Permissions
- `chromatichat.set` - Allow setting chat color (default: true)
- `chromatichat.reset` - Allow resetting chat color (default: true)
- `chromatichat.bold` - Allow bold text (default: true)

### Advanced Features
- `chromatichat.gradient` - Allow gradient effects (default: op)
- `chromatichat.custom` - Allow custom hex colors (default: op)
- `chromatichat.glow` - Allow glow effects (default: op)

### Administrative
- `chromatichat.bypass.cooldown` - Bypass color change cooldown (default: op)

### Preset Management
- `chromatichat.preset.save` - Allow saving color presets
- Additional preset-related permissions available

## ⚙️ Configuration

```yaml
# Cooldown settings
cooldown:
enabled: true
duration: 30 # seconds

# Color restrictions
colors:
allow-custom-hex: true
allow-gradient: true
restricted-colors:
- "#000000" # Black

# Chat format
chat:
enabled: true
format: "{prefix}{player}{suffix}: {message}"

# Float chat settings
float-chat:
enabled: true
duration: 3
height: 2.5

# Performance settings
performance:
enable-cache: true
max-cache-size: 100
```

## Color Presets

### Personal Presets
- Save unlimited personal color combinations
- Quick access to favorite styles
- Persistent storage across sessions

### Public Preset System
- Share presets with the community
- Browse and like other players' presets
- Sort by popularity or recent additions

## Floating Chat

The floating chat feature displays messages above players' heads, adding a new dimension to in-game communication:

- Configurable height and duration
- Smooth animations
- Performance-optimized rendering
- Toggle-able per player

## API Version

- Required Minecraft Version: 1.21+
- Plugin Version: {1.0.0}

## Additional Notes

- Auto-saves color data every 5 minutes
- Graceful shutdown with data persistence
- Efficient memory management with caching
- Full UTF-8 support for special characters