APEL

> This project has been archived as of June 20 - 2026. See the github README as to why


Apel stands for Animative Particle Engine Library. Its goal is to give the developer a huge productivity boost by incorporating a powerful animation engine that allows for the management of complex particle animations. Thus the library aims to provide:

 To put it simply. APEL allows you to fully make these animations with very few lines of code:

The key strengths of APEL are specifically: - Ease Of Use: The library cuts down the components into its simplest roots. This provides a straightforward and easy to use developer interface, so any developer can use. - Flexiblity: Another goal is to make the library as flexible as it can be without ruining the other goal factors. The library allows for composing complex scenes without additional syntactic sugar involved. - Rich Documentation: Our team aims for detailed documentation that clearly explains how each feature works. We actively work on improving it, and documentation can be read from java docs or from the markdown documents in github. - High Performance: Since the library is meant to be used for creating intricate particle scenes, the library is very optimised and performance friendly.

 ### Developers This section is for developers using APEL as a library.

1. In your ``gradle.properties`` file, add this line: ```java apel_version=0. 1. 5+1. 21. 8 ``` 2. In ``build.gradle``, find the top-level ``repositories`` block, and add these lines if you haven't installed any other dependency mods from modrinth: ```java repositories { // ... maven { url = "https://api.modrinth.com/maven" } } ``` 3. Also in ``build.gradle``, add the dependency under the dependencies block: ```java dependencies { // ... modImplementation "maven.modrinth:apel:${project.apel_version}" // ... } 4. Refresh gradle (in IntelliJ IDEA, press the gradle icon with a rotate sub-icon) 5. Try to either type ``Apel`` and let your IDE autocomplete it, or import ``net.mcbrincie.apel. Apel``. If all steps are done, everything should work as expected.

### Players Download the mod via your usual means and place it in your ``mods`` folder.

 For a regular particle polygon that moves in a line from one point to another, rotates around the Y axis, and loops by animating between 3 sides to 30 sides, the code looks like this (not a straightforward first example, but showcases the possibilities): ```java AtomicBoolean reverse = new AtomicBoolean(false);

ParticlePolygon polygon = ParticlePolygon.builder() .particleEffect(ParticleTypes. END_ROD) .sides(3) .scale(3. 0f) .amount(100) .beforeDraw((data, obj) -> { if (data.getCurrentStep() <= 15) { return; } boolean isStepZero = data.getCurrentStep() % 15 == 0; int sides = ApelUtils.getValueFromEasingCurve(obj.getSides()); if (isStepZero && !reverse.get()) { obj.setSides(sides + 1); if (sides >= 30) { reverse.set(true); } } else if (isStepZero && reverse.get()) { obj.setSides(sides - 1); if (sides == 4) { reverse.set(false); } } Vector3f newRot = ApelUtils.getValueFromEasingCurve(obj.getRotation()).add(0, 0. 002f, 0); obj.setRotation(newRot); }) .build(); LinearAnimator linearAnimator = LinearAnimator.builder() .endpoint(new Ve