Componency

模组

· 作者 deftu

一个基于 Kotlin 构建/专为 Kotlin 设计的声明式 GUI 创建库。

0 本站下载 0 关注 更新于 2 年前

需要前置:Kotlin for Forge、OmniCore、Textile

最新 0.3.0+1.19.2-forge · 1.19.2 · Forge

一键开服(送7天)

Componency

一个简单、声明式 的 UI 库,从头开始构建,适用于任何环境。

wakatime



灵感来源

Componency 大致基于以下三个事物:

我借鉴了这三个项目中的概念,创建了一个简单的、声明式 的 UI 库,可用于任何环境。


免责声明

本库主要面向 Kotlin 设计,但也提供了一些对 Java 的额外支持。

从下文开始的所有示例都将使用 Kotlin 编写,但该库也可以在 Java 中使用。


设置

仓库

Groovy (.gradle)
maven {
    name = "Deftu Snapshots"
    url = "https://maven.deftu.dev/snapshots"
}
Kotlin (.gradle.kts)
maven(url = "https://maven.deftu.dev/snapshots") {
    name = "Deftu Snapshots"
}

依赖项

Repository badge

Groovy (.gradle)
modImplementation "dev.deftu:componency:<VERSION>"
Kotlin (.gradle.kts)
implementation("dev.deftu:componency:<VERSION>")

用法

引擎

要使用该库,您需要创建一个 Componency 引擎。引擎负责为 Componency 提供任何所需的数据,并赋予其与所选渲染系统交互的能力。

package com.example

import dev.deftu.componency.engine.Engine
import dev.deftu.componency.engine.InputEngine
import dev.deftu.componency.engine.RenderEngine
import java.awt.Color

class MyEngine : Engine {

    override val inputEngine: InputEngine by lazy {
        MyInputEngine()
    }

    override val renderEngine: RenderEngine by lazy {
        MyRenderEngine()
    }

}

class MyInputEngine : InputEngine {

    override val mouseX: Float = 0f

    override val mouseY: Float = 0f

}

class MyRenderEngine : RenderEngine {

    override val viewportWidth: Int = 0

    override val viewportHeight: Int = 0

    override val animationFps: Int = 144 // 建议不超过 300

    override fun startFrame() {
        // 开始渲染帧(应用任何变换等)
    }

    override fun endFrame() {
        // 结束渲染帧(应用任何变换等)
    }

    override fun fill(x1: Float, y1: Float, x2: Float, y2: Float, color: Color, radius: Float) {
        // 用颜色和圆角填充矩形
    }

}

您的 UI

现在您已经设置了引擎,可以开始创建 UI 了。

object Main {
    
    @JvmStatic
    fun main(args: Array<String>) {
        val engine = MyEngine()
        val ui = MyUI(engine)
        
        // 在您的渲染循环内部,只需调用 `ui.render()` 即可渲染您的 UI。
        ui.render() // (这是您实际渲染循环的占位符)
    }
    
}

class MyUI(engine: Engine) {
    
    // 常见做法是使用 Frame 作为根组件
    private val frame = FrameComponent().configure {
        // 在 Componency 中,我们在配置时将属性定义在自己的作用域内。
        // 大多数最常用的属性都有扩展变量和函数,以便更轻松地访问它们。
        properties {
            width = 100.percent
            height = 100.percent
        }
    }.makeRoot(engine) // 最后,我们通过将引擎传递给它来使 frame 成为此 UI 的根组件。
    
    private val box = RectangleComponent().configure {
        properties {
            x = 25.percent
            y = 25.percent
            width = 50.percent
            height = 50.percent
            color = Color.RED.asProperty
        }
    }.attachTo(frame) // 我们将 box 设置为 frame 的子级。
    
    // 从这里开始,您可以向 frame 或 box 添加更多组件。

    // 最后,我们提供一种外部方式来渲染我们的 frame。
    fun render() {
        frame.handleRender()
    }

}

更多示例

如需更多示例,您可以查看 basic examples 目录。 (Java, Kotlin)

或者,如果您想为 LWJGL3 实现,可以查看 LWJGL3 example 目录。

在 Minecraft 中设置

现代版和旧版 Minecraft 仍然需要在 Set up 部分中定义的仓库使用者。Minecraft 工件的版本号与主库的版本号相同。

现代 Minecraft (1.16.5 及以上版本)

在现代 Minecraft 版本中,只需在构建脚本中定义依赖项即可使用 Componency Minecraft 引擎。

Groovy (.gradle)
modImplementation "dev.deftu:componency-minecraft-<MINECRAFT VERSION>-<MOD LOADER>:<VERSION>"
Kotlin (.gradle.kts)
implementation("dev.deftu:componency-minecraft-<MINECRAFT VERSION>-<MOD LOADER>:<VERSION>")

旧版 Minecraft (1.12.2 和 1.8.9)

对于旧版 Minecraft 版本,我们需要进行额外的设置,因为必须使用依赖管理 Tweaker 来确保加载最新版本的 Componency。

它不仅负责处理库的版本,还强制 Minecraft 使用 LWJGL 3 来加载 NanoVG 和 STB,以便我们的引擎能够同时利用它们进行渲染。

关于与其他 Tweaker 配合使用的额外说明,请参阅 类文件本身。

Groovy (.gradle)
dependencies {
    modImplementation "dev.deftu:componency-minecraft-<MINECRAFT VERSION>-<MOD LOADER>:<VERSION>"
    modImplementation "dev.deftu:componency-minecraft-tweaker-<MINECRAFT VERSION>-<MOD LOADER>:<VERSION>"
}

jar {
    manifest {
        attributes(
            "TweakClass": "dev.deftu.componency.minecraft.tweaker.ComponencyTweaker"
        )
    }
}
Kotlin (.gradle.kts)
dependencies {
    implementation("dev.deftu:componency-minecraft-<MINECRAFT VERSION>-<MOD LOADER>:<VERSION>")
    implementation("dev.deftu:componency-minecraft-tweaker-<MINECRAFT VERSION>-<MOD LOADER>:<VERSION>")
}

tasks.jar {
    manifest {
        attributes(
            "TweakClass" to "dev.deftu.componency.minecraft.tweaker.ComponencyTweaker"
        )
    }
}

致谢


即将推出!

  • 调试器


本项目根据 LGPL-3.0 许可协议授权
© 2024 Deftu

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

评论 0

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

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源