LLMUnity 项目使用教程

LLMUnity 项目使用教程

LLMUnity Create characters in Unity with LLMs! 项目地址: https://gitcode.com/gh_mirrors/ll/LLMUnity

1. 项目目录结构及介绍

LLMUnity 项目的目录结构如下：

LLMUnity/
├── Editor/
│   ├── LLMUnity.csproj
│   └── ...
├── Resources/
│   └── ...
├── Runtime/
│   └── ...
├── Samples~/
│   ├── SimpleInteraction/
│   ├── MultipleCharacters/
│   ├── KnowledgeBaseGame/
│   ├── ChatBot/
│   └── AndroidDemo/
├── Tests/
│   └── ...
├── .editorconfig
├── .gitattributes
├── .gitignore
├── CHANGELOG.md
├── CHANGELOG.release.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE.md
├── README.md
├── Third Party Notices.md
└── VERSION

目录介绍

• Editor/: 包含编辑器相关的脚本和配置文件。
• Resources/: 包含项目所需的资源文件。
• Runtime/: 包含运行时所需的脚本和配置文件。
• Samples~/: 包含多个示例项目，展示了如何使用 LLMUnity 进行游戏开发。
• Tests/: 包含项目的测试脚本和配置文件。
• .editorconfig: 编辑器配置文件。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件配置。
• CHANGELOG.md: 项目变更日志。
• CHANGELOG.release.md: 发布版本的变更日志。
• CODE_OF_CONDUCT.md: 项目行为准则。
• CONTRIBUTING.md: 贡献指南。
• LICENSE.md: 项目许可证。
• README.md: 项目介绍和使用说明。
• Third Party Notices.md: 第三方软件声明。
• VERSION: 项目版本文件。

2. 项目启动文件介绍

LLMUnity 项目的启动文件主要位于 Runtime/ 目录下。以下是一些关键的启动文件：

• LLM.cs: 负责管理大型语言模型（LLM）的核心脚本。
• LLMCharacter.cs: 负责管理游戏中的角色与 LLM 的交互。

启动流程

1. 初始化 LLM: 在游戏启动时，首先初始化 LLM 对象，加载所需的 LLM 模型。
2. 创建角色: 使用 LLMCharacter 脚本创建游戏中的角色，并配置其与 LLM 的交互行为。
3. 启动游戏: 启动游戏场景，开始游戏逻辑。

3. 项目配置文件介绍

LLMUnity 项目的配置文件主要位于 Resources/ 目录下。以下是一些关键的配置文件：

• LLMUnity.csproj: 项目的 C# 项目文件，定义了项目的依赖和构建配置。
• LLMUnitySettings.asset: 项目的设置文件，包含了 LLM 和角色的配置选项。

配置选项

• 模型路径: 指定 LLM 模型的路径。
• 角色配置: 配置游戏中的角色，包括角色的名称、提示词等。
• 远程服务器: 配置远程服务器的地址和端口，用于远程推理。
• 日志级别: 配置日志的详细程度。

通过这些配置文件，开发者可以灵活地调整 LLMUnity 的行为，以适应不同的游戏开发需求。

LLMUnity Create characters in Unity with LLMs! 项目地址: https://gitcode.com/gh_mirrors/ll/LLMUnity