APEL

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:

• 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.

Gallery

Installation

Developers

This section is for developers using APEL as a library.

1. In your gradle.properties file, add this line:

   apel_version=0.1.0+1.21 // Replace "1.21" with "1.20.6" for the 1.20.6 mc version
   

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:

   repositories {
    // ...
      maven {
          url = "https://api.modrinth.com/maven"
      }
    }
   

3. Also in build.gradle, add the dependency under the dependencies block:

   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.

Code Example

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):

ParticlePolygon polygon = new ParticlePolygon(ParticleTypes.END_ROD, 3, 3.0f, 100);

AtomicBoolean reverse = new AtomicBoolean(false);
polygon.setBeforeDraw((data, obj) -> {
    if (data.getCurrentStep() <= 15) {
        return;
    }
    boolean isStepZero = data.getCurrentStep() % 15 == 0;
    int sides = 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);
        }
    }
    obj.setRotation(obj.getRotation().add(0, 0.002f, 0));
});

LinearAnimator linearAnimator = new LinearAnimator(1, new Vector3f(), new Vector3f(10, 0, 0), polygon, 1000);

linearAnimator.beginAnimation(ApelServerRenderer.create(world));

We define the particle object (ParticlePolygon) with the particle effect to use, the sides of the polygon, the size of the polygon, and the number of particles to use on the polygon.

After that we use the library's ability to modify the object before each frame is rendered. This is via a lambda function that receives some context and the object to be rendered. This example modifies the number of sides on the polygon by checking what step the animation is on, and using that to determine the number of sides the polygon should have. It also shows how to increment the rotation (expressed in Euler angles per axis), in this case a slight rotation around the y-axis on each tick..

We then create a linear path animator and supply it with the delay in ticks between frames, the starting position of the line, the ending position of the line, the particle object to use, and the number of rendering steps for the animation.

Finally, we play the linear path animator and supply it with a renderer instance for server-side rendering.

Note

The mod may be required to be installed client-side depending on if the developer chooses to use Apel's client-side renderer, which optimises the particles way more than the server-side renderer although it requires that people need the client mod to be installed. If they don't choose client-side renderer then no need for the client mod

Links

• Github Repository
• Discord Server
• Instagram