DC Render API

# DC Render API (https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/19136644525lxy/DC-Render-API/blob/22c6b3a66ec7885f6eea4698329fe4129cd0766b/LICENSE.md) (https://img.shields.io/badge/GitHUb-Source%20Repo-blue)](https://github.com/19136644525lxy/DC-Render-API) (https://img.shields.io/badge/CurseForge-Download-orange)](https://www.curseforge.com/minecraft/mc-mods/dc-render-api) (https://img.shields.io/badge/Modrinth-Download-blue)](https://modrinth.com/mod/dc-render-api) (https://img.shields.io/badge/Platform-Forge%20%7C%20Fabric%20%7C%20NeoForge-darkgreen)](#platform-support) (https://img.shields.io/badge/Minecraft-1.20.1%20%7C%201.21.1-blue)](#platform-support) (https://img.shields.io/badge/Powers-Dragon%20Curse%20Chronicles-purple)](https://modrinth.com/mod/dragon-curse-chronicles) > DC Render API is an advanced particle rendering & animation library for Minecraft mods. It exposes a complete, production-ready visual system for controllable particles, particle groups, emitters, styles, barrages, display entities, easing timelines and a lightweight event bus — and ships with a built-in mitigation strategy against aggressive `addParticle` culling from client-side optimization mods such as Embeddium / Rubidium / Inventory Particles. The project maintains **Forge 1.20.1 / Fabric 1.20.1 / NeoForge 1.21.1** with full feature parity across all three loaders. **跳转至中文文档**: (https://github.com/19136644525lxy/DC-Render-API) --- ## Platform Support | Loader | Minecraft Version | Mod Artifact | JDK | Kotlin Language Adapter | |---|---|---|---|---| | **Minecraft Forge** | 1.20.1 | `0.2.0-1.20.1Forge` | JDK 17+ | `Kotlin-for-Forge-*-1.20.1.jar` (by thedarkcolour) | | **Fabric** | 1.20.1 | `0.2.0-1.20.1Fabric` | JDK 17+ | `fabric-language-kotlin-*` (by FabricMC) | | **NeoForge** | 1.21.1 | `1.0.0-1.21.1NeoForge` | JDK 21+ | `Kotlin-for-Forge-*-1.21.1-NeoForge.jar` (by thedarkcolour) | > ⚠ **Mandatory three-jar setup for every loader**: install the **Kotlin language adapter** + **DC Render API jar** + **the main mod that consumes it (e.g. Dragon Curse Chronicles)**. Missing any one of the three will crash at load. --- ## Core Features ### Main Capabilities - **Controllable Particle System**: Particle instances tracked by stable `id` with explicit lifecycle & dead flag. - **Particle Animation System**: Circle orbit, spiral orbit, wave motion, random walk, easing functions, and timeline keyframe interpolation. - **Server-Client Particle Sync**: Two dedicated network packets (`ParticleGroupPacket`, `ParticleSyncPacket`) guarantee a consistent view across clients. - **Particle Group Management**: `ServerParticleGroupManager` / `ClientParticleGroupManager` for batched create / tick / destroy. - **Particle Emitter System**: `ParticleEmitter` interface + `ParticleEmitterManager` with rate & velocity settings. - **Particle Style System**: `ParticleStyle` for size / alpha / RGB / lifetime; `createStyle` + `applyStyleToParticle`. - **Barrage System**: `BarrageManager` supports complex patterns including circular barrages. - **Display Entity System**: Lightweight wrapper around Minecraft Display Entities: `DisplayEntity` + `DisplayEntityManager`. - **Effect System**: `Effect` + `EffectManager` combines multiple particles + animations into one reusable unit. - **Event System**: Lightweight `EventBus` + `ParticleEventBus`; hooks for collision, hit, on-ground, liquid-entry. - **Noise System**: `PerlinNoise` for natural-looking randomness. - **Smart Particle Dispatcher (pioneered in NeoForge host mod)**: Frame-aware batching + LOD falloff + object pooling + progressive emission + long-distance packet bypass; works around aggressive culling from client particle mods. ### Animation Effects - Circular Orbit - Spiral Orbit - Wave Motion - Random Walk - Easing functions (Linear, Quad, Cubic, Quart, Quint, Sine, Expo, Circ, Back, Elastic, Bounce …) - Timeline interpolation (position, scale, rotation, color) - Composition / layered animation --- ## Project Structure ``` DC Render API/ # Standalone monorepo (this directory) ├── src/ # Forge 1.20.1 sources │ └── main/ │ ├── java/com/qituo/dcrapi/ # Java layer: mod entry, items, network, particles, platform │ │ ├── DcRenderApi.java # Forge @Mod entry │ │ ├── items/ParticleTesterItem.java # in-game particle debugger │ │ ├── network/* # server → client sync packets │ │ ├── particles/ │ │ │ ├── emitters/* # Emitter interface + manager │ │ │ ├── style/* # Style interface + manager │ │ │ ├── DcRenderApiParticleManager.java # Thread-safe particle registry │ │ │ ├── ControlableParticle.java │ │ │ └── ServerPartic