KFramework

插件

· 作者 Kolerz

适用于 Paper 插件开发的轻量级 Kotlin 框架

0 本站下载 0 关注 更新于 6 个月前

最新 1.0.1 · 1.21.11 · Paper

一键开服(送7天)

KotlinFramework

用于 Paper 插件开发的轻量级 Kotlin 框架。减少样板代码,专注于插件本身。

我构建这个框架是因为我在每个插件中反复复制粘贴相同的 companion object、instance 设置和 registerEvents。它并不试图替代任何东西,只是去除了那些重复的部分。


特性

  • 基类(KotlinFramework),包含自动的 instance、启动日志记录和安全错误处理
  • 内联命令注册:简单命令无需单独的类
  • 内联事件监听:无需 @EventHandler,无需单独的 Listener 类
  • KotlinCommand 基类,适用于需要独立文件的命令
  • 调度器辅助方法:runLater、runTimer、runAsync
  • 配置辅助方法:saveLocation、getLocation、config、setConfig
  • 消息辅助方法:msg、broadcastMsg、colorize,支持使用 & 进行颜色编码

安装

在仓库中添加 JitPack,并将该框架作为依赖项添加:

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

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

⚠️ 请使用 shadowJar 将框架打包到你的插件 jar 中,否则它将无法加载。


快速示例

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!")
        }
    }
}

要求

  • Paper 1.21+
  • Java 21+
  • Kotlin 2.x

源码

github.com/kolerz/kframework


许可证

MIT

你是这个资源的作者?登录后可认领此资源。

评论 0

0.0
暂无评分
5 星
0
4 星
0
3 星
0
2 星
0
1 星
0
我的评分

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源