LLMUnity 项目使用指南

LLMUnity 项目使用指南

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

1. 项目介绍

LLMUnity 是一个在 Unity 引擎中集成大型语言模型（LLMs）的开源项目。它允许开发者创建智能角色，这些角色可以与玩家进行互动，提供沉浸式的游戏体验。LLMUnity 基于 llama.cpp 和 llamafile 库构建，支持跨平台运行（Windows、Linux、macOS 和 Android），并且可以在本地运行，无需互联网访问。

2. 项目快速启动

2.1 安装方法

方法一：通过 Unity Asset Store 安装

1. 打开 LLMUnity 的 Asset Store 页面，点击“Add to My Assets”。
2. 在 Unity 中打开 Package Manager：Window > Package Manager。
3. 从下拉菜单中选择“Packages: My Assets”。
4. 选择 LLMUnity 包，点击“Download”，然后点击“Import”。

方法二：通过 GitHub 仓库安装

1. 在 Unity 中打开 Package Manager：Window > Package Manager。
2. 点击“+”按钮，选择“Add package from git URL”。
3. 输入仓库 URL：https://github.com/undreamai/LLMUnity.git，然后点击“Add”。

2.2 使用示例

以下是一个简单的使用示例，展示如何在 Unity 中创建一个智能角色并与之交互。

using LLMUnity;
using UnityEngine;

public class MyScript : MonoBehaviour
{
    public LLMCharacter llmCharacter;

    void HandleReply(string reply)
    {
        // 处理模型返回的回复
        Debug.Log(reply);
    }

    void Game()
    {
        // 游戏逻辑
        string message = "Hello bot";
        _ = llmCharacter.Chat(message, HandleReply);
    }
}

2.3 设置智能角色

1. 创建一个空的 GameObject。
2. 在 GameObject 的 Inspector 中点击“Add Component”，选择“LLM”脚本。
3. 点击“Download Model”按钮下载默认模型，或使用“Load model”按钮加载自定义模型。
4. 为每个角色创建一个空的 GameObject，并在 Inspector 中添加“LLMCharacter”脚本。
5. 在“Prompt”中定义角色的角色，设置 AI 和玩家的名字。
6. 在脚本中使用 llmCharacter.Chat 方法与角色进行交互。

3. 应用案例和最佳实践

3.1 应用案例

• Verbal Verdict I: 一个使用 LLMUnity 创建的智能角色，玩家可以与之进行对话。
• Chatbot: AISYLUM: 一个基于 LLMUnity 的聊天机器人项目，提供沉浸式的对话体验。
• Nameless Souls of the Void: 一个使用 LLMUnity 创建的角色，玩家可以与之进行深度互动。

3.2 最佳实践

• 优化模型加载: 使用“Download on Build”选项，在游戏启动时下载模型，以减小应用大小。
• 多角色管理: 通过设置“Parallel Prompts”和“Slot”来管理多个角色的上下文，优化性能。
• 自定义模型: 加载自定义的 .gguf 模型，以满足特定需求。

4. 典型生态项目

• llama.cpp: LLMUnity 的基础库，提供高效的 LLM 推理能力。
• llamafile: 用于管理和加载 LLM 模型的库，支持多种模型格式。
• Unity: 游戏开发引擎，LLMUnity 在此基础上提供了 LLM 的集成功能。

通过以上步骤，您可以快速上手 LLMUnity 项目，并在 Unity 中创建智能角色，提供丰富的互动体验。

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