使用 Fabric 进行改装的基本钩子。
Fabric API 是 Fabric mods 的基本钩子和互操作机制的库。示例包括:
另请查看 Fabric Loader,它是为 Fabric 提供支持的(大部分)独立于版本的 mod 加载器。 Fabric API 是一个像任何其他 Fabric mod 一样的 mod,需要安装 Fabric Loader。
如需开发人员和用户的支持和讨论,请访问 Fabric Discord 服务器。
确保您首先安装了织物装载机。有关安装 Fabric Loader 的更多信息可以在此处找到。
要使用 Fabric API,请从 CurseForge、GitHub Releases 或 Modrinth 下载。
下载的 jar 文件应放置在您的mods
文件夹中。
要设置 Fabric 开发环境,请查看 Fabric 示例 mod 并按照其中的说明进行操作。示例 mod 已经依赖于 Fabric API。
要将完整的 Fabric API 包含在开发环境中的所有模块中,请将以下内容添加到 gradle 构建脚本中的dependencies
项块中:
modImplementation " net.fabricmc.fabric-api:fabric-api:FABRIC_API_VERSION "
modImplementation( " net.fabricmc.fabric-api:fabric-api:FABRIC_API_VERSION " )
或者,可以单独指定 Fabric API 中的模块,如下所示(包括模块 jar 到您的 mod jar):
// Make a collection of all api modules we wish to use
Set< String > apiModules = [
" fabric-api-base " ,
" fabric-command-api-v1 " ,
" fabric-lifecycle-events-v1 " ,
" fabric-networking-api-v1 "
]
// Add each module as a dependency
apiModules . forEach {
include(modImplementation(fabricApi . module(it, FABRIC_API_VERSION )))
}
// Make a set of all api modules we wish to use
setOf (
" fabric-api-base " ,
" fabric-command-api-v1 " ,
" fabric-lifecycle-events-v1 " ,
" fabric-networking-api-v1 "
).forEach {
// Add each module as a dependency
modImplementation(fabricApi.module(it, FABRIC_API_VERSION ))
}
可以使用 Gradle 属性来替换这些常量,而不是在整个构建脚本中硬编码版本常量。属性在项目根目录的gradle.properties
文件中定义。更多信息请点击此处。
看到 Fabric API 不支持的内容、错误或可能有用的内容?我们欢迎为改进 Fabric API 做出贡献。请务必阅读开发指南。
Fabric API 被设计为模块化以便于更新。这还有将代码库分割成更小的块的优点。
每个模块都包含自己的README.md
* 解释该模块的用途以及有关使用该模块的附加信息。
* 每个模块的自述文件正在编写中;目前并非每个模块都有自述文件