Skip to content

An all-around framework, written in Kotlin, for plugins running on paper servers (and above).

License

LGPL-3.0, GPL-3.0 licenses found

Licenses found

LGPL-3.0
COPYING.LESSER
GPL-3.0
LICENSE
Notifications You must be signed in to change notification settings

TheFruxz/Sparkle

Sparkle Banner


👋 Welcome to Sparkle!

Sparkle is a full-fledged framework, developed for the development of Server-Plugins on the Paper Minecraft-Server platform, using the Kotlin programming language.

This framework combines simple and feature-rich tools with under-the-hood rocket science, to enable a new feature-rich architecture, for plugins, to build on.

Multi-Platform support is planned and will be shifted into development soon!

📑 Version

Many plugins do everything, to be supported on as many versions of Minecraft as possible. If you want to use this framework with this goal in mind, this may not be the right thing for you. This framework is specialized to make the most out of current and coming technology. This is the reason, why we always build on-top the newest (or current newest stable) version, available right now.

🎯 Goal

Our goal is to provide powerful tools and a great foundation, which helps to easily develop plugins, without blocking the way to get deeper.

💻 Set up your Project

The repository will be soon switched to my repo.fruxz.dev server instead of jitpack.io

Our current platform of trust for our builds is 'JitPack'. This allows us to easily provide you with the current version of Sparkle, without all the hustle of GitHub's own “solution”.

Firstly, add JitPack as a maven repository if it is not already added!

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

Subsequently, the only thing missing is sparkle itself, add this to your dependencies:

implementation("com.github.TheFruxz:sparkle:$sparkleVersion")

And done.

🌋 Running Sparkle

Currently, due to some features and actively running code, it is required, that the Sparkle plugin is running on the server. The running plugin not only allows automatic services, but also loading the required dependencies. Things like the Kotlin-Libraries and Ascend + Stacked are all loaded via the Paper-Plugin dependency feature, so the Sparkle-Plugin file is lightweight and your Paper-Server provides you with the stuff, you need.

🧑‍💻 Contribution

Of course, you can also participate in Sparkle and contribute to the development. However, please follow all community and general guidelines of GitHub and the repositories. You also have to respect the licenses set in this repository as well as in other repositories.

If you require any further assistance, suggestions or other items you would like to contribute to Sparkle or just discuss, take a look at the Discussions' section of this repository. There you will find the respective areas where you can create your own questions or join in discussions on other things.

We build & use Sparkle on Java 17.
Also build & run Sparkle with Eclipse Temurin on to get the best possible experience!
Currently a bit slow in updating, but speed will increase again in the near future (with #132 in mind)