KFramework

Плагин Paper

Lightweight Kotlin framework for Paper plugin development

21 скачивание 0 подписчиков

Исходники Paypal

Оцените первым

Канал

Ядро

Версия

KotlinFramework

Lightweight Kotlin framework for Paper plugin development. Less boilerplate, more plugin.

I built this because I kept copy-pasting the same companion object, instance setup, and registerEvents into every single plugin. It's not trying to replace anything, it just removes the repetitive parts.

Features

Base class (KotlinFramework) with automatic instance, startup logging, and safe error handling
Inline command registration: no separate class for simple commands
Inline event listening: no @EventHandler, no separate Listener class
KotlinCommand base class for commands that need their own file
Scheduler helpers: runLater, runTimer, runAsync
Config helpers: saveLocation, getLocation, config, setConfig
Message helpers: msg, broadcastMsg, colorize with & color support

Installation

Add JitPack to your repositories and the framework as a dependency:

repositories {
    maven("https://jitpack.io")
}

dependencies {
    implementation("com.github.kolerz:kframework:1.0.0")
}

⚠️ Use shadowJar to bundle the framework into your plugin jar, otherwise it won't load.

Quick example

class MyPlugin : KotlinFramework() {

    override fun onStart() {

        registerCommand("heal", playerOnly = true) {
            player!!.health = 20.0
            reply("&aHealed!")
        }

        registerCommand("broadcast", permission = "myplugin.broadcast") {
            requireArgs(1, "/broadcast <message>") {
                broadcastMsg("&8[&cBroadcast&8] &f${args.joinToString(" ")}")
            }
        }

        registerListener {
            on<PlayerJoinEvent> {
                player.msg("&aWelcome, &f${player.name}&a!")
            }
        }

        runTimer(0L, 20L * 60L * 5L) {
            broadcastMsg("&eRemember to vote!")
        }
    }
}