模组:内容包

Horizon98讨论 | 贡献2021年4月14日 (三) 11:24的版本

目录

内容包是由特定内容包框架加载的文件的集合(就像一个子模组)。内容包可以包含任何文件,但通常需要包含 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 文件夹内创建子文件夹,并非强制要求。