Yarn Spinner 开源项目教程

1. 项目介绍

Yarn Spinner 是一个用于构建游戏内交互对话的工具。它允许开发者以简单的剧本格式编写交互式对话，并将其加载到游戏中运行。Yarn Spinner 提供了一个友好的界面，使得作家和程序员都能轻松使用，并且具有强大的功能来支持复杂的对话系统。

Yarn Spinner 已经被用于多个备受好评的游戏中，如《Night in the Woods》、《A Short Hike》、《DREDGE》、《Venba》、《Lost in Random》等。

2. 项目快速启动

安装 Yarn Spinner

首先，你需要从 Yarn Spinner 的 GitHub 仓库中获取项目代码：

git clone https://github.com/YarnSpinnerTool/YarnSpinner.git

编译项目

进入项目目录并编译项目：

cd YarnSpinner
dotnet build

使用 Yarn Spinner 进行对话编写

创建一个新的 .yarn 文件，例如 example.yarn，并编写以下内容：

title: Start
---
Hello, world!
===

加载并运行对话

在你的游戏项目中，使用 Yarn Spinner 提供的 API 加载并运行对话：

var dialogue = new Yarn.Dialogue(new Yarn.InMemoryVariableStorage());
dialogue.LoadScript(new Yarn.StringScript(File.ReadAllText("example.yarn")));
dialogue.SetNode("Start");
dialogue.Continue();

3. 应用案例和最佳实践

应用案例

• Night in the Woods: 使用 Yarn Spinner 创建了丰富的角色对话和故事情节。
• A Short Hike: 利用 Yarn Spinner 实现了游戏中的自然对话和互动。

最佳实践

• 模块化对话: 将对话内容模块化，便于管理和扩展。
• 使用变量: 利用 Yarn Spinner 的变量系统来动态调整对话内容。
• 测试对话: 在开发过程中频繁测试对话，确保逻辑和内容的正确性。

4. 典型生态项目

• Yarn Spinner for Unity: 官方支持的 Unity 插件，使得在 Unity 项目中使用 Yarn Spinner 更加便捷。
• Yarn Spinner for Unreal: 即将推出的 Unreal Engine 插件，预计在 2024 年初发布。

通过以上步骤，你可以快速上手并使用 Yarn Spinner 来增强你的游戏对话系统。