项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-08-09 · 当前星标 ★ 1735
使用教程
ℹ 本教程由 AI 依据该项目 README 整理,个别步骤可能需要按你的环境微调。
环境要求
- 已安装 Unity 引擎,并能打开/创建 Unity 项目
- 下载默认模型需要网络连接和数 GB 磁盘空间(模型约 GB 级)
- 本地推理需要足够内存;可通过 numGPULayers 把模型层卸载到 GPU
- Android 构建需在 Player Settings 中指定 IL2CPP 脚本后端和 ARM64 目标架构
- iOS 可直接使用默认 Player 设置构建
安装与启动步骤
-
1打开包管理器
在 Unity 编辑器中打开 Window > Package Manager,准备安装 LLM for Unity 包。
-
2从 Asset Store 安装
打开 LLM for Unity 资源页点击 Add to My Assets,在 Package Manager 下拉选择 Packages: My Assets,下载后 Import。
-
3或从 Git URL 安装
在 Package Manager 点击 + 按钮,选择 Add package from git URL,填入仓库地址 https://github.com/undreamai/LLMUnity.git 后点击 Add。
-
4创建 LLM 对象
在场景中新建一个空 GameObject,在 Inspector 点击 Add Component 并选择 LLM 脚本。
-
5下载或加载模型
在 LLM 组件上点击 Download Model 下载默认模型(约 GB 级),或用 Load model 加载自己的 .gguf 模型。
-
6配置移动端构建
如需发布 Android:在 Edit > Project Settings 的 Player > Other Settings 中选择 IL2CPP 与 ARM64;移动端建议使用 1-2B 的 Tiny 模型。
-
7启用移动端模型下载
开启 Download on Build 选项,让 App 首次启动时下载模型,可用 await LLM.WaitUntilModelSetup() 等待下载完成。
await LLM.WaitUntilModelSetup();
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
model | 是 | 指定使用的 .gguf 模型文件名,需已下载或加载到模型管理器 | Qwen3-4B-Q4_K_M.gguf |
systemPrompt | 否 | 设定角色的系统提示词,决定 AI 的角色设定 | A chat between a curious human and an artificial intelligenc |
assistantRole | 否 | 助手在对话中的显示名称 | AI |
userRole | 否 | 玩家在对话中的显示名称 | Human |
save | 否 | 聊天历史保存的文件名或相对路径,存于 persistentDataPath | AICharacter1.json |
numGPULayers | 否 | 卸载到 GPU 的模型层数,用于启用 GPU 加速 | 10 |
如何确认成功
在 Unity 中运行场景,模型下载/加载成功且 LLM 能正常返回回复即表示集成成功;可调用 Warmup 确认就绪。
常见问题
Q:安装完成后怎么开始使用?
A:通过 Add Component 给 GameObject 添加 LLM 脚本并下载模型即可开始;也可用代码 AddComponent<LLM>() 和 AddComponent<LLMAgent>() 动态创建。
Q:手机端能跑多大的模型?
A:移动端建议使用 1-2B 参数的 Tiny 模型,更大的模型通常因硬件受限无法运行。
Q:如何让模型只输出 JSON 等固定格式?
A:使用 grammar:在 LLMAgent 的 Grammar 字段填写语法,或用 Load Grammar 加载 gbnf/json schema 文件,例如 json.gbnf。
Q:Android 构建需要注意什么?
A:必须在 Player Settings 中指定 IL2CPP 脚本后端和 ARM64 目标架构,否则无法正常运行。
Q:聊天记录怎么保存和恢复?
A:设置 LLMAgent 的 Save 参数为文件名,可用 SaveHistory() 与 LoadHistory() 手动保存和加载,文件为 json 格式。
注意事项
- README 只提供 Unity 编辑器内的安装方式(Asset Store 或 Package Manager 的 git URL),没有命令行安装步骤。
- 默认模型体积约 GB 级,下载和推理需要预留磁盘空间与内存。
- 自定义 .gguf 模型可通过 Load model 按钮加载,也可直接复制到 StreamingAssets 文件夹。
- 远程服务器方式的说明在 README 节选中未完整给出,需查阅完整文档。
核心亮点
- 本地推理支持,无需额外服务器,数据隐私有保障
- 提供现成对话 UI 和 NPC 组件,接入门槛低
- 内置 RAG 能力,可让角色基于自定义知识库回答
不足之处
- 文档/社区待观察
- 本地推理对设备性能有一定要求,移动端体验需优化
适用场景
- 游戏内 NPC 智能对话与任务引导
- 交互式剧情或虚拟角色扮演体验
- 游戏内新手教程或客服问答助手
替代项目
Inworld AI、Convai、NPC Studio
同类项目推荐
给聊天 AI 一张会动的脸,对话立刻有温度。
Open-source SDK for driving Live2D & 3D avatars with LLM output. Give your AI a face···
claude-face
开源
80 万颗粒子拼一张脸,AI 开口跟你面对面。
Give your AI assistant a face — a WebGL particle talking-head (~800k dots) that spe···
Nova3D
开源
一句话生成可编辑3D模型,支持文本和图片输入。
Design workspace for programmable 3D. Nova builds assets and worlds as editable, ver···
HeadSculpt
开源
输入一句话,快速生成可编辑的 3D 头部头像
[NeurIPS 2023] HeadSculpt: Crafting 3D Head Avatars with Text
TaoMate
开源
一段音频,实时生成不崩脸的长视频数字人
a real-time digital-human model for long-form audio-video generation
kimodo
开源
扩散模型一键生成自然人体动作序列
Official implementation of Kimodo, a kinematic motion diffusion model for high-quali···
SpatialGen
开源
给个布局,自动生成逼真3D室内场景
[3DV 2026] SpatialGen: Layout-guided 3D Indoor Scene Generation
BrickGPT
开源
一句话生成能真实拼搭、站得稳的积木模型
[ICCV 2025 Best Paper] Official repository for BrickGPT, the first approach for gene···
xtalker
开源
在普通CPU上快速生成说话人脸动画,摆脱GPU依赖
Faster Talking Face Animation on Xeon CPU
