玩家指南框架

玩家指南框架

主要用于(主要是)策展人直接在游戏中为其模组列表构建指南的工具,以便于用户使用。

PLAYER GUIDE FRAMEWORK

你的模组列表指南,就在游戏内。


▍ 功能简介

Player Guide Framework 让模组列表的策展人能够将自己的玩家指南放入《赛博朋克 2077》原生的 数据库 菜单中。

条目包含策展人编写的标题、图片和重点说明。

该框架不会根据已安装的模组生成指南文本。 它提供了原生的游戏内阅读器和文档化的 JSON 格式。策展人决定他们的玩家需要了解什么。

无需退出游戏再去阅读你刚安装的模组列表到底有什么用——前提是你的策展人没偷懒。


▍ 面向玩家

  • 无需离开游戏即可阅读指南。 打开日志,选择数据库,然后选择你需要的部分。
  • 只看到与你档案相关的指南。 策展人可以为任意数量的列表变体提供不同的完整指南文件。
  • 使用搜索和常规的数据库导航。 该指南使用游戏现有的列表、详情视图、键盘、鼠标和控制器操作方式。
  • 追踪你的阅读进度。 新条目使用赛博朋克原生的高亮显示。打开一个条目会清除该存档中该条目的高亮。其所属部分会保持高亮,直到该部分中的所有当前条目都被阅读完毕。

Player Guide Framework 需要你的模组列表策展人提供的指南包。本页面上的 Chrome & Blood 截图展示了一个完整的实现示例;Chrome & Blood 的内容不会自动安装。


▍ 面向模组列表策展人

你不需要编写 RedScript、Lua、TweakDB 记录或本地化提供程序。指南包就是纯 JSON。

  1. 将启动器 r6 文件夹复制到一个新模组中。
  2. 重命名 your-guide.json 并填写你的包、部分和条目字段。
  3. 从随附的、按主题分组的原生数据库图像目录中选择图像。
  4. 运行随附的验证器,并将指南包与 Player Guide Framework 一起作为前置要求发布。

最小条目:

{
  "id": "player-armor",
  "title": "Player Armor",
  "body": "说明更改的规则、玩家会看到什么,以及它会改变哪些决策。",
  "revision": 1,
  "image": "UIJournalIcons.lore_ripperdoc_full",
  "mods": ["Armor Up"]
}

策展人工具包包括:

  • 一个可直接复制的启动器 JSON
  • 完整的字段和打包指南
  • 一个经过验证的原版数据库图像目录,按主题分组
  • 完整的 Chrome & Blood 标准和沉浸式配置包作为示例
**在杂项文件部分下载策展人模板。**

大多数条目应说明发生了什么变化、玩家会注意到什么,以及哪种应对方式有效。将相关的模组名称放在 mods 字段中,而不是把条目变成功能列表。


▍ 前置要求


▍ 安装

Mod Organizer 2 或 Vortex: 正常安装 Player Guide Framework,然后安装或启用策展人提供的指南包。

手动安装: 将压缩包解压到《赛博朋克 2077》游戏目录中,然后安装指南包,使其 JSON 文件到达 r6/storages/PlayerGuideFramework 目录下。


▍ 兼容性

  • 在现有数据库数据之后添加指南部分,而不是替换它。
  • 保留原版数据库条目,并将其他模组拥有的条目委托给它们。
  • 旨在与 Much Better Eddies 和 Much Better Netrunning 的数据库新增内容共存。
  • 当每个包使用唯一且区分大小写的包 ID 时,可加载多个指南包。
  • 支持经验证的原版 UIJournalIcons 记录和已安装的自定义 ArchiveXL 图像记录。

▍ 格式限制

  • 指南 JSON 文件必须直接放在 r6/storages/PlayerGuideFramework 目录下。子文件夹不会被扫描。
  • 赛博朋克原生的数据库支持一个可折叠的组级别。一个包包含多个部分,每个部分包含多个条目;部分不能再包含子部分。
  • 包 ID 在已安装的文件中必须唯一。部分和条目 ID 在其所属的包内必须唯一。
  • 条目文本是字面的 JSON 内容,不会自动翻译。
  • 更改条目的文本不会使其再次标记为未读,除非其正整数 revision 增加。

▍ 来源与致谢

  • CD Projekt Red - 原生日志和数据库界面
  • psiberx - Codeware
  • rayshader - RedFileSystem 和 RedData
  • RED4ext、redscript 和 Cyber Engine Tweaks 团队