Fabric 安裝器

• Fabric 安裝器
  • 實用資源
  • 獲取 Fabric Loader Artifact
    • 向 Fabric Meta API 傳送請求
  • 初始化安裝器
  • 開始安裝
  • 報告安裝進度

TIP

請注意, ProjBobcat 僅實現了 Fabric 自動化安裝流程, 您仍然需要自己實現 Fabric 安裝包的搜尋、下載、儲存流程.

實用資源

• Fabric 官方網站
• Fabric Meta API

獲取 Fabric Loader Artifact

由於 ProjBobcat 的 Fabric 安裝器要求您在初始化安裝器時提供來自 Fabric 官方的 Loader Artifact 資訊. 因此, 我們將在這裡簡要描述如何根據指定的 MineCraft 版本來獲取該資訊.

INFO

在該示例中, 我們將使用 MineCraft 1.19.2 來向您展示如何獲取.

向 Fabric Meta API 傳送請求

首先, 您需要向 https://meta.fabricmc.net/v2/versions/loader/[MC_VERSION] 傳送一個 HTTP GET 請求. 將 [MC_VERSION] 替換為您想要安裝的 MineCraft 版本. 在這裡, 我們將使用 1.19.2.

您將看到類似下面的返回內容：

[
  {
    "loader": {
      "separator": ".",
      "build": 11,
      "maven": "net.fabricmc:fabric-loader:0.14.11",
      "version": "0.14.11",
      "stable": true
    },
    "intermediary": {
      "maven": "net.fabricmc:intermediary:1.19.2",
      "version": "1.19.2",
      "stable": true
    },
    "launcherMeta": {
      "version": 1,
      "libraries": {...},
      "mainClass": {...}
    }
  },
  {...},
  {...}
]

Fabric Meta API 將返回一個 JSON 陣列, 陣列中的每一個元素即是我們需要的 Loader Artifact.

將 JSON 返回轉換為 ProjBobcat 型別

如果您在您的專案中使用 JSON.NET（Newtonsoft.JSON）. 您可以使用類似下面的程式碼來將您獲取到的伺服器響應轉換為對應的 ProjBobcat 型別：

// 從 Fabric Meta API 請求資料（示例, 非實際程式碼）
...
var responseJson = await res.Content.ReadAsStringAsync();

// 將 JSON 響應轉換為 ProjBobcat 型別
var artifacts = JsonConvert.DeserializeObject<List<FabricLoaderArtifactModel>>(responseJson); 

// 獲取使用者想要安裝的版本（示例, 非實際程式碼）
var userSelect = vm.SelectedArtifactIndex;

// 獲取單個 Loader Artifact
var selectedArtifact = artifacts[userSelect]; 

此處, selectedArtifact 即是 Fabric 安裝器所需要的 FabricLoaderArtifactModel.

初始化安裝器

初始化 Fabric 安裝器的方式非常簡單. 您需要使用到在先前步驟中取得的 selectedArtifact 來初始化安裝器：

var fabricInstaller = new FabricInstaller
{
    LoaderArtifact = selectedArtifact,
    VersionLocator = [VERSION_LOCATOR_INST],
    RootPath = "[GAME_ROOT_PATH]",
    CustomId = "[CUSTOM_INSTALL_GAME_ID]",
    InheritsFrom = "[MC_VERSION_OR_GAME_ID]"
};

在上述程式碼塊中, 請將這些引數按照您的實際情況替換：

專案	說明
[GAME_ROOT_PATH]	遊戲根目錄, 通常為 .minecraft 資料夾的路徑
[CUSTOM_INSTALL_GAME_ID]	可選項, 自定義即將要安裝的遊戲的名稱
[MC_VERSION_OR_GAME_ID]	Forge 繼承的 MineCraft 原版遊戲版本, 通常為遊戲版本. 例如：1.19.2
[VERSION_LOCATOR_INST]	遊戲版本定位器例項, 即初始化遊戲核心時的 VersionLocator 屬性

開始安裝

在您完成安裝器的初始化後, 您只需要呼叫 Fabric 安裝器的安裝方法來完成安裝.

在非同步上下文中, 使用 InstallTaskAsync 來完成安裝：

await fabricInstaller.InstallTaskAsync();

在同步上下文中, 使用 Install 來完成安裝：

fabricInstaller.Install();

報告安裝進度

在某些情況下, Fabric 安裝器可能會需要數分鐘的時間來完成安裝. 因此, 您可能需要實時向用戶彙報安裝器目前的進度. 為此, Fabric 安裝器提供了 StageChangedEventDelegate 事件來幫助您實現任務彙報. 您只需要簡單地在 開始安裝之前 註冊下面的事件：

fabricInstaller.StageChangedEventDelegate += (_, args) => {
    ReportProgress(args.Progress, args.CurrentStage);
};

其中, args.Progress 指示了安裝器當前的百分比進度. args.CurrentStage 則是安裝器當前進度的文字描述.