Open-LLM-VTuber 项目使用教程

Open-LLM-VTuber 项目使用教程

Open-LLM-VTuber Talk to LLM by voice with Live2D that runs offline on multiple platforms. An attempt to build AI VTuber neuro-sama. 项目地址: https://gitcode.com/gh_mirrors/op/Open-LLM-VTuber

1. 项目的目录结构及介绍

Open-LLM-VTuber 项目是一个开源的AI语音交互项目，其目录结构如下：

• assets/：存放项目所需的静态资源，如图片、音频等。
• avatars/：存放角色头像和相关资源。
• backgrounds/：存放背景图片资源。
• characters/：存放Live2D角色的模型文件和资源。
• config_templates/：包含项目配置文件的模板。
• doc/：存放项目的文档和相关说明。
• frontend/：前端代码目录，包含Web界面相关的HTML、CSS和JavaScript文件。
• live2d-models/：存放Live2D模型的目录。
• prompts/：存放提示词和对话相关的文件。
• src/：源代码目录，包含项目的核心逻辑。
• web_tool/：Web工具目录，可能包含一些Web相关的辅助工具。
• .github/：GitHub工作流和配置文件。
• .gitattributes：Git属性配置文件。
• .gitignore：Git忽略文件列表。
• .gitmodules：Git子模块配置文件。
• .pre-commit-config.yaml：预提交钩子配置文件。
• .python-version：指定项目使用的Python版本。
• LICENSE：项目许可证文件。
• README.CN.md：中文项目自述文件。
• README.md：英文项目自述文件。
• dockerfile：Docker镜像构建文件。
• merge_configs.py：配置文件合并脚本。
• model_dict.json：模型字典文件。
• pixi.lock：Pixi.js相关锁文件。
• pyproject.toml：Python项目配置文件。
• run_server.py：项目启动脚本。
• upgrade.py：项目升级脚本。
• uv.lock：UVicorn相关锁文件。

2. 项目的启动文件介绍

项目的启动文件是 run_server.py。该文件负责启动项目的服务器。以下是启动文件的主要功能：

• 加载配置文件。
• 初始化服务器环境。
• 启动Web服务器，通常是使用UVicorn。

要启动项目，你需要在项目的根目录下运行以下命令：

python run_server.py

3. 项目的配置文件介绍

项目的配置文件通常是 config.yaml，它位于项目的根目录下。该文件包含了项目运行所需的各种配置信息，如：

• 服务器配置：包括监听端口、日志等级等。
• 模型配置：包括使用的LLM模型、TTS模型、ASR模型等。
• 前端配置：包括Web界面的一些设置。
• 角色配置：包括Live2D角色的设置，如表情、动作等。

配置文件采用YAML格式，以下是配置文件的一个基本示例：

server:
  port: 8000
  log_level: info

model:
  llm: ollama
  tts: pyttsx3
  asr: sherpa-onnx

frontend:
  theme: default

character:
  name: default
  appearance: default

根据需要，用户可以修改这些配置以适应不同的运行环境和需求。在修改配置文件后，需要重启服务器以使配置生效。

Open-LLM-VTuber Talk to LLM by voice with Live2D that runs offline on multiple platforms. An attempt to build AI VTuber neuro-sama. 项目地址: https://gitcode.com/gh_mirrors/op/Open-LLM-VTuber