Fay

Fay " style="max-width: 100%;">

Fay

Fay digital human framework

! ! Important notice: We will merge the three versions of Fay into one before December 31, 2024, and strive to provide more stable and comprehensive functions.

We are committed to thinking about terminal-oriented digital human applications and presenting the results to everyone through complete codes. The Fay digital human framework adapts upward to various digital human model technologies, downward to access various large language models, and facilitates the replacement of models such as TTS and ASR, providing a comprehensive digital human application interface for microcontrollers, apps, and websites.
Update log: https://qqk9ntwbcit.feishu.cn/wiki/UlbZwfAXgiKSquk52AkcibhHngg Documentation: https://qqk9ntwbcit.feishu.cn/wiki/JzMJw7AghiO8eHktMwlcxznenIg

Features

• Completely open source, no liability for commercial use
• Supports full offline use
• Support millisecond level reply
• Freely match digital human models, large language models, ASR, and TTS models
• Support digital human automatic broadcast mode (virtual teacher, virtual anchor, news broadcast)
• Support any terminal use: microcontroller, app, website, large screen, mature system access, etc.
• Support multi-user and multi-channel concurrency
• Provides text communication interface, voice communication interface, digital human model interface, management control interface, and automatic playback interface
• Support flexible configuration and execution of voice commands
• Supports custom knowledge base, custom question and answer pairs, and custom character information
• Supports waking up and interrupting conversations
• Support server and stand-alone mode
• Support robot expression output

Fay digital human framework

Source code startup

environment

• Python 3.9, 3.10, 3.11, 3.12
• Windows, macos, linux

Install dependencies

pip install -r requirements.txt

Configuration

• Modify the ./system.conf file according to the instructions

start up

Start the Fay controller

python main.py

or docker start

1. Download the assistant version https://github.com/xszyou/Fay
2. Modify the ./system.conf file
3. Delete pyqt5~=5.15.6 under requirements.txt

build (after modifying the configuration file, you need to rebuild)

docker build  -t Fay ./ Fay -assistant-edition

run

docker run -it --rm -p 5000:5000 -p 10001:10001 -p 10002:10002 -p 10003:10003 Fay 

Advanced gameplay

Use digital people (optional)

ue: https://github.com/xszyou/Fay-ue5

unity: https://qqk9ntwbcit.feishu.cn/wiki/Se9xw04hUiss00kb2Lmci1BVnM9

metahuman-stream (2d): https://qqk9ntwbcit.feishu.cn/wiki/Ik1kwO9X5iilnGkFwRhcnmtvn3e

duix (android): https://qqk9ntwbcit.feishu.cn/wiki/Ik1kwO9X5iilnGkFwRhcnmtvn3e()

aibote (windows cpu clone): [‍‍⁠‍‍‍‌https://qqk9ntwbcit.feishu.cn/wiki/ULaywzVRti0HXWkhCzacoSPAnIg

Integrate into your own products (not required)

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

connect

For communication groups and information tutorials, follow the public account Fay Digital People ( please star this warehouse first )