scafall

模组

· 作者 WolfyScript

用于 Minecraft 类的简单包装器,使跨平台 API 开发更加容易,以及额外的工具来帮助进行跨平台的插件和模组开发。

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

最新 1.0-alpha.3.0+spigot · 26.3 · Spigot

一键开服(送7天)

scafall 的主要目标是提供一种轻量级的包装方案,用于创建跨平台 API。
次要目标是为各平台最常用的部分提供工具,例如任务与调度,或为 Adventure 等库提供 Kotlin 特定的便捷工具。

注意:Scafall 是一个开发库,并非供玩家使用或提供游戏功能。其他插件/模组可能将其作为依赖项。

代理接口

Scafall 通过提供简单的包装器接口来避免包装每一个平台/Minecraft 特性,这些接口仅作为一种代理使用。

  1. API(由插件/模组开发者创建)在函数中接受包装器作为参数(例如 ScafallItemStack)。
  2. 这些函数的实现会将包装器参数 unwrap() 解包为原生 Minecraft 对象,使用这些对象进行操作(例如 ItemStack),并将任何返回值 wrap() 包装起来。
  3. 其他模组/插件会将其平台特定的对象(例如 org.bukkit.inventory.ItemStack)wrap() 包装,然后传入 API。

这些接口非常轻量,仅提供对包装对象极少属性的访问。 其理念是纯粹将它们用作模组/插件、API 和实现之间的传输层,从而便于在不同平台间共享通用代码。

Wrapping and Unwrapping: Third-Party Mods/Plugins <--unwrap/wrap--> API <--wrap/unwrap--> Implementation

Scafall 以 Minecraft 为基准真理,因此代理始终包装原生的 Minecraft 类型。
当包装其他平台类型时,这些类型首先会被转换为原生的 MC 类型。 (Spigot/Paper 对象通常是包装器本身,在这种情况下,它直接使用那个被包装的值)

限制与内存问题

包装器与其所对应的原生类型面临相同的限制。这意味着永远不应该尝试将包装器存储在列表或映射中,否则会导致内存泄漏。 它们仅应被用作 API 调用的参数或返回值。

开发中

这仍然是一个处于开发中的项目,因此不要期望一切都能无缝运行。 目前尚未保证 API 兼容性,但最终会提供支持。 当前的 API 仍不稳定,随时可能在未通知的情况下更改!

附加模块/库

本项目的主要目的是真正提供基本的脚手架并协助开发过程。
附加模块/库可能会使用 scafall 来提供更细分的 API 和工具。

  • viewportl - 基于 Compose Runtime 的 Minecraft UI 框架,用于构建强大、响应式且高效的 UI。
    (使用 scafall 使其能够创建跨平台 UI)

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

评论 0

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

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源