打开对话

打开对话

Hytale的对话树。直接从资产编辑器编写能记住玩家回答的对话,并以你的方式呈现。

图书馆

OpenDialogues

💬 为你的 Hytale 服务器提供对话树。让你的 NPC 和物品有话说,让玩家作答,让每个回答都有意义。

无需编写代码。在资源编辑器中编写对话,将插件放入 mods/,然后开始对话。

Discord GitHub

Grizzle,矿工毛绒玩偶,索要十块铜矿、十块铁矿和十块金矿

一位拥有名字、头衔和头像的说话者,带着图标和颜色的回答,以及一个记得你上次说了什么的剧情。

📦 想看看实际运行效果? 安装 OpenQuests Examples:The strange plush 章节会交给 你一个饥饿的哥布林毛绒玩偶,它会说话、乞求矿石,并在被喂食后改变态度。


✨ 你能得到什么

📝 一切都在资源编辑器中。 对话、说话者和路由器都是资源,在输入时会进行校验。你可以将整个 对话嵌套在单个文件中,也可以按你的喜好拆分。

🎭 三种展示对话的方式,以及你自己的方式。 带边框的面板、屏幕底部的电影式横幅,或 纯聊天。每个对话可以选择自己的方式,服务器所有者拥有最终决定权,模组也可以添加与 其服务器 UI 匹配的显示方式。

🗣️ 说话者。 一个名字、一个头衔和一个头像,写一次即可被其所说的每个对话共享。

📄 页面和回答。 多个页面依次阅读,然后是关闭对话、打开下一个 对话或运行命令的回答。

🔍 在合理时显示的回答。 回答可以要求手中持有物品、背包中有足够的矿石、一项 权限,或之前做出的选择。否则它会保持隐藏。

🧠 每位玩家一份记忆。 每个打开的对话和每个被选择的回答都会随玩家保存,因此一个角色 会对新人和常客做出不同的问候。

🔀 路由器。 一个 id,多个对话:条件成立的第一个,或按权重随机抽取的一个。

🖱️ 从世界中打开。 对 NPC 按 F、使用物品、运行命令:各能打开一个对话。

🛡️ 在启动时检查。 缺失的对话或循环的路由器会在资源加载时记录日志,而不是让玩家在 数小时后才遇到。

🈯 可翻译。 每一行都是一个翻译键。


🎭 显示方式

🖼️ 默认

默认显示:Grizzle 的头像在边框中,文字在中间,右侧有三个彩色的回答按钮

一个符合游戏自身风格的带边框面板。每个回答都是一个按钮,你可以为其着色并添加图标。

默认显示,Grizzle 故事三页中的第一页,带有一个翻到下一页的箭头

长文本会被分成页面,带有一个翻页箭头和一个显示当前位置的计数器。

🎬 电影式

Grizzle 被喂食后的电影式显示:称号现在显示为 Well-fed plush,并提供四个新的回答

说话者的头像,放大显示,位于屏幕底部变暗的横幅上方,回答在右侧。世界 保持在视野中:专为你遇到的角色而设计。

💬 聊天

聊天显示:Grizzle 的台词后跟三个带编号的回答,第一个是绿色,第二个是红色,以及 /oda 命令提示

文字和带编号的回答直接显示在聊天中,通过 /oda <n> 选择。不会打开任何东西,也不会停止游戏。

一个对话会指定其显示方式。服务器所有者可以为单个对话、某个标签、整个包或 所有内容覆盖它,而无需触碰文件。

🎨 你自己的方式

你的服务器有自己的风格?让它的对话也拥有同样的风格。一个显示方式只需插件几行代码:将面板指向你自己的 .ui 文件,或以任何你喜欢的方式绘制对话,并以一个名称注册它。对话随后可以像任何 其他方式一样引用它。


🔀 条件和路由器

条件 成立条件
Opened 一个对话被打开了指定次数
Answered 一个对话的某个回答被选择了指定次数
Holding 手中的物品匹配
Inventory 背包中持有足够的物品、资源或标签
HasPermission 玩家拥有某权限
Composite 其所有条件都成立,或其中任一条件成立

每个条件都可以用 "Not": true 取反。将其放入回答的 When 中,以仅在条件成立时显示它, 或放入路由器中以选择对话。

路由器 选择方式
Sequence 条件成立的第一个路由,否则为默认
Weighted 按权重随机抽取一个条目

路由器指向对话或其他路由器,因此一个角色的全部个性可以挂在一个 id 上。

🎬 回答动作

动作 效果
Close 结束对话
Open 转到另一个对话,或转到路由器选择的内容
Command 以玩家身份运行命令
ConsumeInventory 从玩家处取走物品,要么全部取走,要么一个不取

⚔️ 与 OpenQuests 配合使用

在 OpenQuests 旁边安装 OpenQuests Dialogues 桥接插件, 对话和任务就能互相通信:

  • 一个 Dialogue 任务类型: 打开一个对话,或选择其某个回答,达到指定次数。“与商人交谈” 就是一个任务。
  • 通过 AssignQuest 发放任务的回答,或通过 SetQuestState 结束任务。
  • 一个 RequiresQuest 条件: 仅在任务进行中或完成后才显示的回答。

🛠️ 面向服务器所有者

安装

将 OpenDialogues 放入 mods/。它不需要其他任何东西。

编写对话

对话是 Server/OpenDialogues/Dialogues/ 下的 JSON 资源,在资源编辑器中编辑:

{
  "Title": "grizzle.name",
  "Speaker": "MyPack_Grizzle",
  "Display": "Cinematic",
  "Pages": [
    { "Text": "grizzle.hungry.text" }
  ],
  "Responses": [
    {
      "Text": "grizzle.hungry.feed",
      "Icon": "Icons/ItemsGenerated/Ore_Gold.png",
      "Color": "#7aff81",
      "When": { "Type": "Inventory", "Item": { "ItemId": "Ore_Gold" }, "Min": 10 },
      "Actions": [
        { "Type": "ConsumeInventory", "Items": [{ "Item": { "ItemId": "Ore_Gold" }, "Quantity": 10 }] },
        { "Type": "Open", "Dialogue": "MyPack_GrizzleFed" }
      ]
    },
    { "Text": "grizzle.hungry.later", "Actions": [{ "Type": "Close" }] }
  ]
}

要在游戏中打开它,将 OpenDialoguesOpen 动作添加到 NPC 角色的交互中,或将 OpenDialoguesOpen 交互添加到物品中。

命令

命令 效果 授予对象
/oda <n> 选择聊天中打开的对话的一个回答 所有人
/odialogues open <id> 打开一个对话或路由器,也可用 /od 世界编辑者
/odialogues display default <display> 为未指定显示方式的对话设置显示方式 管理员
/odialogues display set <target> <display> 强制为某个对话、标签、包或所有内容设置显示方式 管理员
/odialogues display which <dialogue> 告知一个对话将在何处打开,以及原因 管理员
/odialogues history reset <player> 忘记玩家说过的话,使所有人重新问候他们 管理员

💻 面向开发者

其他模组通过 OpenDialoguesPlugin.get().getRegistry() 接入:回答动作、条件、路由器选择器 和全新的显示方式都只需一行代码。DialogueEvent.Opened、Answered 和 Closed 会告诉你玩家做了什么。

以你服务器风格呈现的显示方式可以复用面板与你自己的布局,就像 Cinematic 那样:

public class MyDialoguePage extends DialogueCustomPage {
    public MyDialoguePage(PlayerRef player, DialogueSession session, DialogueService dialogues) {
        super(player, session, dialogues, "MyMod/Dialogue/Page.ui", "MyMod/Dialogue/Answer.ui");
    }
}

OpenDialoguesPlugin plugin = OpenDialoguesPlugin.get();
plugin.getRegistry().registerDisplay("MyModPanel", new PageDisplay(plugin.getDialogueService(), MyDialoguePage::new));

保留捆绑 .ui 文件的元素 id,其余部分可自由设置样式。若需完全不同的实现,请实现 DialogueDisplay:show 和 close,每个回答都通过 DialogueService.answer 返回。 在你的 manifest.json 中声明 "MartelStudios:OpenDialogues"。


源代码和文档: https://github.com/MartelStudios/OpenQuests

MIT 许可。