BlossomBridge API

BlossomBridge

一个小型的 API，用于 Tywrap Studios 的模组，添加了一些次要功能。

---

自 BBAPI 版本 2.1.0 起（目前仅以 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 的 Config 类，然后你可以创建一个新的 ConfigManager 来加载并使用它。同时，再构造一个 LoggingHandler，你就可以开始了！

不要使用 BlossomBridge 类！事实上，不要使用 main 包中的任何内容！
main 包中的任何内容都不是 API 的一部分，而是用于代码中实际的“模组”部分！
所有属于 API 的内容都在 api 包中（当然）

作为示例，我建议看一下 Constructra，它实现并使用了此 API 的大量代码。