Mazzle的EZ-文档（MazzleDocs）

Mazzle的EZ-文档（MazzleDocs）

这个模组允许你查看或创建美观、交互式的游戏内文档和教程，适用于你的模组。无需编写代码！

Mazzle的EZ-文档（MazzleDocs）预览查看大图

模组现在可以在游戏中以精美、多彩的交互式页面展示说明、背景故事和教程，供玩家直接在游戏内阅读！这些页面甚至可以包含自定义图片、用于GUI的交互式小部件以及照片级逼真的背景图像。

[img]https://staticdelivery.nexusmods.com/mods/3474/images/18883/18883-1759006942-1811895854.png[/img]

非常适合：

  • 注重故事性的模组，例如包含背景故事可供分享的职业、种族或任务模组
  • 功能繁多的复杂模组
  • 操作困难、需要教程来讲解机制的模组
  • 创意用途。例如，你可以创建包含你最爱的秘籍和传送地点（或许还有图片）的文档。或者你可以发布一个充满精彩游戏截图的模组。

用户 功能特性：

  • 外观精美：清晰的信息展示，使模组更易于使用，有时也更具沉浸感
  • 信息丰富：无需再费力在维基、文件或Nexus页面中寻找信息。所有关于你模组的最新信息（以及已知问题）都触手可及。
  • 易于使用：设置和配置简单。总能精确地从上次阅读的位置继续。
  • 易于导航：包含目录、搜索和分节功能
  • 可自定义：每份文档都可以有自己的设置页面，用于主题和字体自定义
  • 可导出：将你的文档转换为带有背景图像的漂亮PDF文件
  • 沉浸式：照片级逼真的背景图像让阅读感觉像是游戏世界的一部分

使用方法：

  • 安装模组
  • 按下 Shift-D 打开文档浏览器
  • 尽情探索

模组作者 功能特性：

  • 设置超简单：只需以基础表格或json格式编写内容，并将MazzleDoc.json文件添加到你的模组中
  • 快速添加专业效果：无需学习ScriptExtender、Imgui或Noesis，即可让你的模组看起来更专业、更精致
  • 内容丰富：添加各种文本小部件、用于交互式GUI的输入小部件（复选框、滑块、文本输入）、标题、章节、代码块、项目符号、标注和自定义图片
  • 大量小部件选项：配置每个小部件以达到你想要的精确外观：更改颜色、添加缩进、居中等等。
  • 易于更新：直接在模组中包含发布说明和更新的错误列表。可以在模组内或单独分发文档。随着模组增长，易于扩展。
  • 自定义一切：你可以更改任何内容的颜色以匹配你模组的主题
  • 灵活：提供多种方式将此功能集成到你的模组中
  • 功能强大：动态按钮可以传送、创建物品、生成角色、广播消息、授予法术/状态/被动技能等，为你带来大量疯狂搞事的可能性
  • 交互式GUI：使用输入小部件（复选框、滑块、文本输入）创建完全交互式的界面，非常适合配置菜单或复杂的模组控制
  • 字体丰富：包含8种以上自定义字体，包括等宽、手写和复古风格
  • API集成：提供完整的ScriptExtender API，用于获取/设置小部件值、回调以及在自己的窗口中渲染文档
  • 手动注册：无需模组文件即可向浏览器添加文档，方便测试或分享
  • 两种窗口类型：完整文档（如手册）或引导式教程（侧重于分步指导）
  • 主题系统：选择默认的BG3主题、带有逼真背景图像的内置主题，或创建你自己的自定义配色方案

关于ScriptExtender的说明：

  • 你的模组不需要使用ScriptExtender。 适用于任何模组，包括发布在mod.io上的工具包模组。
  • 查看文档确实需要ScriptExtender。 EZ-Documentation模组本身确实使用了ScriptExtender，因此你的用户需要安装ScriptExtender才能查看文档和教程。
  • 这并不会使你的模组依赖于ScriptExtender。如果用户没有安装ScriptExtender和Mazzle的EZ-Documentation，文档文件将被直接忽略。

要学习如何编写文档，请打开文档浏览器 (Shift-D) 并选择MazzleDocs手册。下载部分也提供了PDF版本。媒体库中还展示了大约十几张幻灯片。

手册中包含如何向你的文档添加自定义图片的指南。

公告

发布说明 - 2.3.0 - 2025年11月5日

新功能（所有模组）

1. 支持Mazzle的Photo Hub

  • 如果用户运行了Mazzle的Photo Hub模组，MazzleDocs现在可以显示用户硬盘上共享的任何照片。MazzleDocs还可以向用户显示照片选择器，允许他们从已共享的任何图片中进行选择。照片选择器还允许用户选择本次会话中截取的截图。（不会显示这些截图的预览图）。MazzleDocs还将创建一个显示用户所有共享照片的“我的相册”MazzleDoc。
  • 选择的图片可立即在其他模组中使用。

2. MazzleDocs图片导入器现已可用

  • 这个python脚本（带GUI）让你只需点击一下即可将自定义图片添加到你的模组的MazzleDocs中。这应该会使关于添加自定义图片的指南过时！
  • 此工具本质上是Mazzle的Photo Hub的简化版本。另外，它并非特定于MazzleDoc。你可以使用它将图片添加到任何模组以实现其他模组制作目标。

功能增强（所有模组）

1. 所有小部件现在都可以在窗口首次打开时淡入

fade-in = 2000.0

2. 主题背景图片现在应在更多分辨率和宽高比下正确缩放

  • 如果仍有偏差，MazzleDocs设置窗口中也有缩放选项供进一步调整。现在每个人都应该能够看到所有四个边缘。

新功能（ScriptExtender模组）

1. 模组现在可以在一个小部件上注册多个回调（具有不同类型）

  • 每种类型的小部件仍然具有对其而言合理的默认回调行为。此功能允许你注册额外的回调，例如右键单击回调，用于其他目的。
API.OpenScreenshotPicker(mod_name, doc_name, callback)

2. 新增API函数以打开照片选择器GUI

API.OpenScreenshotPicker(mod_name, doc_name, callback)

错误修复

  • SeparatorText现在将使用与Separators相同的主题颜色。修复了在创建MazzleDoc之后创建另一个窗口时，阻止MazzleDoc设置和应用值的错误。
  • 各种布局和主题修复。

发布说明 - 2.2.0 - 2025年10月29日

[img]https://staticdelivery.nexusmods.com/mods/3474/images/18883/18883-1761717972-1057133762.png[/img]

发布说明 - 2.1.0 - 2025年10月26日

新功能（所有模组）

任何MazzleDoc现在都可以免费拥有自己的设置页面！

  • 这允许用户更改文档的主题和字体大小！
  • 只需在你的配置中添加Add_Settings = true，即可为MazzleDoc添加设置页面。

功能增强（所有模组）

1. 新的PDF转换器，更忠实地渲染原始文档

  • 显示与游戏内GUI相同的背景图片
  • 你的主题和覆盖设置中使用的任何字体都会嵌入到PDF中。
  • 现在拥有易于使用的GUI！
  • 转换基本上就是选择一个文件然后点击一下。
  • 记住之前的转换，这样无论何时更改文档，都可以一键轻松更新你的PDF。

2. 按钮小部件在打开其他MazzleDocs方面表现更好

  • open_docs按钮现在可以打开任何已注册的MazzleDoc。

3. 按钮小部件现在可以关闭窗口

  • 现在可以创建close_window按钮来关闭它们所属的MazzleDoc。

4. 目录保持更有条理

  • 首次创建窗口时，除当前页面外，所有目录条目将默认为折叠状态。
  • 每当窗口重建时，展开状态会被保存并在重建时恢复。

5. 重要错误现在会在游戏内显示

  • 发生错误时，你不再需要查看控制台进行故障排除。MazzleDocs现在会在游戏内显示它们，有时还带有大量额外细节。
  • 你还可以选择生成调试报告，以获取有关你情况的更详细信息。

6. 复古主题改进（非常重要）

  • 无论窗口大小如何，都应始终将文本显示“在屏幕上”。
  • PDF导出现在可以复制游戏内外观而不会裁剪文本。

7. 你现在可以分辨哪些MazzleDocs是手动添加的

  • 手动添加的MazzleDocs现在将在文档浏览器中其标题旁边显示星号(*)。

8. 添加了新的西里尔字体，CaveatCyrillic

新功能（SE模组）

1. 模组现在可以随时请求任何MazzleDoc的原始Lua版本（即使是JSON文档）

  • 添加了新的API调用，以获取当前可以加载的任何MazzleDoc的Lua版本。
API.GetDocumentContent(mod_name, documentation_name) -> content_table, config_table, error_message
  • 文档不必已注册或打开。
  • 这可能非常有用。例如，Tav's journal在其导入过程中使用它来获取在导出期间存储在JSON中的Lua元数据表。然后它取出该表，并使用剩余数据创建导入的日志。
  • 还移除了API.GetWindowContent(window_title)。那是一个较差的版本，仅适用于外部JSON。

2. 模组现在更容易动态创建带有输入小部件的MazzleDocs

  • 为模组添加了新的sticky选项，该选项将强制MazzleDocs在小部件的值与默认值匹配时永不丢弃其值。
  • 这可以防止在动态重新生成内容时可能出现的许多恼人错误。

功能增强（SE模组）

模组现在可以导出到自定义文件夹，并避免覆盖以前的导出

Export_Docs_To_JSON(config_data, content_table, output_folder, overwrite)

错误修复

  • 修复了prefix_color不遵守主题颜色的问题
  • 修复了默认/皮革主题中按钮没有不同的悬停和点击颜色的问题
  • 修复了按钮文本未垂直居中的问题
  • 修复了新窗口在首次加载时被调整到最小尺寸的错误
  • 修复了MazzleDoc根据主题和主题覆盖选择错误字体或颜色的更多情况

其他发布说明

我的其他模组

游戏工具

  • EZ-Manipulator (用于移动、缩放、旋转角色、物品和场景的控件)
  • Fricken FreeCam (自由移动镜头)
  • MF Radio (游戏内收音机，可播放本地和下载的音乐)
  • RangeFinder (可视化移动范围和攻击，规划/自动化移动)
  • Tav's Journal (创建带照片的游戏内日志，导出和分享)
  • Tav's Clock (一个可以放在任何地方的小时钟和会话计时器)

生活质量

库和外部工具

  • MazzleDocs (用于显示精美游戏内文档、教程或完整模组GUI的库)
  • MazzleLib (我的其他模组的核心库)
  • My Assistant Ken (帮助其他模组与Noesis交互的库)
  • Oops All Characters (包含简易NPC/敌人生成器，让你可以在任何关卡生成大多数角色)
  • Photo Hub (外部工具和模组，允许模组访问你的截图和图片)
  • Music Hub (下载并转换音乐，使其可在BG3中使用)

为模组作者准备的模组

支持本模组

如果你觉得这个模组有用，请考虑进行捐赠。

ko-fi

此外，如果你喜欢这个模组，请查看我的另一个模组，RangeFinder。它值得你花时间去学习！