Contributing to Kryptonite

[lewmilburn]

What is Kryptonite?

Kryptonite is a plugin that aims to simplify the configuration process for Minecraft Servers. It's designed to be simple, easy-to-use, and lightweight.

All features must be easy-to-use, simple, and fast.

Kryptonite should avoid having it's own configuration files where possible, except where required. It's designed to be a drop-in, drop-out plugin that only needs to be ran once.

What is Kryptonite not?

Kryptonite isn't a full-scale configuration editor or a replacement for configuration files altogether. I ask that contributions to the software keep with the goal of ensuring simplicity and ease of use when configuring performance-first Minecraft Servers.

The manual mode in Kryptonite has selected values that fit with the theme of performance and guides users when changing them, we do not plan to add everything.

Version support.

Right now, I'm not planning to backport Kryptonite. If you'd like to use the plugin on an older server you're welcome to do so, but you'll need to fork and change the code yourself.

Unfortunately, Paper changed some stuff in 1.19 so it's currently not feasible for the plugin to run prior to that without significant changes. If anyone is willing to take the time to add and test this, I'm happy to add it as a feature. But unfortunately, I don't have the time to at the moment.

Thank you!

Finally, thank you! I know it's probably weird to see this in an open-source project, but I thought it would be useful to clarify some points.