创建模组:修订间差异

本页面讲述的内容长期有效
(merge from offical wiki)
 
无编辑摘要
 
(未显示5个用户的23个中间版本)
第1行: 第1行:
{{version|Timeless}}
{{version|Timeless}}
本教程详细说明了创建基本mod所需的步骤。


This tutorial explains in details the steps required to create a basic mod.
同时你也可以复制和修改现有的模组来达成相同效果。不过要注意的是通过[[Steam创意工坊]]安装的模组,它们的包装方式不太相同。


Note that another approach is to copy/paste and modify an existing mod (though not a mod installed via [[Steam Workshop]] since these are packaged differently).


It is assumed that the OS is Windows, but this could apply to MacOS or Linux with few changes.
此处基于的操作系统(作业系统)是Windows,但是理论上在MacOS和Linux不会有太大不同。


== Prerequisites ==
== 先决条件==


* Install a good text editor (like [http://notepad-plus-plus.org Notepad++]), since default Notepad on Windows screws the file encoding.
* 安装一个好的文件编辑器(像是[http://notepad-plus-plus.org Notepad++] ),因为因为Windows上预设的记事本会改变文件编码。


== Steps ==
== 步骤==


=== Create the CK2 mod directory ===
=== 创建CK2的模组目录===


There are 2 different directories involved:
这里涉及到两个不同的目录:


* The CK2 install directory: it contains the base game files, which should not be modified directly and considered 'read-only' (modifications will be lost when Steam is updating). It can be found via Steam: find CK2 in your games library, right click on the name and select ''properties'' in the menu. Choose the ''local files'' tab and then press ''browse local files''.
*CK2 的安装目录:它包含游戏的基本文件,最好不要尝试修改,并考虑' 唯读模式' (任何的修改会在Steam更新时丢失)
**这个目录可以通过Steam找到:在游戏库中找到CK2,右键单击名称,然后在菜单中选择“属性”。 选择“本地文件”选项卡,然后按“浏览本地文件”。安装目录的路径通常含有: <code>steamapps\common\Crusader Kings II</code>.


* The CK2 user files: it contains the user data (saves, game preferences, logs and mods). The path is <code>~/My Documents/Paradox Interactive/Crusader Kings II/</code>. <code>~</code> is the home directory, depending on your configuration and Windows version, this could look like: <code>C:\Users\<YourUser>\Documents\Paradox Interactive\Crusader Kings II</code>
*CK2 的使用者文件: 它包含使用者的数据(存档、游戏设定、日志和模组。
**路径通常是<code>~/My Documents/Paradox Interactive/Crusader Kings II/</code>
**<code>~</code> 是主目录,根据你的配置和Windows版本,它可能长得像:<code>C:\Users\<YourUser>\Documents\Paradox Interactive\Crusader Kings II</code>, 而在Linux上,它可能长得像: <code>~/.paradoxinteractive/Crusader Kings/</code>.


''Tip'': you may create shortcuts to these directories on your desktop.
''' 小提示''':你可以在桌面上创建这些目录的快捷方式。


'''Step 1''': Create a mod folder <code>~/My Documents/Paradox Interactive/Crusader Kings II/mod/</code>, if it doesn't exist.
''' 第一步''' :如果不存在mod资料夹,就自行创建一个。<code>~/My Documents/Paradox Interactive/Crusader Kings II/mod/</code>


''Note'': there is also a legacy <code>common\Crusader Kings II\mod\</code> folder in the CK2 install directory, but it must not be used to store mods.
''' 注意''':在游戏文件的目录也存在一个同名资料夹<code>common\Crusader Kings II\mod\</code> 但是保存在里面的模组不会被读取。


=== Create the .mod file ===
=== 创建.mod 文件 ===


The .mod format here is just a plain text file, saved with .mod file extension instead of the .txt extension.
.mod 格式只是个纯文本的文件,使用.mod 文件扩展名而不是.txt 扩展名保存。


''Tip'': most CK2 files use .txt extension, but there is also .csv (localization), .gfx (graphics), .sfx (sounds), .gui (interface), .lua (global variables) and .info (documentation).
''' 小提示''':大部分CK2 文件的扩展名是.txt, 但有时也会是.csv ( 国家名称和时间描述), .gfx ( 图像图片), .sfx ( 音效音乐), .gui ( 图形界面), .lua ( 全局变量) and .info ( 文档文件)


'''Step 2''': Create an empty file named "mymod.mod" in the CK2 mod folder (<code>~/My Documents/Paradox Interactive/Crusader Kings II/mod/mymod.mod</code>).
''' 第二步''' :创建一个文件名为“mymod.mod ”的空文件,放到 CK2 mod 文件夹下(<code>~/My Documents/Paradox Interactive/Crusader Kings II/mod/mymod.mod</code>).


''Note'': make sure the file extension is .mod (and not .mod.txt) - disable "Hide Known Extensions" option of Windows explorer.
''' 注意''':请确认你的文件扩展名是'.mod'(而不是‘.mode.txt') - 在Windows系统的文件管理器中禁用“隐藏已知扩展”的选项。


'''Step 3''': Open the file with your editor and add:
''' 第三步''': 用你的编辑器打开.mod文件,并在里面添加一下内容:


<pre>
<pre>
第44行: 第47行:
</pre>
</pre>


''Notes'': 
'' 注意'': 
* Don't forget the quotes, it is mandatory in case there is a space.
* 不要忘记引号,这是强制性的,以防有空格。
* Save the file with ANSI (Windows-1252) encoding. This is true for all CK2 files: never use UTF-8 encoding (with or without 'BOM') !
* ANSI(Windows-1252) 编码保存文件。这对所有 CK2 文件都适用:绝对不要使用 UTF-8 编码 ( 或者是没有'BOM' 的UTF-8 编码)


''Tip'': the path is relative to CK2 user directory, hence the "mod/" prefix.
'' 提示'': path 设定的路径是相对于用户的 CK2 目录而言的,因此要加上“/mod ”前缀。


=== Create the mod data folder ===
=== 创建 mod 的数据文件夹 ===


'''Step 4''': Create an empty folder named "mymod" in the CK2 mod folder (<code>~/My Documents/Paradox Interactive/Crusader Kings II/mod/mymod/</code>).
''' 第四步''' : 在 CK2 mod 目录下创建一个名为“mymod”的空文件夹 (<code>~/My Documents/Paradox Interactive/Crusader Kings II/mod/mymod/</code>).


''Tip'': best practice is to use same name for <code>path</code> folder than the mod file name, so that they are next to each other when browsing the CK2 mod folder.
'' 提示'' : 路径文件夹最好与mod文件同名,以便在查看 CK2 mod 文件时,他们是排列在一起的。


''Note'': folder and file names are case sensitive on OS other than Windows, so a best practice is to use only lower-case.
'' 注意'' Windows 以外的操作系统对文件夹和文件的名称大小写敏感,所以名称最好只用小写字母。


=== Making a game modification ===
=== 进行游戏修改===


[[File:Creating_mod_localisation.jpg|300px|thumb|right|Creation of 00_mymod.csv file]]
[[File:Creating_mod_localisation.jpg|300px|thumb|right|Creation of 00_mymod.csv file]]


We need a little change that will be quickly visible in-game, to validate that the mod is working.
为了验证 mod 是否能够工作, 我们可以做一些能够马上在游戏里看到变化的修改。


Let's do some basic [[localization]] modding and change the text "Choose Your Starting Era" on the lobby to "Choose Your Favourite Era" (the corresponding localisation key is <code>PICK_YOUR_STARTING_ERA</code>)


'''Step 5''': Create an empty folder named "localisation" in the mod data folder (<code>~/My Documents/Paradox Interactive/Crusader Kings II/mod/mymod/localisation/</code>).
我们可以做一些对[[本地化]]的基础修改,将游戏中“Choose Your Starting Era”修改为 “Choose Your Favourite Era”(对应的 localisation 关键字为 <code>PICK_YOUR_STARTING_ERA</code>


''Notes'':
* A mod follows the same folder structure as the base game, and the two are merged when loading in memory.
* Beware the folder has to be named "localisation" and not "localization" !


'''Step 6''': Create an empty file named "00_mymod.csv" in that folder (<code>~/My Documents/Paradox Interactive/Crusader Kings II/mod/mymod/localisation/00_mymod.csv</code>).
''' 第五步''': 在 mod 的数据文件夹中创建一个名为 “localisation” 的空文件夹(<code>~/My Documents/Paradox Interactive/Crusader Kings II/mod/mymod/localisation/</code>)


''Tip'': the "00_" prefix is to ensure our localization is loaded first and overrides the vanilla one. Each folder has its own loading order/overriding behavior.
'' 注意'': 
* 自定义mod 需要和游戏本体的组成结构相同,以便于在加载时进行合并。
* 注意这个文件夹应当命名为“localisation”而不是“localization”!


'''Step 7''': Open the file with a text editor and copy the following lines to the file and save:
 
''' 第六步''': 创建一个名为“00_mymod.csv”的空文件放到(<code>~/My Documents/Paradox Interactive/Crusader Kings II/mod/mymod/localisation/00_mymod.csv</code>)
 
''提示'': "00_" 前缀是为了保证我们的 localization 首先被加载,并且覆盖本体的。每个文件夹都有类似的加载顺序/覆盖行为。
 
'''第七步''': 用文本编辑器打开文件,复制下面的代码到文件里并保存:


<pre>
<pre>
第83行: 第89行:
</pre>
</pre>


That's it !
大功告成!


=== Testing the mod ===
=== 测试模组===


[[File:Creating_mod_result.jpg|600px|thumb|right|The modded era selection screen]]
[[File:Creating_mod_result.jpg|600px|thumb|right|The modded era selection screen]]


'''Step 8''': Activate the mod "My mod" in the launcher (and don't activate any other mod) and start the game.
''' 第八步''' : 在游戏启动器中激活“My mod ”(注意不要启动其它的mod)并启动游戏。


''Troubleshooting'': if the mod doesn't show up in the launcher, it probably means the .mod file is not in the correct folder or has the wrong extension (.txt instead of .mod).
''bug修正'' : 如果这个mod 没有在启动器中显示出来,可能是因为 .mod 文件扩展名不对(也许你的文件是.txt 而不是 .mod )或者说 .mod 文件没有放对文件夹


''Tip'': notice that the in-game [[checksum]] has not changed compared to the one from the launcher. This is because the localisation folder doesn't alter the checksum, as it's only a cosmetic change.
'' 提示'' : 注意游戏启动后的[[ 补丁]] ,应当和启动器的[[补丁]]相同。 因为本地化文件夹的内容只是一些修饰性的修改,并不会改变补丁。


'''Step 9''': Click on ''Start'' and verify that the title of the pop-up has changed.
''' 第九步''' : 点击“Start”启动游戏来检验弹出的标题是否被改变。


''Troubleshooting'': if the change is not visible in game, or the game crashes, check for errors logged by the game at startup in [[Troubleshooting#Log_files|error.log]].
''bug修正'' : 如果你的修改没有在游戏中显示出来,或者游戏崩溃了,请在[[ 故障排除# 日志文件|error.log]] 中检查游戏启动时的错误日志。


'''Step 10''': Take some time to congratulate yourself, and go back for more modding !
''' 第十步''' : 祝贺你成功做出了第一个mod,接下来请继续创作更多优秀的mod!


''Note'': each time you modify something in the mod files, you need to stop and restart CK2 so that the change is taken into account.
'' 注意'' : 每次你修改mod文件时,你需要重启CK2 来使修改生效。


== What's next ? ==
== 下一步?==


* Mod other [[Modding#Game structure| game files]]. Take it slowly, with small challenge, one problem at a time !
* 修改其他的[[ 模组制作# 游戏结构| 游戏文件]]. 慢慢来,一点点挑战,一次解决一个问题。
* Register your CK2 game and ask for help on the [https://forum.paradoxplaza.com/forum/index.php?forums/crusader-kings-ii-user-modifications.682/ Crusader Kings II - User Modifications forum]
* 注册一个CK2 的游戏账号,在论坛上获取帮助[https://forum.paradoxplaza.com/forum/index.php?forums/crusader-kings-ii-user-modifications.682/ Crusader Kings II - User Modifications forum]
* Upload your mod to the [[Steam Workshop]]
* 上传你的mod 到 [[Steam 创意工坊]]
* Zip the mymod.mod and mymod folder together into a mymod.zip and upload the mod on the forum
* 将你的‘mymod.mod ’和‘mymod’压缩成一个Zip扩展名的压缩包‘mymod.zip ’,然后上传到论坛。


== External links ==
== 外部链接==


* [[forum:1001172|Guide: Your first mod]] - to add an event option.
* [[forum:1001172|Guide: Your first mod]] - 添加事件的选项。


==References==
== 参考==


<references />
<references />


[[Category:Modding guides]]
[[Category: 模组制作指南]]
[[en:Creating a mod]]
{{ModdingGuidesNavbox}}

2020年12月25日 (五) 19:57的最新版本

本教程详细说明了创建基本mod所需的步骤。

同时你也可以复制和修改现有的模组来达成相同效果。不过要注意的是通过Steam创意工坊安装的模组,它们的包装方式不太相同。


此处基于的操作系统(作业系统)是Windows,但是理论上在MacOS和Linux不会有太大不同。

先决条件

  • 安装一个好的文件编辑器(像是Notepad++),因为因为Windows上预设的记事本会改变文件编码。

步骤

创建CK2的模组目录

这里涉及到两个不同的目录:

  • CK2的安装目录:它包含游戏的基本文件,最好不要尝试修改,并考虑'唯读模式'(任何的修改会在Steam更新时丢失)
    • 这个目录可以通过Steam找到:在游戏库中找到CK2,右键单击名称,然后在菜单中选择“属性”。 选择“本地文件”选项卡,然后按“浏览本地文件”。安装目录的路径通常含有: steamapps\common\Crusader Kings II.
  • CK2的使用者文件:它包含使用者的数据(存档、游戏设定、日志和模组。
    • 路径通常是~/My Documents/Paradox Interactive/Crusader Kings II/
    • ~是主目录,根据你的配置和Windows版本,它可能长得像:C:\Users\<YourUser>\Documents\Paradox Interactive\Crusader Kings II, 而在Linux上,它可能长得像: ~/.paradoxinteractive/Crusader Kings/.

小提示:你可以在桌面上创建这些目录的快捷方式。

第一步:如果不存在mod资料夹,就自行创建一个。~/My Documents/Paradox Interactive/Crusader Kings II/mod/

注意:在游戏文件的目录也存在一个同名资料夹common\Crusader Kings II\mod\ 但是保存在里面的模组不会被读取。

创建.mod文件

.mod格式只是个纯文本的文件,使用.mod文件扩展名而不是.txt扩展名保存。

小提示:大部分CK2 文件的扩展名是.txt, 但有时也会是.csv (国家名称和时间描述), .gfx (图像图片), .sfx (音效音乐), .gui (图形界面), .lua (全局变量) and .info (文档文件)。

第二步:创建一个文件名为“mymod.mod”的空文件,放到 CK2 mod 文件夹下(~/My Documents/Paradox Interactive/Crusader Kings II/mod/mymod.mod).

注意:请确认你的文件扩展名是'.mod'(而不是‘.mode.txt') - 在Windows系统的文件管理器中禁用“隐藏已知扩展”的选项。

第三步: 用你的编辑器打开.mod文件,并在里面添加一下内容:

name = "My mod"
path = "mod/mymod"

注意:

  • 不要忘记引号,这是强制性的,以防有空格。
  • 用 ANSI(Windows-1252) 编码保存文件。这对所有 CK2 文件都适用:绝对不要使用 UTF-8 编码 (或者是没有'BOM'的UTF-8 编码)!

提示: path 设定的路径是相对于用户的 CK2 目录而言的,因此要加上“/mod”前缀。

创建 mod 的数据文件夹

第四步: 在 CK2 的 mod 目录下创建一个名为“mymod”的空文件夹 (~/My Documents/Paradox Interactive/Crusader Kings II/mod/mymod/).

提示: 路径文件夹最好与mod文件同名,以便在查看 CK2 mod 文件时,他们是排列在一起的。

注意: Windows 以外的操作系统对文件夹和文件的名称大小写敏感,所以名称最好只用小写字母。

进行游戏修改

Creation of 00_mymod.csv file

为了验证 mod 是否能够工作, 我们可以做一些能够马上在游戏里看到变化的修改。


我们可以做一些对本地化的基础修改,将游戏中“Choose Your Starting Era”修改为 “Choose Your Favourite Era”(对应的 localisation 关键字为 PICK_YOUR_STARTING_ERA


第五步: 在 mod 的数据文件夹中创建一个名为 “localisation” 的空文件夹(~/My Documents/Paradox Interactive/Crusader Kings II/mod/mymod/localisation/)。

注意:

  • 自定义mod 需要和游戏本体的组成结构相同,以便于在加载时进行合并。
  • 注意这个文件夹应当命名为“localisation”而不是“localization”!


第六步: 创建一个名为“00_mymod.csv”的空文件放到(~/My Documents/Paradox Interactive/Crusader Kings II/mod/mymod/localisation/00_mymod.csv)

提示: "00_" 前缀是为了保证我们的 localization 首先被加载,并且覆盖本体的。每个文件夹都有类似的加载顺序/覆盖行为。

第七步: 用文本编辑器打开文件,复制下面的代码到文件里并保存:

#CODE;ENGLISH;FRENCH;GERMAN;;SPANISH;;;;;;;;;x
PICK_YOUR_STARTING_ERA;Choose Your Favourite Era;;;;;;;;;;;;;x

大功告成!

测试模组

The modded era selection screen

第八步: 在游戏启动器中激活“My mod”(注意不要启动其它的mod)并启动游戏。

bug修正: 如果这个mod 没有在启动器中显示出来,可能是因为 .mod 文件扩展名不对(也许你的文件是.txt 而不是 .mod)或者说 .mod 文件没有放对文件夹

提示: 注意游戏启动后的补丁,应当和启动器的补丁相同。 因为本地化文件夹的内容只是一些修饰性的修改,并不会改变补丁。

第九步: 点击“Start”启动游戏来检验弹出的标题是否被改变。

bug修正: 如果你的修改没有在游戏中显示出来,或者游戏崩溃了,请在error.log中检查游戏启动时的错误日志。

第十步: 祝贺你成功做出了第一个mod,接下来请继续创作更多优秀的mod!

注意: 每次你修改mod文件时,你需要重启CK2 来使修改生效。

下一步?

外部链接

参考