BlossomBridge API

模组

· 作者 Tiazzz

Tywrap Studios 模组的小型 API,添加了几个小功能。

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

需要前置:Fabric Language Kotlin

最新 2.0.2 · 1.21.8 · Fabric / Quilt

一键开服(送7天)

BlossomBridge

Tywrap Studios 模组使用的小型 API,添加了一些次要功能。


自 2.1.0 版本的 BBAPI(目前仅作为 master-SNAPSHOT 可用)起,建议将 API 捆绑到你的项目中,而不是依赖此模组,并转而依赖 Fabric Language Kotlin。因此,你在此页面上能找到的最大可下载版本为 2.0.2。我们将不再发布此模组的 jar 文件,以保持尽可能高的兼容性。

对于开发者:请在 2.1.0 更新文档 发布后尽快阅读,以了解如何正确更新你的 BBAPI 版本,然后按照后续更新文档操作,直至最新版本。祝好运!


例如:

  • 利用 Jankson 和一些逻辑魔法实现的配置系统。
  • 简单但专业的日志系统,用于保持所有模组日志格式的一致性。
  • 良好的 JavaDoc,以便你能真正正确地理解代码。

面向开发者:

项目设置

想在你的模组中使用此 API?
尽管用吧!但要记住,这里的大部分内容都是针对我们工作流特定的,因此可能不适用于你的用例。
此外,目前的代码相当精简,所以很多时候并不值得。

Gradle 设置

BlossomBridge 可以像其他 Fabric 模组一样轻松依赖。
只需在你的 build.gradle 文件中添加以下内容:

repositories {
    maven { url "https://jitpack.io" }
}

dependencies {
    // 其他依赖...
    
	modImplementation("com.github.Tywrap-Studios:BlossomBridge:${project.blossombridge_version}")
}

并在你的 gradle.properties 文件中添加这一行:

blossombridge_version="1.1.1"
# 或者你想使用的任何版本 :)

始终建议使用最新的 STABLE 版本,这样你就不会遇到 WIP 功能的意外问题。
最后但同样重要的是,你需要在 fabric.mod.json 文件中添加以下内容:

{
    "depends": {
        "blossombridge": "1.1.1"
    }
}

模组设置

一旦你将模组添加到项目中,就可以开始使用了!
所有代码都通过 JavaDoc 进行了详细记录,你应该能够弄清楚如何使用它。

作为一般准则,你可以这样做:创建一个继承 AbstractConfig 的配置类,然后创建一个新的 ConfigManager 来加载和使用它。同时,构建一个 LoggingHandler,你就可以正常使用了!

不要使用 BlossomBridge 类!事实上,不要使用 main 包中的任何东西!
main 包中的所有内容都不是 API 的一部分,而是属于实际“模组”部分的代码!
所有 是 API 的内容都在 api 包中(当然)。

举个例子,我建议查看 Constructra,它实现并使用了大量此 API 的代码。

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

评论 0

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

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源