ParticleForge v1.0.3

ParticleForge: The Central Particle Effects Engine for TTS-STUDIO​

ParticleForge is much more than a simple particle plugin; it is the central particle effects engine for the entire TTS-STUDIO plugin suite, designed for Paper 1.21.x servers. This plugin provides a unified and efficient system for managing and reproducing visual effects, ensuring consistency, optimized performance, and an immersive visual experience across your entire server. Forget about inconsistency and lag; ParticleForge is the definitive solution to add that premium visual touch to your plugins.

Why ParticleForge Exists​

Every plugin in the TTS-STUDIO suite needs particle effects. Instead of each plugin implementing its own system, ParticleForge centralizes this functionality. This means:
•Visual Consistency: All plugins in the suite share the same engine, guaranteeing a coherent visual style.
•Optimized Performance: A single scheduler manages the tick budget, Level-of-Detail (LOD) culling, and per-player and global effect limits, preventing server overload.
•Robustness: Effect-specific fault isolation and graceful degradation: if ParticleForge is not installed, dependent plugins will simply not play particles but will continue to function without errors.
ParticleForge is a "free upgrade" you can add to your suite, not a strict requirement, but one that dramatically elevates visual quality.

Key Features​

• Centralized Engine: A single particle effects scheduler with tick budget management, Level-of-Detail (LOD) culling, and per-player and global effect limits.
• YAML-Defined Effects: Create and customize your own particle effects with YAML files, including inheritance and parameter substitution for maximum flexibility.
• Fluent API for Developers: A simple and intuitive API for other plugins (both TTS-STUDIO and third-party) to play particle effects with just a few lines of code.
• 24 Pre-built Effects: Includes a library of ready-to-use effects, categorized for claims, combat, crates, homes, quests, and skills plugins, demonstrating the engine's capabilities.
• Bukkit ServicesManager Integration: Allows other plugins to soft-depend on ParticleForge, detecting its presence and adapting if it's unavailable.
• Fault Isolation: Each effect runs in isolation, preventing a misconfigured or buggy effect from causing server-wide issues.
• Admin Commands: Includes commands to preview effects (/pf preview), list effects (/pf list), get detailed information (/pf info), debug (/pf debug), reload configurations (/pf reload), and stop active effects (/pf stop).
• TTS-Studio House Style: Unified chat prefix and boot banner with the rest of the TTS-STUDIO plugin suite, offering a consistent brand experience.

Configuration and Usage​

Particle effects are defined in YAML files located in plugins/ParticleForge/effects/<category>/<name>.yml. You can create your own effects or modify existing ones. The plugin supports extends: for inheritance and ${param} for parameterized effects, allowing for great reusability and customization.

Example YAML Effect:​

YAML


name: my-cool-burst category: custom defaults: particle: FLAME count: 32 speed: 0.5 steps: - type: BURST duration: 10 params: particle: ${particle} count: ${count} speed: ${speed} - type: RING duration: 20 params: particle: END_ROD radius: 1.5

Commands and Permissions​

Developer Integration​

ParticleForge is designed to be consumed by other plugins. Developers can use its fluent API or Bukkit's ServicesManager to integrate particle effects simply and securely. Make sure to add softdepend: [ParticleForge] in your plugin.yml.

Quick Start​

1.Download particleforge-X.Y.Z.jar and place it in your server's plugins/ folder.
2.Restart the server.
3.Use /pf list to see pre-built effects.
4.Create your own effects in plugins/ParticleForge/effects/ and reload them with /pf reload.
ParticleForge is the visual foundation of your Paper server, providing unprecedented control over particle effects and elevating the aesthetic quality of your entire plugin suite. Make your server shine with stunning and optimized visual effects!