模组结构:修订间差异

本页面所适用的版本可能已经过时,最后更新于1.1
(咯咯炀移动页面Mod structure模组结构
→‎Tips
 
(未显示5个用户的5个中间版本)
第1行: 第1行:
{{需要翻译}}
{{version|1.1}}{{需要翻译}}
Mod 位于 该路径下 ''~\Paradox Interactive\Crusader Kings III\mod'', 里面必须包含:
Mods文件 位于 ''~\Paradox Interactive\Crusader Kings III\mod''  文件夹中
* Windows下的默认路径: {{cite file|%USERPROFILE%\Documents\Paradox Interactive\Crusader Kings III\mod}}
* Linux下的默认路径: {{cite file|~/.local/share/Paradox Interactive/Crusader Kings III/mod}}
每个mod需要两个部分:


* 一个 *.mod 文件于告诉启动器如何处理mod文件夹
* 一个<code>.mod</code>后缀的纯文本 文件 ,包含使 该mod所需的元数据
* mod 文件夹或 者是压缩包 包含 了mod 数据。mod数据 必须 和游戏本体中 CK2game.exe 所在路径 的文件 文件 夹架构一致 。注意文件和文件 在Mac和Linux 系统 需要 区分大小写。
 
* 一个mod 文件夹 <code>.zip</code>文件), 包含 此mod对游戏 修改内容,如事件、图像、决议和角色
 
两部分都 必须 位于上面 的文件 夹中,并且共享相同的名称,但 文件 扩展名除外;否则,游戏启动器将无法识别mod 注意 文件 和文件名在Mac和Linux上 区分大小写 的。
 
== 创建初始文件 ==
 
为了更为便捷以及避免人为错误,建议通过游戏启动器生成初始mod文件。
 
# 打开游戏启动器。
# 通过滚动或按“开始游戏”按钮下的 "Mod "标签,导航到 "Mods "部分。
# 点击"Mod工具 "按钮。
# 点击 "创建mod "按钮。
# 在这里,你可以创建你的mod,包括名称、版本(mod版本,而非游戏)、目录(将始终位于上述游戏的mod文件夹中)和任意标签。启动器提供的标签包括:
 
{| class="wikitable"
|-
| Alternative History || Historical
|-
| Balance || [[Map modding|Map]]
|-
| [[Bookmarks modding|Bookmarks]] || Portraits
|-
| Character Focuses || [[Religion modding|Religion]]
|-
| Character Interactions || Schemes
|-
| [[Culture modding|Culture]] || [[Sound modding|Sound]]
|-
| [[Decision modding|Decisions]] || Total Conversion
|-
| [[Event modding|Events]] || [[Localization|Translation]]
|-
| Fixes || Utilities
|-
| Gameplay || Warfare
|-
| Graphics
|}
 
也可以通过回到 "Mod工具 "菜单,然后在下拉列表中选择你的mod来更改建议的游戏版本、缩略图和描述(显示在创意工坊里)。
 
这个过程将创建以下内容。
* mod文件夹,以你的mod命名。
* 一个descriptor.mod文件,包含在mod文件夹内。
* 另一个.mod文件,这个文件以mod命名,位于mod文件夹旁边


== *.mod 文件 ==
== *.mod 文件 ==


  注意: 使 用Crusader Kings III启动器,您可以通过导航到 <Mods> -> <Mod Tools (Next to Manage Mods)> -> <Create Mod> 并键入以下内容来生成mod 文件 夹及 对应 的* .mod文件。 相应 名称,版本 版本兼容性 图标 标签和mod 文件夹 目录/存档 由于以 种方式开始创建mod容易得多 ,因 此强烈建议您首先进 此操作,然后根据 需要 对* .mod 文件 进行更改。
  游戏 使 用的.mod文件是纯文本 文件 中包含了相应mod 元数据。每个mod都有两个.mod文件。
* (modname).mod ,位于mod的 文件 夹旁边 这个是必须 的, 没有它 启动器将无法识别mod。
* descriptor.mod 位于mod 文件夹 建议 个文件和其他文件保持一致,删除文件中包含path键的行 ,因 为这一 并不 需要 出现在描述 文件


== mod 文件 ==
=== 语法 ===
 
  与其他游戏 文件 类似,单行注释可以使用哈希(#)开始。要将一个值设置为一个键,对于单个值使用格式key="value";对于列表则使用以下结构
<pre>
list={
"element0"
"element1"
"element2"
}
</pre>
 
=== 键 ===
下表描述了可在.mod文件中使用的键。


.mod 文件的内容:
{| class="wikitable"
{| class="wikitable"
! 键
! 是否必需
! 描述
! 示例
|-
|-
! Key !! Required? !! Effect !! Example
| name
| 是
| 用于确定启动器中显示的名称。
| name="My Mod"
 
|-
|-
| name || Yes ||  在启动器中显示的名称 || name="My Mod"
| version
|
允许你为你的mod定义使用版本,该键定义为一个字符串。
| version="0.0.1"
 
|-
|-
| path || Yes || Defines which folder is the mod's folder. It is NO LONGER RELATIVE to The CK3 folder. Instead, you must use the entire file path. || path = "C:/Users/Example/Documents/Paradox Interactive/Crusader Kings III/mod/my_mod"
| tags
|
| 设置mod被认为属于的标签。与 Steam Workshop 的类别相关联。
|
<pre>
tags={
"Culture"
"Decisions"
"Fixes"
}
</pre>
 
|-
|-
| version || No ||  允许你为mod 定义 一个 版本, 类型是字 || version="0.0.1"
| supported_version
| 在mod目录里的文件是必需的;
在descriptor.mod中不是必需的
| 定义 该mod支持的最新版本;如果mod支持版本低于游戏 版本, 启动器会弹出警告。CK3使用语义化版本(即主版本号.次版本号.修订号)。通配 <code>*</code>可用于定义版本范围。
| supported_version="1.1.3"
 
|-
|-
| picture || No || Determines the Steam Icon. || picture="thumbnail.png"
| path
| 在mod目录里的文件是必需的;
在descriptor.mod中不是必需的
| 设置哪个文件夹是mod的文件夹。注意,它不再是相对于''Crusader Kings III''主文件夹,而是相对于《十字军之王III》用户文件夹(如上所述)。另外,也可以使用整个路径。
|
* <code>path="C:/Users/Example/Documents/Paradox Interactive/Crusader Kings III/mod/my_mod"</code> (Windows)
* <code>path="/home/example/.local/share/Paradox Interactive/Crusader Kings III/mod/my_mod"</code> (Linux)
* <code>path="mod/my_mod"</code> (Relative, any OS)
|-
| remote_file_id
| 如果要上传和更新Steam创意工坊mod,则必需。当mod上传时,该键会自动设置。
| 必须与mod的Steam Workshop ID匹配。可以在Steam Workshop URL的末尾找到, 例如编号"2220762808"的mod位于 https://steamcommunity.com/sharedfiles/filedetails/?id=2220762808.
| remote_file_id="2220762808"
 
|-
| picture
|
| Determines the Steam icon.
| picture="thumbnail.png"
|}
|}
=== 基础例子 ===
下面的例子展示了一个.mod文件的基本内容。请随意复制并粘贴到您自己的.mod文件中,记得更改具体细节以符合您自己的mod和游戏版本。注意,descriptor.mod文件不需要path键。
<pre>
version="0.0.1"
tags={
"Culture"
"Decisions"
"Fixes"
}
name="My Mod"
supported_version="1.1.3"
path="mod/my_mod"
</pre>
== Mod文件夹 ==
用来编辑游戏的文件必须放在mod文件夹里面,然后再由游戏加载。这些文件往往要放在特定的文件夹里,否则可能无法被游戏加载。下面列出了一些常见的例子
{| class="wikitable"
! Type
! Folder
|-
| Events
| events
|-
| Decisions
| common\decisions
|-
| Defines
| common\defines
|-
| Traits
| common\traits
|}
具体内容,可以使用本页底部的导航框查阅相关的修改页面,或者在游戏文件中查找 (Windows/Steam: {{cite file|C:/Program Files (x86)/Steam/steamapps/common/Crusader Kings III/game}}) 并将给定文件的文件夹结构复制到(并不包含) {{cite file|game}} 文件夹中
== Tips ==
* 当编辑你的mod文件夹和.mod文件时,你可以在启动器中重新加载mods来更新它们,而无需重新启动它。在 "mods "部分,按 "Manage all mods",然后按 "Reload installed mods"。如果你的mod没有显示出来,可以尝试这一操作。
* 一旦你创建了你的初始mod结构,强烈建议你使用某种形式的备份系统(就像把你的文件复制到别的地方一样简单),或者源代码控制,比如Git / GitHub。如果你丢失了你的mod文件或以某种方式破坏了你的mod,而你又想回到一个旧的版本,这将会有很大的帮助。
* 当创建你的.mod文件时,确保你正确地遵循语法规则,否则你的mod可能根本不会显示出来。例如,注意在需要的地方使用引号(""),尤其是在路径和名称等值的周围。
* 检查所有地方的拼写,包括文件和文件夹的内容和名称。即使是最简单的错误也会造成很大的问题。
{{Modding navbox}}
{{Modding navbox}}
[[Category:模组制作]]
[[Category:模组制作]]
[[en:Mod structure]]
[[en:Mod structure]]

2024年1月21日 (日) 23:00的最新版本

Mods文件位于 ~\Paradox Interactive\Crusader Kings III\mod 文件夹中

  • Windows下的默认路径: %USERPROFILE%\Documents\Paradox Interactive\Crusader Kings III\mod
  • Linux下的默认路径: ~/.local/share/Paradox Interactive/Crusader Kings III/mod

每个mod需要两个部分:

  • 一个.mod后缀的纯文本文件,包含使用该mod所需的元数据
  • 一个mod文件夹(或.zip文件),包含此mod对游戏的修改内容,如事件、图像、决议和角色

两部分都必须位于上面的文件夹中,并且共享相同的名称,但文件扩展名除外;否则,游戏启动器将无法识别mod。请注意,文件夹和文件名在Mac和Linux上是区分大小写的。

创建初始文件[编辑 | 编辑源代码]

为了更为便捷以及避免人为错误,建议通过游戏启动器生成初始mod文件。

  1. 打开游戏启动器。
  2. 通过滚动或按“开始游戏”按钮下的 "Mod "标签,导航到 "Mods "部分。
  3. 点击"Mod工具 "按钮。
  4. 点击 "创建mod "按钮。
  5. 在这里,你可以创建你的mod,包括名称、版本(mod版本,而非游戏)、目录(将始终位于上述游戏的mod文件夹中)和任意标签。启动器提供的标签包括:
Alternative History Historical
Balance Map
Bookmarks Portraits
Character Focuses Religion
Character Interactions Schemes
Culture Sound
Decisions Total Conversion
Events Translation
Fixes Utilities
Gameplay Warfare
Graphics

也可以通过回到 "Mod工具 "菜单,然后在下拉列表中选择你的mod来更改建议的游戏版本、缩略图和描述(显示在创意工坊里)。

这个过程将创建以下内容。

  • mod文件夹,以你的mod命名。
  • 一个descriptor.mod文件,包含在mod文件夹内。
  • 另一个.mod文件,这个文件以mod命名,位于mod文件夹旁边。

*.mod 文件[编辑 | 编辑源代码]

游戏使用的.mod文件是纯文本文件,其中包含了相应mod的元数据。每个mod都有两个.mod文件。

  • (modname).mod,位于mod的文件夹旁边。这个是必须的,没有它,启动器将无法识别mod。
  • descriptor.mod,位于mod文件夹内。建议这个文件和其他文件保持一致,删除文件中包含path键的行,因为这一行并不需要出现在描述文件中

语法[编辑 | 编辑源代码]

与其他游戏文件类似,单行注释可以使用哈希(#)开始。要将一个值设置为一个键,对于单个值使用格式key="value";对于列表则使用以下结构

list={
	"element0"
	"element1"
	"element2"
}

[编辑 | 编辑源代码]

下表描述了可在.mod文件中使用的键。

是否必需 描述 示例
name 用于确定启动器中显示的名称。 name="My Mod"
version 允许你为你的mod定义使用版本,该键定义为一个字符串。 version="0.0.1"
tags 设置mod被认为属于的标签。与 Steam Workshop 的类别相关联。
tags={
	"Culture"
	"Decisions"
	"Fixes"
}
supported_version 在mod目录里的文件是必需的;

在descriptor.mod中不是必需的

定义该mod支持的最新版本;如果mod支持版本低于游戏版本,启动器会弹出警告。CK3使用语义化版本(即主版本号.次版本号.修订号)。通配符*可用于定义版本范围。 supported_version="1.1.3"
path 在mod目录里的文件是必需的;

在descriptor.mod中不是必需的

设置哪个文件夹是mod的文件夹。注意,它不再是相对于Crusader Kings III主文件夹,而是相对于《十字军之王III》用户文件夹(如上所述)。另外,也可以使用整个路径。
  • path="C:/Users/Example/Documents/Paradox Interactive/Crusader Kings III/mod/my_mod" (Windows)
  • path="/home/example/.local/share/Paradox Interactive/Crusader Kings III/mod/my_mod" (Linux)
  • path="mod/my_mod" (Relative, any OS)
remote_file_id 如果要上传和更新Steam创意工坊mod,则必需。当mod上传时,该键会自动设置。 必须与mod的Steam Workshop ID匹配。可以在Steam Workshop URL的末尾找到, 例如编号"2220762808"的mod位于 https://steamcommunity.com/sharedfiles/filedetails/?id=2220762808. remote_file_id="2220762808"
picture Determines the Steam icon. picture="thumbnail.png"

基础例子[编辑 | 编辑源代码]

下面的例子展示了一个.mod文件的基本内容。请随意复制并粘贴到您自己的.mod文件中,记得更改具体细节以符合您自己的mod和游戏版本。注意,descriptor.mod文件不需要path键。

version="0.0.1"
tags={
	"Culture"
	"Decisions"
	"Fixes"
}
name="My Mod"
supported_version="1.1.3"
path="mod/my_mod"

Mod文件夹[编辑 | 编辑源代码]

用来编辑游戏的文件必须放在mod文件夹里面,然后再由游戏加载。这些文件往往要放在特定的文件夹里,否则可能无法被游戏加载。下面列出了一些常见的例子

Type Folder
Events events
Decisions common\decisions
Defines common\defines
Traits common\traits

具体内容,可以使用本页底部的导航框查阅相关的修改页面,或者在游戏文件中查找 (Windows/Steam: C:/Program Files (x86)/Steam/steamapps/common/Crusader Kings III/game) 并将给定文件的文件夹结构复制到(并不包含) game 文件夹中

Tips[编辑 | 编辑源代码]

  • 当编辑你的mod文件夹和.mod文件时,你可以在启动器中重新加载mods来更新它们,而无需重新启动它。在 "mods "部分,按 "Manage all mods",然后按 "Reload installed mods"。如果你的mod没有显示出来,可以尝试这一操作。
  • 一旦你创建了你的初始mod结构,强烈建议你使用某种形式的备份系统(就像把你的文件复制到别的地方一样简单),或者源代码控制,比如Git / GitHub。如果你丢失了你的mod文件或以某种方式破坏了你的mod,而你又想回到一个旧的版本,这将会有很大的帮助。
  • 当创建你的.mod文件时,确保你正确地遵循语法规则,否则你的mod可能根本不会显示出来。例如,注意在需要的地方使用引号(""),尤其是在路径和名称等值的周围。
  • 检查所有地方的拼写,包括文件和文件夹的内容和名称。即使是最简单的错误也会造成很大的问题。