✨ Special Effects for your Plugin!

FxKt is a special effects library for Paper plugin development that simplifies the creation of complex & sequenced effects.

Features

FxKt is in (semi) active development. More utilities will be implemented as the need for them arises in my projects. You are always welcome to contribute to the library by adding useful utilities or improving on what is already here.

🔊 Sound Sequences

Define a sequence of Sounds with set timing easily.

Example

Bukkit.getOnlinePlayers().forEach { player ->
    player.playSoundSequence(MyPlugin.instance) {
        play(Sound.BLOCK_NOTE_BLOCK_PLING, 1f, 1f)

        delay(3) // 150ms / 50 = 3 ticks
        play(Sound.BLOCK_NOTE_BLOCK_PLING, 1f, 0.8f)

        delay(3) // 150ms / 50 = 3 ticks
        play(Sound.BLOCK_NOTE_BLOCK_PLING, 1f, 1f)

        delay(3) // 150ms / 50 = 3 ticks
        play(Sound.BLOCK_NOTE_BLOCK_PLING, 1f, 1.1f)

        delay(3) // 150ms / 50 = 3 ticks
        play(Sound.BLOCK_NOTE_BLOCK_PLING, 1f, 1.2f)
    }
}

More to come...

⚙️ Setup

FxKt uses jitpack. You can implement FxKt using Gradle by adding the JitPack repository

maven("https://jitpack.io")

and adding FxKt as a dependency

implementation("com.github.frozdbyte:FxKt:$fxktVersion")

🧑‍💻 Contributing

As stated before, FxKt currently consists of Utilities I developed for my plugins. If you see ways to improve these or want to add something, you are more than welcome to do so!
If you have any questions, suggestions or ideas, you can reach me via Discord @frozd or send an email to info@frozd.dev.

🩵 Credit where it's due

This project would not exist without Fruxz, who's work has been the soul inspiration and motivation behind this project.
Check out some of his work below. If you end up liking FxKt, you'll love these:

Stacked : An easy-to-use library, written in Kotlin, for the powerful use of the Adventure API for Minecraft.

Ascend : A quality-of-life library written in Kotlin for every JVM-based platform