CET-2-红方

CET-2-红方

RedScript。因为你的模组值得拥有。 ૮₍ ´ ꒳ `₎ა

[color=#e06666][size=6][b]- 简介 -[/b][/size][/color]

我最近一直在把 CET 模组转换为 Redscript。我并不反感 Lua;真的不。它很简洁,而且就《赛博朋克 2077》而言,它也是我起步的地方。

但游戏原生运行在 Redscript 上——它天生就是为此而生的,而且运行得非常高效。无论你怎么试图让一个外部 Lua 脚本引擎运行得更高效,由于它与引擎交互的方式,它仍然会落后。

现在,把你的模组转换成 Redscript 并不容易——我会第一个承认,Lua 之所以好用,其中一个原因就是它很简单,而 Redscript 不是。所以,我试着把我学到的东西浓缩进这个工具,帮助你把自己的模组转换成 Redscript,或者至少给你一个起点。

这个工具无法完成所有事情——代码的组合方式和预期结果太多,根本无法做到。它的设计目的是给你一个先发优势,仅此而已。

所以让我把话说清楚:[i]这是给模组作者的,不是给用户的![/i]

它不是转译器,也永远不会是。Lua 是动态类型的,CET 那种逐帧的习惯不应该在移植后保留下来。呃。


[i]你也许会说我是个梦想家。但我并不是唯一一个。我希望有一天你能加入我们。那时世界将作为 RedScript 而活![/i]


[color=#e06666][size=6][b]- 普查 -[/b][/size][/color]

普查脚本会告诉你一些重要信息:
[quote][code]python cet2reds_census.py "<game>\bin\x64\plugins\cyber_engine_tweaks\mods" --out census[/code][/quote]打开 [b]census\census.md[/b]。你的模组使用的每个 CET 符号都会落入一个层级,而模组的评级就是它所处的最高层级:

[list]
[][b]层级 0[/b] - 仅使用 RedScript、TweakXL 和 Codeware。在原版类上使用 Observe、TweakDB:SetFlat、Game.、Cron 计时器。[/]
[
][b]层级 1[/b] - 一个带有机械适配器的插件,这由第 2 阶段来编写。nativeSettings 映射到 Redscript Config Framework,GameOptions 映射到 RedFunctions.EngineConfig,io 和 json 映射到 RedFunctions.Storage。[/]
[
][b]层级 2[/b] - 一个只有骨架的插件,布局需手动完成。ImGui 覆盖层映射到 RedWindows,在你自己的伴随类上使用钩子,在没有 RedScript 端的模组上使用 GetMod。[/]
[
][b]层级 3[/b] - 没有目标。loadstring、非文件操作的 shell 调用、Lua 调试库。[/*]
[/list]对整个模组文件夹运行它,你还会得到需求表:哪些插件会被多少个模组需要,每个人都钩哪些类,哪些模组是其他模组通过 GetMod 访问的框架。对只包含一个模组的单个文件夹运行它,你就会得到该模组的报告。

当脚本能够使用 DV_RTTI.zip 时(见“要求”),钩子目标会与原版类集合进行比对。没有 RTTI 文件时,每个钩子都会显示问号,而不是是或否。


[color=#e06666][size=6][b]- 第 2 阶段 -[/b][/size][/color]

第 2 阶段是脚手架:具有正确签名的钩子骨架、你的设置页面作为 RCF schema、你的 SetFlat 作为 TweakXL YAML,以及每个模组一份报告文件。首先你要决定允许什么:[b]--allow rcf,redwindows,redfunctions[/b],默认不启用。除非你放宽限制,否则脚手架只使用 RedScript、TweakXL 和 Codeware,而报告会说明每个额外依赖本可以解锁什么。你允许的每一项都会成为所有安装你移植版本的人的硬性要求,所以工具会说明这一点一次,并把列表写入移植版本的文档中。


[color=#e06666][size=6][b]- 第 3 阶段 -[/b][/size][/color]

第 3 阶段针对那些在循环中构建 TweakDB 记录的模组,静态扫描在这里会看到一个变量然后放弃。使用 [b]--emulate[/b] 时,工具会在一个脱机的沙盒 Lua 中运行你的 init.lua 一次,并使用来自原版游戏的模拟 TweakDB,同时把 Lua 构建的每条记录保存为 TweakXL YAML。如果你的模组自带 TweakXL YAML,这次运行也会读取它。仅这一部分就需要两个 Python 包(lupa、pyyaml);工具的其他部分没有它们也能运行。


[color=#e06666][size=6][b]- 报告 -[/b][/size][/color]

一次运行会在其输出旁边留下 [b]cet2reds-report.json[/b],其中包含它无法归置的符号、计数、文件和行号,以及它停下的层级。报告里不会写入任何 Lua 源代码,所以你可以把报告发到 Nexus(或其他地方),而不必再分发任何人的模组,包括你自己的。工具不会向任何地方发送任何内容。如果报告显示了你认为应该被填补的空白,请使用文档中的模板把它发到 bug 区,并说明你认为这是转换器的职责、RedFunctions 的职责,还是 RedWindows 的职责。如果某事 CET 能做,但无论是原生方式还是通过已知模组都无法在 RedScript 中做到,那么我们就会把它构建出来。但为了构建它,我们需要知道它的存在,所以报告至关重要。


[color=#e06666][size=6][b]- 关于他人的模组 -[/b][/size][/color]

输出是你所输入内容的衍生作品。移植你自己的模组,是否发布由你决定。为了自己的安装而移植他人的模组是可以的。发布该移植版本则不行,除非作者同意。工具不会检查许可证;这由你负责。


[color=#e06666][size=6][b]- 要求 -[/b][/size][/color]

Python 3.9 或更高版本。不需要任何软件包,除了 --emulate 需要 lupa 和 pyyaml。不会向游戏中安装任何东西;它读取你的模组文件夹,并写入你指定的位置。

Files 下的 [b]DV_TweakDB.zip[/b] 是文本形式的原版 TweakDB,每条记录一个 YAML,使用打过补丁的 WolvenKit 从游戏中导出。把它放在脚本旁边,每个 SetFlat 都会根据真实记录来确定类型,而 --emulate 也就有了游戏记录可供处理。除非你好奇,否则无需解压这个 zip。没有它时,值会根据其字面量来确定类型。

Files 下的 [b]DV_RTTI.zip[/b] 是 JSON 形式的游戏 RTTI,每个类、枚举和位域一个文件,从未启用任何模组的原版安装中抓取。把它放在脚本旁边,每个钩子目标都会被解析为其真实签名。像另一个一样就地读取。没有它时,每个钩子都会显示问号。


[color=#e06666][size=6][b]- 安装 -[/b][/size][/color]

解压到游戏文件夹之外的任意位置,并从终端运行脚本。docs 文件夹中存放手册、报告格式和空白报告模板。


[color=#e06666][size=6][b]- 致谢 -[/b][/size][/color]

yamashi 以及 CET 维护者们,感谢他们提供了所有这些模组所针对编写的 API。
psiberx,普查会按名称识别他的 Cron、GameUI、GameSession 及同类库,并将其与引入这些库的模组分别计数。
L'Oreal,因为一句好得不能不借用的口号;以及 John Lennon,因为另一句。

MIT 许可证。