From fda36ddda7861cbaf0b39f691fc5a1e5c0cfd802 Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Sat, 21 Jun 2025 03:12:07 +0000 Subject: [PATCH] Update README.md --- .../ThirdParty/ToLua/Plugins/README.md | 157 +++++++++++++++++- 1 file changed, 156 insertions(+), 1 deletion(-) diff --git a/Assets/Nova/Sources/ThirdParty/ToLua/Plugins/README.md b/Assets/Nova/Sources/ThirdParty/ToLua/Plugins/README.md index 3b95f1e5..28388fda 100644 --- a/Assets/Nova/Sources/ThirdParty/ToLua/Plugins/README.md +++ b/Assets/Nova/Sources/ThirdParty/ToLua/Plugins/README.md @@ -1 +1,156 @@ -See https://github.com/Lunatic-Works/tolua_runtime +# Nova 引擎文档 + +## 简介 +Nova 是一个基于 Unity 的视觉小说引擎,提供了一套完整的工具链和运行时功能来帮助开发者创建视觉小说游戏。该引擎包含了从脚本解析、对话系统、动画控制到存档管理等一系列功能。 + +## 主要特性 +- **脚本解析系统**:支持通过 Lua 脚本定义游戏逻辑和对话内容。 +- **对话系统**:包括对话框控制器、选项选择、自动播放模式等。 +- **动画系统**:提供多种动画属性类,支持平滑过渡效果。 +- **存档与读档**:支持游戏状态的保存与恢复。 +- **国际化支持**:内置多语言支持,方便本地化游戏内容。 +- **UI 控件**:包含按钮环、配置面板、画廊等多种 UI 控件。 +- **资源加载与管理**:支持纹理、音频等资源的异步加载和缓存。 + +## 核心组件 + +### GameState +负责管理游戏的整体状态,包括当前节点、对话历史、变量存储等。 + +### DialogueState +管理对话的状态,如自动播放、快速前进等功能。 + +### CheckpointManager +实现游戏存档与读档功能,支持全局存档和分支剧情记录。 + +### ConfigManager +用于管理游戏配置,如音量、分辨率等设置。 + +### InputManager +处理输入映射,支持自定义按键绑定。 + +### LuaRuntime +集成 Lua 脚本环境,允许通过脚本控制游戏逻辑。 + +### NovaController +作为游戏的核心控制器,协调各个子系统的运作。 + +## 使用示例 + +### 创建一个新的对话节点 +```csharp +// 在 Lua 脚本中定义一个对话节点 +label("start") + text("主角", "欢迎来到我们的游戏世界!") + branch({ + { text = "开始冒险", dest = "adventure_start" }, + { text = "退出游戏", dest = "exit_game" } + }) +``` + +### 控制角色表情变化 +```csharp +// 使用 C# 控制角色表情 +GameCharacterController character = ...; // 获取角色控制器 +character.SetPose("happy"); // 设置角色表情为快乐 +``` + +### 播放背景音乐 +```csharp +// 使用 C# 播放背景音乐 +AudioController bgmController = ...; // 获取音频控制器 +bgmController.Play("background_music.mp3"); // 播放背景音乐 +``` + +### 显示图片画廊 +```csharp +// 使用 C# 显示图片画廊 +ImageGalleryController galleryController = ...; // 获取画廊控制器 +galleryController.Show(); // 显示图片画廊 +``` + +## 开发者工具 + +### CharacterPoseComposer +用于组合和编辑角色姿势的编辑器窗口。 + +### ImageGroupEditor +用于编辑图片组的编辑器扩展。 + +### MusicEntryEditor +用于创建和编辑音乐条目的编辑器扩展。 + +### SaveViewer +提供了一个可视化界面来查看和管理游戏存档。 + +## 资源管理 + +### AssetLoader +负责加载和缓存游戏资源,如纹理、音频等。 + +### PrefabFactory +用于实例化和管理预制体对象。 + +## 动画系统 + +### AnimationEntry +表示一个动画操作,可以链式调用以创建复杂的动画序列。 + +### NovaAnimation +管理多个动画条目,支持暂停、继续、停止等操作。 + +## 国际化支持 + +### I18n +提供多语言支持,包括字符串翻译和字体切换。 + +## 存档系统 + +### CheckpointManager +管理游戏存档点,支持保存和加载游戏进度。 + +## 输入系统 + +### InputManager +处理输入动作资产,支持不同平台的输入映射。 + +## 图形渲染 + +### RenderManager +管理渲染目标,支持全屏和窗口模式下的渲染调整。 + +### MaterialPool +提供材质池管理,支持材质的复用和恢复。 + +## UI 控件 + +### ButtonRing +实现环形按钮菜单,适用于移动设备上的操作菜单。 + +### DialogueTextController +管理对话文本的显示,支持富文本和样式定制。 + +## 脚本系统 + +### ScriptLoader +负责加载和解析游戏脚本文件。 + +### Parser +解析脚本文件中的对话和指令。 + +## 变量系统 + +### Variables +管理游戏中的变量,支持序列化和反序列化。 + +## 许可证 +请参阅项目中的 LICENSE 文件获取详细的许可信息。 + +## 贡献指南 +如果您有兴趣为本项目做出贡献,请参考项目的贡献指南。 + +## 问题反馈 +对于任何问题或建议,请提交 issue 或联系项目维护者。 + +## 更多信息 +有关更多详细信息,请查阅项目文档或访问项目主页。 \ No newline at end of file -- Gitee