使用提示词塑造人格，可自由切换本地与云端模型的 AI 桌面伴侣。
English | 简体中文
--- 如果你喜欢让丛雨陪在桌面上，就请给项目一颗 [Star ⭐](https://github.com/kuxiaowo/AIpet-Murasame/stargazers)，或去 [B站](https://space.bilibili.com/1067030066) 点个关注吧～丛雨会很开心，维护者也会更有动力继续更新的！ ## 项目简介 AIpet 是一款面向 Windows 的丛雨 AI 桌宠。它将透明 PyQt5 角色窗口、本地或 云端对话、可选的屏幕感知、GPT-SoVITS 语音输出和 faster-whisper 语音输入 组合在一起。 项目基于 [LemonQu-GIT/MurasamePet](https://github.com/LemonQu-GIT/MurasamePet) 继续开发。演示、部署视频和项目动态见 [哔哩哔哩主页](https://space.bilibili.com/1067030066)。 ## 主要功能 - 支持 Ollama 本地对话，以及 DeepSeek、阿里云百炼和 OpenAI 兼容 API - 对话与视觉后端可独立配置，屏幕感知默认关闭 - 提示词人格、两套立绘姿态、六种情绪和四套服装 - 本地或 AutoDL 云端 GPT-SoVITS 语音合成 - 基于 faster-whisper 的按键语音输入 - 对话记忆、屏幕事件摘要、主动提醒和持久化勿扰模式 - 透明多屏窗口、Windows 置顶守护、中英双语设置和结构化诊断日志 ## 快速开始 项目主要支持 Windows 10 和 Windows 11。 ### macOS 适配 使用 M 系列芯片的 Mac 可参阅 [macOS 适配说明](../../aipet/platforms/macos/README.md)。macOS 平台代码与 Windows 行为相互隔离，目前支持源码运行和 DMG 打包。 ### 直接运行 Windows EXE 从项目 [Releases 页面](https://github.com/kuxiaowo/AIpet-Murasame/releases) 选择一个版本： - **`AIpet.exe`（标准版，约 194 MiB）：**不附带 CUDA，适合使用 CPU 进行 Whisper 语音识别，或不需要本地语音识别 GPU 加速的用户。不确定 应该下载哪个版本时，建议选择这个版本。 - **`AIpet-with-cuda.exe`（CUDA 版，约 1.4 GiB）：**附带 CUDA 12 cuBLAS、cuDNN 9 和 NVRTC，可通过兼容的 NVIDIA 显卡加速本地 faster-whisper 语音识别；仍需安装兼容的 NVIDIA 显卡驱动。如果在设置中 选择 CUDA，请使用这个版本。 两个版本拥有相同的应用功能和设置界面。CUDA 版体积较大，仅仅是因为其中 附带了 GPU 运行库。 两个版本还包含 7-Zip LZMA SDK 提供的 public-domain `7zr.exe` 解压器。AIpet 下载并安装托管的 GPT-SoVITS 引擎时，不再要求用户另行安装 7-Zip。 1. 下载所选的 EXE。如果该版本没有 EXE，请使用下方的源码方案。 2. 把程序放到长期使用且可写的目录，例如 `C:\AIpet\`。 3. 双击下载的 EXE。 两个 EXE 均已包含应用程序和 faster-whisper 运行依赖，不要求安装 Python、Conda 或 Git。聊天模型、Whisper 模型及 GPT-SoVITS 资源不会打进 EXE；可选资源只会在设置界面确认后下载。 ### 从源码运行 先安装 [Git](https://git-scm.com/) 和 [Conda 或 Miniconda](https://docs.conda.io/)，然后执行： ```powershell git clone https://github.com/kuxiaowo/AIpet-Murasame.git cd AIpet-Murasame conda env create -f environment.yml conda activate aipet python main.py ``` 源码版如需语音输入，再安装附加依赖： ```powershell python -m pip install -r requirements-voice.txt ``` ### 配置对话后端 AIpet 至少需要本地 Ollama 或一种云端 API。 使用 Ollama 时，启动服务并拉取对话模型；视觉模型可选： ```powershell ollama pull qwen3.5:9b ``` 使用云端服务时，可以在设置中填写密钥，也可以使用环境变量： ```powershell $env:DEEPSEEK_API_KEY = "your-key" $env:DASHSCOPE_API_KEY = "your-key" $env:OPENAI_API_KEY = "your-key" ``` 首次启动后，选择后端与模型，填写用户名称，并通过切换界面语言分别检查中、 英文人格提示词后保存。运行时会自动选择对应语言的人格、模型指令、屏幕分析 提示词和显示文本。语音识别语言可独立设置为跟随界面、自动检测、常用语言， 也可以填写 Whisper 语言代码。视觉、TTS 和语音输入属于可选功能，相关依赖 尚未准备好时请先保持关闭。 ## 可选功能 | 功能 | 配置方法 | |---|---| | 屏幕感知 | 启用“屏幕视觉”，选择 Ollama、阿里云百炼或 OpenAI 兼容视觉模型。截图仅作临时处理，不写入对话历史。 | | 本地 TTS | 启用“TTS → 本地计算机”，选择 GPT-SoVITS 引擎和丛雨语音模型目录。缺少的托管资源可在确认后下载，所需的 7z 解压器已包含在 AIpet 中。 | | AutoDL TTS | 启用“TTS → AutoDL 云端”，填写 SSH 登录信息、远程命令和参考音频目录。远程实例需已在 `9880` 端口提供 GPT-SoVITS 服务。 | | 语音输入 | 启用语音输入，选择麦克风、计算设备、faster-whisper 模型和识别语言。识别语言可以跟随界面、自动检测、选择常用语言或填写 Whisper 语言代码。长按 Caps Lock 两秒开始录音，松开后识别并发送。 | TTS 失败不会丢弃文字回复。临时截图、录音和合成语音会自动清理，也可以在 设置中手动清除。 ## 桌宠操作 | 操作 | 控制方式 | |---|---| | 输入消息 | 左键单击角色下半部分，输入后按 Enter | | 取消输入 | 按 Escape | | 摸头 | 在头部按住鼠标左键并横向移动 | | 移动桌宠 | 按住鼠标中键拖动 | | 语音对话 | 启用语音输入后长按 Caps Lock 两秒 | | 设置、视觉、勿扰、记忆、退出 | 使用系统托盘菜单 | 把桌宠拖到另一台显示器后，程序会自动更新显示器和立绘比例。 ## 数据与隐私 Windows 上的设置和持久化数据保存在： ```text %APPDATA%\AIpet-Murasame\ ├── config.json ├── history.json ├── screen_memory.json ├── personality.en.txt ├── personality.zh-CN.txt └── logs\ ``` 临时运行数据保存在 `%LOCALAPPDATA%\AIpet-Murasame\cache\`。下载模型默认 保存在 `C:\AIpet\models\`；可以通过 `AIPET_MODEL_DIR` 修改模型目录。 在设置中填写的 API Key 会写入 `config.json`。如果不希望密钥进入配置文件， 请把密钥字段留空并使用环境变量。日志会对已识别的密钥字段脱敏，并把大型 Base64 媒体替换成元数据。 ## 开发 项目将共享业务逻辑与操作系统集成分开维护。添加新平台支持前，请先阅读 [平台适配层架构](../architecture/platform-adapters.md)。 在 `aipet` Conda 环境中运行测试： ```powershell $env:QT_QPA_PLATFORM = "offscreen" python -m unittest discover -s tests -v ``` 同时构建两个 Windows 单文件 EXE： ```powershell .\packaging\build_exe.ps1 ``` 脚本会在需要时创建独立的 `aipet_build_whisper` Conda 环境，并输出： - `dist\AIpet.exe`：标准 CPU 版本。 - `dist\AIpet-with-cuda.exe`：附带 CUDA 12 cuBLAS、cuDNN 9 和 NVRTC 运行库，可用于本地 Whisper GPU 推理的 CUDA 版本。 构建前，脚本会使用固定的 SHA-256 校验随项目提供的 7-Zip/LZMA SDK 26.02 `packaging\vendor\7zip\7zr.exe`，两个 EXE 都会包含该解压器。 文件缺失或被修改时构建会停止。来源、校验值和升级步骤见 [`packaging/vendor/7zip/README.md`](../../packaging/vendor/7zip/README.md)。 打包完成后，脚本还会读取两个 PyInstaller 归档，提取其中的 `7zr.exe`， 再次校验哈希并实际执行一次冒烟测试。 构建环境未变化时可跳过依赖安装： ```powershell .\packaging\build_exe.ps1 -SkipDependencyInstall ``` 跳过依赖安装时，构建环境中必须已有 CUDA 12 cuBLAS、cuDNN 9 和 NVRTC 运行库。如果它们不在构建环境的 `Library\bin` 中，可以分别指定目录： ```powershell .\packaging\build_exe.ps1 -SkipDependencyInstall ` -CudaDllDirectory C:\path\to\cublas\bin ` -CudnnDllDirectory C:\path\to\cudnn\bin ` -CudaNvrtcDllDirectory C:\path\to\nvrtc\bin ``` 主要目录： ```text aipet\core\ 共享后端、配置、存储、语音和后台任务 aipet\ui\ 共享桌宠与中英双语设置窗口 aipet\platforms\ 平台接口与各平台实现 packaging\ 可重复执行的 PyInstaller 构建 tests\ 单元测试、平台契约测试和 UI 冒烟测试 ``` ## 已知限制 - Windows 仍是主要发行平台；macOS 适配面向 macOS 13 或更高版本的 M 系列芯片 Mac。 - 独占全屏或受反作弊保护的画面仍可能覆盖桌宠。 - 本地对话、视觉与 TTS 的速度取决于模型和硬件。 - 角色立绘与语音素材的使用条款可能不同于源代码许可证。 ## 致谢与许可证 - 原作桌宠项目： [LemonQu-GIT/MurasamePet](https://github.com/LemonQu-GIT/MurasamePet) - 语音合成项目： [RVC-Boss/GPT-SoVITS](https://github.com/RVC-Boss/GPT-SoVITS) - 内置 7z 解压功能： [7-Zip LZMA SDK](https://www.7-zip.org/sdk.html)。项目原样包含 public-domain 的 `7zr.exe` 26.02；来源和 SHA-256 见 [`packaging/vendor/7zip/README.md`](../../packaging/vendor/7zip/README.md)。 源代码依据 [GNU Affero General Public License v3.0](../../LICENSE) 发布。 本项目是用于学习与技术交流的非官方同人项目。丛雨以及项目包含的第三方立绘、 语音和其他相关素材，其权利归 YUZUSOFT 等各自权利人所有，不因 AGPL 源代码许可证而被重新授权。未经许可，请勿将这些素材用于商业用途。