Fay README

The project's README from github.com/xszyou/Fay. As one markdown file: README.md.


Fay

FAY

Fay数字人框架

!!重要通知:我们已经把Fay的三个版本合并成1个,并致力提供更稳定更全面的功能。

我们致力于思考面向终端的数字人落地应用,并通过完整代码把思考结果呈现给大家。Fay数字人框架,向上适配各种数字人模型技术,向下接入各式大语言模型,并且便于更换诸如TTS、ASR等模型,为单片机、app、网站提供全面的数字人应用接口。
更新日志:https://qqk9ntwbcit.feishu.cn/wiki/UlbZwfAXgiKSquk52AkcibhHngg 文档:https://qqk9ntwbcit.feishu.cn/wiki/JzMJw7AghiO8eHktMwlcxznenIg

功能特点

Fay数字人框架

源码启动

环境

安装依赖

pip install -r requirements.txt

快速启动

本地

python main.py start -config_center d19f7b0a-2b8a-4503-8c0d-1a587b90eb69  #使用公共资源,速度非常慢,建议更换成自己的key

镜像

https://www.compshare.cn/images/compshareImage-1cft3sk9gvta?ytag=GPU_fay

个性化配置

管理页面

高级玩法

使用数字人(非必须)

https://qqk9ntwbcit.feishu.cn/wiki/GHevwqxwfiX4hCk8yJCcoJ54nqg

集成到自家产品(非必须)

https://qqk9ntwbcit.feishu.cn/wiki/Mcw3wbA3RiNZzwkexz6cnKCsnhh

联系

交流群及资料教程关注公众号 fay数字人(请先star本仓库)

商务联系

qq467665317

致谢

感谢以下开源项目为 Fay 提供的技术支持:

Fay (xszyou/Fay)

Searching Database…

13.6K ·GitHub
What is this?An open-source Python agent framework that connects a digital human or an LLM to your business systems: it adapts to various avatar model tech and LLMs on top, and serves digital-human APIs down to microcontrollers, apps and websites.
Do I run it as a service, or import it as a library?You run it as a service — it supports both server mode and standalone mode — and your clients talk to it through text, voice, digital-human-driving, admin-control, auto-broadcast and intent interfaces.
How do I get it running?Run it from source on Python 3.12 (Windows, macOS or Ubuntu — on Ubuntu install gcc and portaudio first): install the dependencies, rename system.conf.bak to system.conf and fill in your settings, then open the admin page in a browser.
Which LLMs and voice models can I plug in?Everything is freely swappable: any OpenAI-compatible LLM endpoint, including DeepSeek and its thinking models, plus your choice of ASR and TTS engines — FunASR supplies speech recognition.
What kind of clients can connect to it?Almost anything: microcontrollers, mobile apps, websites, big screens and third-party business systems, with multi-user multi-channel concurrency and a browser-based admin page for management.
Can it run fully offline?Yes — fully offline operation is a listed feature, so with local ASR, TTS and LLM choices the whole voice-and-chat loop can stay on your own hardware.
What kind of avatars can it drive?2.5D and 3D digital humans — including UE5 and Unity projects per the repo topics — on mobile, PC or web, with facial-expression output supported. Hooking up a digital human is optional: it also runs as a plain LLM or voice agent.
Can it start a conversation on its own, or only respond?It can talk first: there is an auto-broadcast mode for virtual teachers, virtual streamers and news anchors, schedule-based proactive dialogue, plus wake-word activation with interruption support.
Can I give it my own knowledge base and personality?Yes — custom knowledge bases, custom Q&A pairs and custom persona info are supported, and it keeps bionic memory so the character stays consistent. Voice commands are configured in qa.csv.
Does it support tool calling and MCP?Yes — the agent can decide on its own when to call tools, and Fay includes MCP tool management with SSE and studio modes. The credits note the tool-calling design references OpenAI Codex and the memory and skills design references openclaw.
Can I use it in a commercial product?The code is GPL-3.0 and the README describes the project as fully open source with a commercial-use disclaimer; for business integrations the author lists a QQ contact.
Creator
xszyou
Size
170.9 MB
Stars
13.6K
Updated
CommitSep 21
Age
4y
Commits · 90 Days