Skip to content

chyinan/Kokoro-Engine

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

505 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


Kokoro Engine banner

Kokoro Engine

Open-source immersive character engine for desktop AI companions.

为每一位想拥有专属AI聊天伴侣的用户打造的跨平台虚拟角色交互引擎。

Telegram community Tauri v2 React Rust MIT License

快速开始 · 下载安装 · 架构 · 贡献


Kokoro Engine 的独到之处

Kokoro Engine 不是“聊天壳子 + 桌宠皮肤”。它是一个完整的桌面角色运行时:

  • All-in-one:Live2D、LLM、TTS、STT等技术集成在一个运行时闭环。
  • Built for extensibility:高自由度 MOD 系统 + MCP 协议,天然面向扩展。
  • Local-first:本地存储记忆、离线优先、数据链路可控。

一览

维度 内容
面向用户 虚拟角色创作者、开发者、普通用户
交互能力 文本、语音、图片、视觉输入、多模态对话
扩展方式 MOD(HTML/CSS/JS + QuickJS)、MCP Servers
技术栈 React + TypeScript + Rust + Tauri v2 + SQLite
语言支持 简体中文 / English / 日本語 / 한국어 / Русский

📸 UI截图

Homepage

主界面

Settings

设置界面

🚀 快速开始

路径一:下载发布版(推荐)

前往 Releases 页面 下载对应平台安装包后直接运行。

路径二:从源码构建

环境要求

安装与运行

git clone https://github.com/chyinan/kokoro-engine.git
cd kokoro-engine
npm install
npm run tauri dev

构建发行版

npm run tauri build

路径三:Nix / Flakes(仅 Linux)

nix develop
npm install
npm run tauri dev

更多 Nix 用法见 docs/nix.md

✨ 核心能力

交互引擎

  • Live2D 渲染、视线追踪、动作触发、桌面浮窗
  • 模型热切换、帧率自定义

多维架构

  • 支持 Ollama 与 OpenAI 兼容协议API接口
  • 支持多模态输入、上下文回溯、长期记忆与情感状态

音频交互

  • TTS(文本转语音):GPT-SoVITS、VITS、OpenAI、Azure、ElevenLabs、Edge TTS、Browser TTS
  • STT(语音转文本):Whisper / faster-whisper / whisper.cpp / SenseVoice
  • 支持 VAD 自动停录与唤醒词链路

可拓展性

  • MOD 框架:HTML/CSS/JS 超高自由度 UI 主题替换 + QuickJS 脚本沙箱
  • MCP 支持:连接 MCP Server 并调用外部工具
  • 内置官方示范 MOD:mods/genshin-theme

远程连接

  • 内置 Telegram Bot 服务
  • 文字、语音、图片消息完整桥接到 AI 管线流

🏗️ 技术架构

flowchart LR
  subgraph FE["Frontend (React + TypeScript)"]
    FE_UI["UI Layout Engine"]
    FE_REG["Component Registry"]
    FE_THEME["Theme & MOD UI"]
    FE_BRIDGE["kokoro-bridge.ts"]
    FE_UI --> FE_REG
    FE_REG --> FE_THEME
    FE_THEME --> FE_BRIDGE
  end

  subgraph IPC["Tauri Typed IPC"]
    IPC_INVOKE["invoke / events"]
  end

  subgraph BE["Backend (Rust / Tauri v2)"]
    BE_CMD["Commands Layer"]
    BE_ORCH["AI Orchestrator"]
    BE_MULTI["LLM / TTS / STT / Vision / ImageGen / MCP"]
    BE_MOD["MOD Runtime (QuickJS)"]
    BE_TG["Telegram Bridge"]
    BE_CMD --> BE_ORCH
    BE_ORCH --> BE_MULTI
    BE_MOD --> BE_CMD
    BE_TG --> BE_CMD
  end

  subgraph DATA["Data & Runtime Config"]
    DB[("SQLite: memories / conversations / characters")]
    CFG["Config Files: llm/tts/stt/vision/imagegen/mcp/telegram"]
  end

  subgraph EXT["External Services"]
    EXT_LLM["OpenAI-Compatible / Ollama"]
    EXT_TTS["TTS Providers"]
    EXT_MCP["MCP Servers"]
    EXT_TG["Telegram"]
  end

  FE_BRIDGE <--> IPC_INVOKE
  IPC_INVOKE <--> BE_CMD

  BE_MULTI <--> EXT_LLM
  BE_MULTI <--> EXT_TTS
  BE_MULTI <--> EXT_MCP
  BE_TG <--> EXT_TG

  BE_ORCH <--> DB
  BE_CMD <--> CFG
Loading
  • 前端:声明式布局、组件注册、主题系统、MOD UI 注入
  • 后端:命令模块 + 多模态编排(LLM/TTS/STT/Vision/ImageGen/MCP)
  • 数据层:SQLite + 本地向量检索

详细设计见 docs/architecture.md

🗺️ 路线图

现在

  • 跨平台稳定性与兼容性验证(Windows / Linux / macOS)
  • 在线服务链路深度测试
  • 记忆系统与多模态体验持续优化

下一步

  • 角色市场 / 工坊
  • 移动端支持探索(iOS / Android)
  • 开发者扩展生态增强

🤝 参与贡献

欢迎通过以下方式参与:

  1. Pull Requests:修复问题或新增功能。
  2. Issues:提交问题与改进建议。
  3. Discussions:分享想法与实践。
  4. Design contributions:欢迎提供 Logo / 视觉资产。

💬 社区

👉 Kokoro Engine 官方讨论群(Telegram)

❤️ 赞助

👉 查看赞助方式 / Sponsor

🎉 特别鸣谢

感谢所有为 Kokoro Engine 做出贡献的贡献者。

@aegbirou
@aegbirou
@Initsnow
@Initsnow

📄 许可协议

本项目核心代码遵循 MIT License

⚠️ Live2D Cubism SDK 声明

本项目使用 Live2D Cubism SDK,相关部分归 Live2D Inc. 所有。使用本项目(包括编译、分发、修改)时,请遵守 Live2D 许可协议:

若您属于年营业额超过 1000 万日元的中大型企业,可能需要与 Live2D Inc. 签署单独商业授权协议。


Kokoro Engine is an open-source project. Live2D is a registered trademark of Live2D Inc.