Read this document in English: English Document
Next Gen Dialogue插件是一款结合大语言模型设计的Unity对话插件，荣获Unity中国颁发的Unity AI插件优秀奖。 它将传统的对话设计方法与人工智能技术相结合。 目前这个包是一个实验性的尝试，希望你喜欢。
具有以下特点：
- 可视化的对话编辑器
- 模块化的对话功能
- 支持AIGC在Editor中烘焙对话
- 运行时Debug
演示项目: https://github.com/AkiKurisu/Next-Gen-Dialogue-Example-Project
演示视频: https://www.bilibili.com/video/BV1hg4y1U7FG
- Unity 2021.3 or later
在Unity PackageManager中使用Git URL下载 https://github.com/AkiKurisu/Next-Gen-Dialogue.git
Next Gen Dialogue的实验特性放入了Modules文件夹中，再没有安装相应依赖的情况下不会被启用，你可以在其文件夹下的README.md文档中查看依赖项。
使用核心功能需在PackageManager中安装Newtonsoft Json。
如果您是第一次使用该插件，推荐先游玩以下示例场景：
1.Normal Usage.unity 场景包含了使用NextGenDialogueTree和NextGenDialogueTreeSO的样例；
2.Editor Bake Dialogue.unity 场景包含了在Editor中使用AI Dialogue Baker烘焙对话内容的样例；
3.Build Dialogue by Code.unity 场景包含了使用Code生成对话的样例。
4.Bake Novel.unity 使用ChatGPT无限生成对话树的样例。
NextGenDialogueTree和NextGenDialogueTreeSO用于存储对话数据，为了便于理解之后统称为对话树（DialogueTree）。 以下流程是创建一个仅包含单个对话片段和单个选项的对话树：
-
在任意GameObject上挂载NextGenDialogueTree
-
点击
Edit DialogueTree进入编辑器 -
创建Container/Dialogue结点，该结点是游戏时所使用的对话容器
-
将Dialogue结点的Parent端口与Root结点相连接，你可以在一个DialogueTree中拥有多个Dialogue，但只有连接Root结点的才会被使用
-
创建Container/Piece结点，创建我们第一个对话片段
-
右键Piece结点
Add Module添加Content Module模块，你可以在content中填写对话的内容 -
创建Container/Option结点，创建该Piece结点对应的对话选项
-
右键Piece结点
Add Option，将Piece与Option相连 -
非常重要: 至少需要将一个Piece结点加入Dialogue中作为对话的首个片段。你可以右键Dialogue的
Add Piece通过连线或引用其PieceID进行关联，也可以右键Dialogue的Collect All Pieces将Graph中所有的Piece加入Dialogue中，并且通过排序来调整Piece的优先级- 优先级请参考通用模组-Condition Module
-
点击编辑器左上方的
Save保存对话 -
点击Play进入PlayMode
-
点击NextGenDialogueTree的
Play Dialogue播放对话 -
点击
Debug DialogueTree进入Debug模式
- Tips : 当前正在播放的对话片段将以绿色进行显示
在运行时完全使用AIGC的对话内容不易控制，但您可以使用AI Dialogue Baker在设计对话树时提前烘焙AI生成的对话内容，从而在不影响您的设计框架的同时提高工作流效率。
- 基础对话树设计与《创建对话树》的流程一致
- 为需要烘焙的片段或选项添加
AI Bake Module, 不需要烘焙的结点请移除该模组 - 选择您烘焙时使用的LLM类型
- 依次选择AI Dialogue Baker需要识别的结点，识别的顺序以鼠标选中的顺序为准，最后选中需要烘焙的结点
- 如果选择成功，你可以在编辑器的底部看到预览的输入内容
- 点击
AI Bake Module上的Bake Dialogue按钮等待AI响应 - 语言模型响应后，将自动在该结点中添加
Content Module存放烘焙出的对话内容 - 你可以根据需求连续生成对话
和烘焙对话中直接和AI对话不同，小说模式让AI扮演文案策划编写对话，因此可以对选项和片段的控制更加精确，请参考示例：6.Bake Novel.unity
NGD使用基于节点的可视化编辑器框架，大部分功能都是通过节点呈现的。
构建对话在NGD中它们被分为以下几部分：
| 名称 | 说明 |
|---|---|
| Dialogue | 用于定义对话，例如对话的首个片段等属性 |
| Piece | 对话片段，通常存放核心的对话内容 |
| Option | 对话选项，通常用于交互和衔接对话 |
除此之外，为了给对话增加趣味性例如增加事件、执行行为，在NGD中你可以使用行为树框架中的以下类型结点：
| 名称 | 描述 |
|---|---|
| Composite | 它有一个或多个子结点并控制要更新哪个子结点。 |
| Action | 这是叶结点。 它执行诸如跟随玩家、攻击、逃跑或您定义的其他动作。 |
| Conditional | 它有一个子结点，检查子结点是否可更新。 当没有子结点时，Conditional与Action一样是叶结点。 |
| Decorator | 它有一个子结点，会根据子结点的返回值修改返回值 |
除了上述结点，在NGD中还使用了一个更灵活的概念即模组Module，你可以使用Module改变对话的输出形式例如Google翻译、本地化，增加回调或是作为一个标记。
以下是内置的通用模组：
| 名称 | 描述 |
|---|---|
| Content Module | 为Option或Piece提供文本内容 |
| TargetID Module | 为Option增加跳转的目标对话片段 |
| PreUpdate Module | 为Container增加预更新行为，它会在跳转到该Container时进行更新 |
| CallBack Module | 为Option增加回调行为，它们将在选择后进行更新 |
| ScriptableEvent Module | 为Option增加ScriptableEvent事件，它们将在选择后进行更新,ScriptableEvent 可用于跨场景事件订阅 |
| UnityEvent Module | 为Option增加UnityEvent事件，它们将在选择后进行更新,UnityEvent可用于传统单场景内事件订阅 |
| Condition Module | 为Option或Piece增加判断行为，它会在跳转到该Container时进行更新，如果返回值为Status.Failure则该Container被丢弃。如果是对话的首个Piece，则系统会按照Dialogue中Piece的放置顺序尝试跳转至下一个Piece |
| NextPiece Module | 为Piece增加结束后的下一个对话片段，如果没有选项，则会在播放完Piece内容后跳转至指定对话片段 |
| Google Translate Module | 使用谷歌翻译对当前Option或Piece的内容进行翻译 |
以下是内置的AIGC模组：
| 名称 | 描述 |
|---|---|
| Prompt Module | 为之后生成的对话生成提供基础的提示词 |
以下是实验性的模组, 使用前需要安装相应的Package或配置对应环境：
基于UnityEngine.Localization插件支持对话的本地化
| 名称 | 描述 |
|---|---|
| Localized Content Module | 从本地化获取文本后为Option或Piece提供内容 |
VITS本地部署请参考该仓库：VITS Simple API
如要使用VITS模组请配合VITSAIResolver使用，Resolver解析器使用请参考下文的《解析器》
| 名称 | 描述 |
|---|---|
| VITS Module | 使用VITS语音合成模型为Piece或Option实时生成语言 |
在Dialogue结点中添加Editor/EditorTranslateModule，设置翻译的来源语言（sourceLanguageCode）和目标语言（targetLanguageCode）, 右键选择Translate All Contents对所有带有ContentModule的Piece和Option进行翻译。
对于非ContentModule的结点，如字段添加了TranslateEntryAttribute可以右键单个结点进行翻译
namespace Kurisu.NGDT.Behavior
{
public class SetString : Action
{
//Notify field can be translated
//* Only work for SharedString and string
[SerializeField, Multiline, TranslateEntry]
private SharedString value;
}
}
使用前需要安装Modules/VITS相应依赖并开启本地VITS服务器（参照Modules/VITS/README.md），在需要生成语音的结点中添加AIGC/VITSModule，右键选择Bake Audio
如你对生成的音频较为满意，点击Download保存到本地从而完成烘焙，否则退出编辑器后不会保留音频文件。
烘焙完成后不再需要运行时启动VITS服务器。
- 如果AudioClip字段为空，则默认开启运行生成模式，如没有连接可能导致对话无法进行，如只需要使用烘焙功能请将AudioClip字段始终保持不为空。
解析器Resolver用以在运行时检测Container中的Module并执行一系列预设的逻辑例如注入依赖、执行行为 ，NGD内置的Resolver区别如下：
| 名称 | 描述 |
|---|---|
| Default Resolver | 基础的解析器，支持所有内置的通用模组 |
| VITS Resolver | 额外检测VITS模组实时生成语音 |
-
场景内全局解析器 你可以在任意GameObject上挂载
VITSSetup脚本来在该场景启用AIResolver -
对话指定解析器
你可以在对话的Dialogue结点上添加
VITSResolverModule来指定该对话使用的解析器，你还可以点击该模组的右上角Setting按钮，在Advanced Settings中选择替换的Resolver
在NGD中分为了两个部分DialogueSystem和DialogueTree，前者定义了对话的数据结构，接收数据后由Resolver进行解释，后者提供了可视化的编辑方案，并继承自前者的接口。因此你也可以使用脚本的来编写对话，样例如下：
using UnityEngine;
public class CodeDialogueBuilder : MonoBehaviour
{
private DialogueBuilder builder;
private IEnumerator Start()
{
yield return new WaitForEndOfFrame();
PlayDialogue();
}
private void PlayDialogue()
{
var dialogueSystem = IOCContainer.Resolve<IDialogueSystem>();
builder = new DialogueBuilder();
//First Piece
var piece = DialoguePiece.GetPooled();
piece.Content = "This is the first dialogue piece";
piece.PieceID = "01";
piece.AddOption(new DialogueOption()
{
Content = "Jump to Next",
TargetID = "02"
});
generator.AddPiece(piece);
//Second Piece
piece = DialoguePiece.GetPooled();
piece.Content = "This is the second dialogue piece";
piece.PieceID = "02";
var callBackOption = DialogueOption.GetPooled();
//Add CallBack Module
callBackOption.AddModule(new CallBackModule(() => Debug.Log("Hello World !")));
callBackOption.Content = "Log";
piece.AddOption(callBackOption);
generator.AddPiece(piece);
dialogueSystem.StartDialogue(generator);
}
}