使用 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
* 解釋該模組的用途以及有關使用該模組的附加資訊。
* 每個模組的自述文件正在編寫中;目前並非每個模組都有自述文件