https://github.com/therensei/godot_spicyparticlesystem

CPU Particle system for godot engine.
https://github.com/therensei/godot_spicyparticlesystem

godot godot-engine godot4 godotengine

Last synced: 4 months ago
JSON representation

CPU Particle system for godot engine.

• Host: GitHub
• URL: https://github.com/therensei/godot_spicyparticlesystem
• Owner: TheRensei
• License: mit
• Created: 2024-01-04T18:06:25.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-27T17:21:48.000Z (10 months ago)
• Last Synced: 2024-10-10T11:04:46.395Z (4 months ago)
• Topics: godot, godot-engine, godot4, godotengine
• Language: C++
• Homepage:
• Size: 9.42 MB
• Stars: 82
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        







Spicy Particle System



  

    

  

  

    

  

  

    

  

  

    

  



> [!IMPORTANT]  

> This extension is developed for godot 4.2 and above.

> [!WARNING]  

> This extension is not production ready yet. Backup your projects before testing!

Introduction




Spicy Particle System is a powerful and customizable particle system written in C++ as a GDExtension for the Godot Engine 4.2+. This system is designed to offer improved performance compared to the existing CPUParticles3D while providing extensive customization options for your VFX.

Features


- **Modular Design:** Features a modular design with modules divided into generators and updaters. Generators define starting particle parameters, while updaters dynamically update particle properties over their lifetime.

> [!NOTE]  

> Modules are Resources; only assigned modules are executed. Consider the impact on performance when utilizing multiple modules.

- **3D transforms:** Particles are transformed in three dimensions, providing the flexibility to customize size, rotation, velocity, and more with full control over each dimension.

- **On-Screen Editor:** The intuitive on-screen editor allows control of playback and seeking but also displays real-time information on the number of alive particles within the selected system.

- **Random Seed Control:** Take command of randomness with precise control over the random seed, allowing for reproducible and fine-tuned variations in your particle system.

- **Emit Rate Over Distance:** Dynamically spawn particles based on the distance traveled.

- **Burst Emission:** Shedule particles to be emitted at specific time.

- **CPU Alignment:** While shader alignment is favored for its efficiency, the system also includes the option of CPU particle alignment.

- **Hierarchical playback:** Hierarchical playback synchronizes children systems' playback with the parent system if the direct parent is also a particle system. This feature allows for intricate control over particle system behavior in complex hierarchies.




https://github.com/TheRensei/godot_spicyparticlesystem/assets/32361344/80133633-27d2-4c04-aa2d-94d1a64f414e

## Documentation

Detailed documentation will be available in the [Wiki](https://github.com/TheRensei/godot_spicyparticlesystem/wiki), providing comprehensive information on installation, usage, and customization. Check out the [getting started](https://github.com/TheRensei/godot_spicyparticlesystem/wiki/0.-Getting-Started) section.

## Upcoming features

> [!NOTE]  

> Please note that development timelines may vary, and unforeseen challenges could impact the final feature set. Consider these as potential improvements, not guarantees.

- More emitter shapes.

- Emitter shapes gizmos.

- Improvements to the on-screen control panel.

- Trails.

- Animation player integration.

- Noise updater.

- Presets.

- Optimizations:

     - Multithreading:

          - System - for systems with small amount of particles - executed on it's own thread.

          - Data - for systems with large amount of particles - typical data threading.

     - Conditional data generation - less memory used when small number of modules is assigned.

## License

Spicy Particle System is licensed under the MIT License, allowing for both personal and commercial use.

 
  References 
 

  

Big thanks to Bartlomiej Filipek for his [blog post](https://www.cppstories.com/2014/04/flexible-particle-system-start/) - it was extremely helpful and helped me understand how particle systems are written in the first place. I thought that this approach was a great place to start with so this is what this system is based on.


Links to icons used:

[Link](https://www.svgrepo.com/svg/320810/flaming-claw)

[Link](https://www.svgrepo.com/svg/525367/heart-shine)

[Link](https://www.svgrepo.com/svg/533001/square-dashed)

[Link](https://www.svgrepo.com/svg/458610/color-mode)

[Link](https://www.svgrepo.com/svg/489117/scale-1)

[Link](https://www.svgrepo.com/svg/374909/high-velocity-sales)

[Link](https://www.svgrepo.com/svg/375107/rotate)

[Link](https://www.svgrepo.com/svg/375045/product-transfer)

[Link](https://www.svgrepo.com/svg/502881/update)

[Link](https://www.svgrepo.com/svg/502459/alarm)

I've resized, optimized and coloured most of them, the main icon is a combination of 2 other icons.

With [CC](https://www.svgrepo.com/page/licensing/#CC%20Attribution) and PD licenses.

Example VFX textures are from Kenney's [particle pack](https://www.kenney.nl/assets/particle-pack) at [kenney.nl](https://www.kenney.nl/assets)