py-xiaozhi项目安装与配置指南

1. 项目基础介绍

py-xiaozhi 是一个使用 Python 实现的小智语音客户端项目。它旨在帮助那些没有硬件设备，但想要体验小智语音功能的人们。通过这个项目，用户可以在没有专门硬件的情况下，通过语音与AI小智进行交互。

2. 项目使用的关键技术和框架

此项目主要使用的编程语言是 Python。在关键技术方面，py-xiaozhi 使用了以下几种框架和库：

• WebSocket / MQTT：用于客户端与服务端之间的通信。
• Vosk：一个开源的语音识别库，用于将语音转换为文本。
• Opus：一个音频编解码库，用于处理音频数据。
• PyInstaller：用于将 Python 脚本打包成可执行文件。

3. 项目安装和配置的准备工作及详细步骤

准备工作

在开始安装之前，请确保您的操作系统是 Windows 10+、macOS 10.15+ 或 Linux，并且系统中已经安装了 Python。Python 的版本要求是 3.9 到 3.12 之间。

确保您的计算机上安装了以下依赖项：

• Python
• pip（Python 包管理器）
• git（版本控制系统）

安装步骤

1. 克隆项目

   打开命令行界面，使用以下命令克隆项目：

   git clone https://github.com/Huang-junsen/py-xiaozhi.git
   

2. 安装依赖

   进入项目目录，安装项目所需的 Python 包：

   cd py-xiaozhi
   pip install -r requirements.txt
   

   如果您使用的是 macOS，您可能需要运行：

   pip install -r requirements_mac.txt
   

3. 配置项目

   在项目目录中，有一个 config 文件夹，里面有一个 config.json 文件。您需要根据实际情况编辑这个文件，配置您的网络设置、音频设备等信息。

4. 运行项目

   运行以下命令启动项目：

   python main.py
   

   根据提示完成相应的设置和操作。

注意事项

• 在安装和配置过程中，如果遇到问题，请参考项目中的 README.md 文件以及 /docs/使用文档.md。
• 如果需要打包项目为可执行文件，可以使用 PyInstaller，运行 python scripts/build.py 脚本进行打包。

按照上述步骤操作，您应该能够成功安装和配置 py-xiaozhi 项目，并开始体验小智语音客户端的功能。