22 个版本 (1 个稳定版)
1.0.0 | 2024年7月3日 |
---|---|
0.9.6 | 2024年4月12日 |
0.9.5 | 2024年3月27日 |
0.8.12 | 2024年2月29日 |
0.7.4 | 2023年7月22日 |
#731 in 游戏开发
每月下载 1,330 次
5.5MB
100K SLoC
Tiger 猎杀虫害。检查 Crusader Kings 3 用户模组文件中的错误并发出警告。例如:缺少本地化,或在角色上使用信仰触发器。
Crusader Kings 3 是由 Paradox Interactive 开发的策略游戏,玩家通过创建模组来增强或改变他们的游戏体验。本工具是为制作模组的人设计的。
ck3-tiger
现在还包含 vic3-tiger
,用于对 Victoria 3 执行相同的操作,以及 imperator-tiger
,用于对 Imperator: Rome 执行相同的操作。
状态
该项目正在成熟但尚未稳定。它会警告一些实际上是正确的事情。
vic3-tiger
比较年轻于 ck3-tiger
,因此警告将不够准确。
功能
ck3-tiger
(或 vic3-tiger
或 imperator-tiger
)将读取相关的原始文件和您的模组文件,并对您的模组中看起来错误的一切进行抱怨。在可能的情况下,它会告诉您为什么认为该事物是错误的,并且(仍然在极少数情况下)您应该怎么做。
- 语法验证:您是否使用了正确的键 = 值对?没有拼写错误吗?
- 缺少项目:您引用的每个游戏对象是否确实在某个地方定义了?
- 缺少本地化:您是否拥有您模组所需的全部本地化?
- 范围一致性检查:您是否在文化上使用文化效果,在角色上使用角色效果等?
- 历史(CK3):配偶、雇主和领主在相关日期是否都活着?没有人是自己的祖父吗?
- 特别:rivers.png 检查
示例输出
如何使用
ck3-tiger
从GitHub下载发布包。将其解压到某个位置。
在Windows上,如果一切顺利,您可以双击ck3-tiger-auto
并尝试运行。
否则,从命令提示符运行工具
path/to/ck3-tiger path/to/your/descriptor.mod
或
path/to/ck3-tiger "path/to/Paradox Interactive/Crusader Kings III/mod/YourMod.mod"
(请注意,路径两侧的引号很重要,因为路径中包含空格。)
如果您想将输出保存到文件,可以按如下方式重定向
ck3-tiger path/to/your/descriptor.mod >filename
vic3-tiger
从GitHub下载发布包。将其解压到某个位置。
在Windows上,如果一切顺利,您可以双击vic3-tiger-auto
并尝试运行。
否则,从命令提示符运行工具
path/to/vic3-tiger path/to/your/mod
或
path/to/vic3-tiger "path/to/Paradox Interactive/Victoria 3/mod/YourMod/"
(请注意,路径两侧的引号很重要,因为路径中包含空格。)
如果您想将输出保存到文件,可以按如下方式重定向
vic3-tiger path/to/your/mod >filename
imperator-tiger
从GitHub下载发布包。将其解压到某个位置。
从命令提示符运行工具
path/to/imperator-tiger path/to/your/descriptor.mod
或
path/to/imperator-tiger "path/to/Paradox Interactive/ImperatorRome/mod/YourMod.mod"
(请注意,路径两侧的引号很重要,因为路径中包含空格。)
如果您想将输出保存到文件,可以按如下方式重定向
imperator-tiger path/to/your/mod >filename
如何配置
您可以在模组目录中放置一个文件ck3-tiger.conf
(或vic3-tiger.conf
或imperator.conf
),用于选择要检查本地化的语言,以及抑制不希望修复的消息。
发布中包含示例ck3-tiger.conf
文件、vic3-tiger.conf
文件和imperator-tiger.conf
文件,其中包含有关其中内容的说明。还有一个指南。
如何构建
如果您想自己构建,您将需要安装Rust编程语言。您可以从某个发布版中获取源存档(最好是最新版本)或克隆git仓库。
对于ck3-tiger
,在项目目录中运行cargo build --release -p ck3-tiger
,然后作为cargo run --release -p ck3-tiger
运行程序。
对于vic3-tiger
,在项目目录中运行cargo build --release -p vic3-tiger
,然后作为cargo run --release -p vic3-tiger
运行程序。
对于imperator-tiger
,在项目目录中运行cargo build --release -p imperator-tiger
,然后作为cargo run --release -p imperator-tiger
运行程序。
Visual Studio Code 扩展
用户 unLomTrois 开发了一个 VS Code 扩展,用于 ck3-tiger
。它允许你在“问题”标签页中直接查看报告。
仅显示新报告
你可以让 tiger
抑制之前运行中显示的报告。当您只想查看更改的内容时,这非常有用,例如更新您的模组后。首先,您需要生成一个“基线”来比较未来的运行
ck3-tiger --json path/to/your/mod >baseline.json
您可以使用任何文件名代替 baseline.json
。然后,当您再次运行 tiger 时,您可以告诉它排除基线中的报告
ck3-tiger --suppress baseline.json path/to/your/mod
它也适用于 vic3-tiger
和 imperator-tiger
。
贡献
我欢迎贡献和合作!以下是一些可能的贡献形式
- 关于 tiger 应该检查哪些内容的建议和想法
- 告诉我哪些输出消息令人困惑或难以理解
- 报告 tiger 抱怨的问题实际上并不是问题的情况(假阳性)
- 在 GitHub 上提交有关您遇到的问题的 issue,或者直接发送邮件给我
- 启动游戏以验证代码中标记为 "TODO: verify" 的内容
欢迎以代码形式做出的贡献。它们应以 GitHub pull request 的形式提交,并且在这样做之前,您应该阅读并理解项目的版权许可。不过,在开始编码之前提交 GitHub issue 也是有帮助的,因为我不一定希望以不同的方式解决问题。
一些代码贡献的想法
- 添加新的检查及其错误报告
- 添加对新项目类型的验证器
- 将验证器更新到新游戏版本
- 解决代码中的数百个 TODO 注释之一
- 解决 TODO 或 IDEAS wiki 页面上标记的问题之一
- 速度或内存使用改进;机会无处不在
有关代码和编码风格的概述,请参阅 CODING wiki 页面。
许可
本程序是自由软件:您可以在自由软件基金会发布的 GNU 通用公共许可证条款下重新分发和/或修改它,许可证版本为 3 或(根据您选择)任何更高版本。
本程序以希望它将是有用的方式分发,但没有任何保证;甚至没有关于适销性或特定用途的隐含保证。有关更多详细信息,请参阅 LICENSE
文件。
依赖项
~15–32MB
~578K SLoC