PixelWorks

** PixelWorks Plugin - Complete Documentation 🎆 Overview ``` _____ _ _ __ __ _ | __ (_) | | \ \ / / | | | |__) |__ _____| | \ \ /\ / /__ _ __| | _____ | ___/ \ \/ / _ \ | \ \/ \/ / _ \| '__| |/ / __| | | | |> < __/ | \ /\ / (_) | | | <\__ \ |_| |_/_/\_\___|_| \/ \/ \___/|_| |_|\_\___/ ``` **Custom Particle Firework Shapes & Text for Minecraft** **PixelWorks** is a premium-quality Paper plugin that revolutionizes fireworks in Minecraft. Instead of standard firework explosions, PixelWorks displays stunning **custom shapes** and **readable text** made entirely of colored particles in the sky! Perfect for: - 🎄 **Holiday Events** (Christmas, New Year, Halloween) - 🎉 **Server Celebrations** (Anniversaries, Milestones) - 🏆 **Player Rewards** (Achievement unlocks, VIP perks) - 🎨 **Creative Builds** (Light shows, Decorations) - 📢 **Announcements** (Server messages in the sky) | Specification | Details | |--------------|---------| | **Plugin Name** | PixelWorks | | **Version** | 1.0.0 | | **API Version** | Paper 1.21+ | | **Compatibility** | Minecraft 1.21.1 - 1.21.4 | | **Java Version** | Java 21+ | | **Dependencies** | None (Standalone) | --- ✨ Key Features 🎨 Particle Rendering Engine | Feature | Description | |---------|-------------| | **Bitmap Font System** | Complete A-Z, 0-9, and punctuation rendered as 5×7 pixel characters | | **ASCII Art Shapes** | Define custom shapes using simple grid patterns in config | | **Vector Mathematics** | Precise 2D to 3D transformation with rotation matrices | | **Player-Facing Display** | Patterns automatically rotate to face the launching player | | **Multi-line Text** | Automatic word wrapping for long messages | | **Dual Color Support** | Primary and secondary colors for detailed designs | | **Animated Display** | Particles persist for configurable duration | 🚀 Custom Firework Items | Feature | Description | |---------|-------------| | **PDC Storage** | Pattern data stored using PersistentDataContainer (survives server restarts) | | **Custom Display Names** | Beautiful formatted names with icons | | **Detailed Lore** | Shows pattern type, content, and dimensions | | **Stack-friendly** | Items stack properly like vanilla fireworks | | **No NBT Issues** | Uses modern PDC system, not deprecated NBT tags | 🛠️ Recipe System | Feature | Description | |---------|-------------| | **Shaped Recipes** | Define exact ingredient positions | | **Shapeless Recipes** | Any arrangement of ingredients works | | **Configurable Results** | Set how many fireworks each craft produces | | **Hot Reload** | Add new recipes without server restart | 📦 22 Pre-Built Patterns | Category | Patterns | |----------|----------| | **Mob Faces (12)** | Skeleton, Zombie, Villager, Pillager, Enderman, Warden, Wither, Dragon | | **Animals (6)** | Wolf, Cat, Axolotl, Panda, Reindeer | | **Players** | Steve | | **Objects (3)** | Christmas Tree, Gift Box, Cake | | **Text (4)** | Merry Christmas, Happy New Year, Happy New Year 2026, everETERNAL SMP | ⚡ Performance Optimized | Feature | Description | |---------|-------------| | **Cached Calculations** | Pattern points calculated once then cached | | **Async Particle Spawning** | Non-blocking particle display | | **Configurable Limits** | Control particle count and spawn rate | | **View Distance** | Only spawn particles for nearby players | --- 🔧 How It Works The Process Flow ``` ┌─────────────────┐ │ Player crafts │ │ or receives │ │ PixelWorks │ │ Firework │ └────────┬────────┘ │ ▼ ┌─────────────────┐ │ Firework has │ │ PDC data with │ │ pattern_id │ └────────┬────────┘ │ ▼ ┌─────────────────┐ │ Player launches│ │ firework │ │ (right-click) │ └────────┬────────┘ │ ▼ ┌─────────────────┐ │ Firework flies │ │ up and │ │ explodes │ └────────┬────────┘ │ ▼ ┌─────────────────┐ │ Plugin cancels │ │ vanilla │ │ explosion │ └────────┬────────┘ │ ▼ ┌─────────────────┐ │ ParticleEngine │ │ loads pattern │ │ from config │ └────────┬────────┘ │ ▼ ┌─────────────────┐ │ Calculate │ │ rotation to │ │ face player │ └────────┬────────┘ │ ▼ ┌─────────────────┐ │ Transform 2D │ │ points to 3D │ │ world coords │ └────────┬────────┘ │ ▼ ┌─────────────────┐ │ Spawn DUST │ │ particles at │ │ each point │ └────────┬────────┘ │ ▼ ┌─────────────────┐ │ Beautiful │ │ pattern │ │ displayed! │ └─────────────────┘ ``` Vector Mathematics Explained The plugin uses **rotation matrices** to transform 2D grid coordinates into 3D world positions: ``` Given: - Origin point (explosion location) - 2D grid point (x, y) - Yaw angle (direction to face) - Scale factor Calculate: