模组:內容包

出自Stardew Valley Wiki
跳至導覽 跳至搜尋

目錄

內容包是由特定內容包框架加載的文件的集合(就像一個子模組)。內容包可以包含任何文件,但通常需要包含 JSON 文件和圖片。

對於玩家

如果要使用內容包,請像安裝 SMAPI 模組一樣安裝它(參閱模組使用指南),同時確保你已經安裝了它需要的前置模組。

對於模組製作者

創建一個內容包

  1. 確定你要使用哪個內容包框架(每個框架定義了需要的特定文件)。
  2. 安裝 SMAPI
  3. 創建通用內容包格式(適用於所有框架):
    1. 打開遊戲的 Mods 文件夾(位於遊戲文件夾的根目錄中)。
    2. 添加具有所需名稱的子文件夾 (參閱文件夾命名約定)。
    3. 在子文件夾中添加一個 manifest.json 文件並在其中添加 ContentPackFor 鍵值(參閱清單格式)。
  4. 添加內容包框架所需的文件(有關詳細信息,請查看你使用的前置模組主頁面)。
  5. 啟動遊戲,並確保新內容包出現在 SMAPI 控制台的「Loaded X content packs」下。

發佈你的內容包

  1. 在清單文件中添加一個更新鍵(如果你還未創建的話)。
  2. 在 Manifest 中更新 Version 鍵值(每次發佈新版本的模組時,請務必更新版本號!SMAPI 將使用該鍵值檢查更新及其兼容性)。
  3. 創建一個包含內容包文件夾的 .zip 壓縮包。
  4. 將壓縮包上傳至 Nexus Mods

在你發佈的模組描述中,請提供詳細的安裝步驟,這將有助於減少玩家遇到的問題。 BBCode 示例:

[size=5]安装方法[/size]
[list=1]
[*][url=https://smapi.io]安装最新版本的 SMAPI[/url]。
[*][url=<前置模组的下载链接>]安装 <前置模组的名称>[/url]。
[*]下载文件并解压到 [font=Courier New]Stardew Valley/Mods[/font] 文件夹。
[*]通过 SMAPI 启动游戏。
[/list]

讀取內容包

如果你正在編寫可讀取內容包的 SMAPI 模組,參閱模組:製作指南/APIs/Content Packs(英)

約定

下面是一些推薦的做法,但並非強制規定。

文件夾命名

文件夾應該使用駝峰式大小寫進行命名(單詞之間不空格,大寫每個單詞的首字母),並加上適用前置模組的前綴。例如,一個文件夾名為 [CP] SampleName ,便表明這個模組是 Content Patcher 的內容包。

下面是一些常用的前綴:

前綴 前置模組
[AHM] Animal Husbandry Mod
[BAGI] Better Artisan Goods Icons
[BFAV] Better Farm Animal Variety
[CF] Custom Furniture
[CFR] Custom Farming Redux
[CM] Custom Music
[CP] Content Patcher
[FR] Farmhouse Redone
[FTM] Farm Type Manager
[JA] Json Assets
[MFM] Mail Framework Mod
[MTN] More Than Necessary
[PFM] Producer Framework Mod
[PP] Pond Painter
[STF] Shop Tile Framework
[TMX] TMX Loader

文件夾結構

每個文件夾應包含這些文件:manifest.jsoncontent.json(或是符合你使用的框架的json文件),包含模組其餘所需文件的 assets 文件夾。其中可能包括 png、其他 json 文件或 tbin 文件。你也可以根據個人需要在 assets 文件夾內創建子文件夾,並非強制要求。