模组:Content Patcher

“	“我這裏還有很多事情需要處理。”
	— 羅賓

不完整的翻譯

本文或部分尚未完全翻譯成中文。歡迎您通過編輯幫助其建設。
最後編輯1059 Studio於2021-04-16 00:45:17.

想為遊戲創建內容包模組嗎？教程就在這裏。有關如何使用模組，請參閱模組:使用指南/入門

快速開始

此頁面是對創建 Content Patcher 的內容包的簡要介紹。如果你不需要介紹，請參閱完整的技術資料

基本概念

什麼是 Content Patcher ？

Content Patcher是一種 SMAPI 模組，可更改遊戲資源（圖像、對話、數據和地圖），而無需替換遊戲文件或編寫代碼。可以通過創建包含幾個 JSON 文件（基本上是文本）的內容包（基本上是文件夾）來使用它。只需編輯 JSON 文件就可以：

替換一個圖像文件
製作季節性的變化
根據天氣、日期、與其他 NPC 的關係等進行更改
進行非常具體的更改（例如，在完成喬家超市獻祭之後，在下雪的冬天的周末，咖啡價格會更高）
以及更多

資源 Assets

一個 asset 本質上是遊戲中的 Content 文件夾，具有唯一的「資源名稱」。資產名稱從不包含 Content路徑、語言或文件擴展名（可以使用令牌來定位特定的語言）。例如：

文件	資源名稱
`Content/Portraits/Abigail.xnb`	`Portraits/Abigail`
`Content/Maps/spring_beach.xnb` `Content/Maps/spring_beach.es-ES.xnb` `Content/Maps/spring_beach.fr-FR.xnb`	`Maps/spring_beach`

一個資源可能包含多個子畫面或數據條目。例如：Portraits/Abigail：

因此，如果想更改阿比蓋爾的肖像，則可以使用 Content Patcher 加載或編輯 Portraits/Abigail.

Load 和 Edit

可以通過兩種概念上的方式來更改資源：

Load the initial version of an asset. Each asset can only be loaded by one mod at the same time. This is mainly useful for total replacement mods (like a mod that completely changes an NPC's portraits), or to provide files that don't exist in the Content folder.
Edit an asset after it's loaded. Any number of edits can be applied to the same asset.

For example, let's say the game needs Abigail's portraits. This is how changes are applied:

                                           ┌────────────┐
                                           │ edit asset │
                         ┌────────────┐    ├────────────┤
get Portraits/Abigail ──>│ load asset │───>│ edit asset │──> portrait asset
                         └────────────┘    ├────────────┤
                                           │ edit asset │
                                           └────────────┘

This is divided into four main action types (Load, EditData, EditImage, EditMap), which are explained in more detail in the Content Patcher readme (see below).

Get started

Intro to JSON

You'll notice a lot of files with .json at the end of the name when creating mods for Stardew Valley. That means they're formatted as JSON, which is just a way of writing text that's readable to code. If you haven't used JSON before, reading An Introduction to JSON first will be very helpful to understand what the files are doing.

Create example mod

First let's get our basic content pack up and running:

Install SMAPI and Content Patcher.
Unpack the game's Content folder so you can see what each asset contains (see Modding:Editing XNB files#Unpack game files).
Create a SMAPI content pack.

Create a content.json file in the same folder with this content:

{
   "Format": "2.0.0",
   "Changes": [
   ]
}

Launch the game.

If you did everything correctly so far, you should see the new mod under "Loaded X content packs" in the SMAPI console. (If not, review the above steps or ask for help.)

Content format

The content.json file you created above is what tells Content Patcher what to change. This has two main fields:

Format: the format version. You should always use the latest version (currently 1.19.0) to enable the latest features and avoid obsolete behavior.
Changes: the changes you want to make. Each entry is called a patch, and describes a specific action to perform: replace this file, copy this image into the file, etc. You can list any number of patches.

You can list any number of patches in the Changes field, each surrounded by { and }. See the next section for more info, but here's a quick example:

{
   "Format": "2.0.0",
   "Changes": [
      {
         "Action": "Load",
         "Target": "Animals/Dinosaur",
         "FromFile": "assets/dinosaur.png"
      },

      {
         "Action": "EditImage",
         "Target": "Maps/springobjects",
         "FromFile": "assets/fish-object.png"
      },
   ]
}

(There are other fields like ConfigSchema and DynamicTokens for more advanced usage; these are covered in the full readme.)

Next steps

You've created a Content Patcher pack!

For help making it do something, see...

Content Patcher readme for the full reference;
video intro to Content Patcher (unofficial);
intro to converting XNB mods (unofficial).

Examples

(We'll have a guided tutorial here soon.)

Change horse/pet icons

For edits to replace the look of horses and/or pets (cats and dogs), you can add these to your content.json in order to also replace the little head icon in the inventory menu:

For horses:

//horse head in inventory
{
   "Action": "EditImage",
   "Target": "LooseSprites/Cursors",
   "FromFile": "yourfile.png",
   "FromArea": { insert values here }, 
   "ToArea": { "X": 192, "Y": 192, "Width": 16, "Height": 16 }
}

For dogs:

//dog head in inventory

"ToArea": { "X": 208, "Y": 208, "Width": 16, "Height": 16 }, //Dog 1

"ToArea": { "X": 224, "Y": 208, "Width": 16, "Height": 16 }, //Dog 2

"ToArea": { "X": 240, "Y": 208, "Width": 16, "Height": 16 }, //Dog 3

For cats:

//cat head in inventory

"ToArea": { "X": 160, "Y": 208, "Width": 16, "Height": 16 }, //Cat 1 

"ToArea": { "X": 176, "Y": 208, "Width": 16, "Height": 16 }, //Cat 2 

"ToArea": { "X": 192, "Y": 208, "Width": 16, "Height": 16 }, //Cat 3