中文 | Documentation | Gitee | Github | Discussions
This is a Chinese modular voice bot framework designed with a single round of dialogue, made in Python by the WaterFlames team and refactored from our project Lingkong-Robot.
It can be used for smart speakers, language remote control, and even smart customer service, family butler, WeChat robot, etc.
The goal is to allow even ‘Maker’ to get started in "one hour" without excessive and unnecessary configuration.
Featured features:
Okay, ready to experience RingRobotX? Start now!
RingRobotX is a refactored version of Lingkong-Robot
RingRobotX by default (git repository version) has built-in Turing, Baidu ASR&TTS, and snowboy wakeup plugins
(Yes, even though snowboy is no longer maintained, it can still be played)
Online model training: https://snowboy.hahack.com/
Thanks to Mr. wzpan for his website)
This project currently supports linux environment for the time being
The automatic installation script only supports linux distributions that use apt (such as debian, ubuntu, etc.), and it is recommended that you use Tsinghua Software Source
If you want to use a stable version, please run.
wget -O install.sh https://gitee.com/waterflames-team/ring-robot-x/raw/master/install.sh && sudo bash install.sh
If you want to use a test version, run.
wget -O install.sh https://gitee.com/waterflames-team/ring-robot-x/raw/develop/install.sh && sudo bash install.sh
** The installer will install to the script execution directory /ringrobotx/ring-robot-x**
Of course, if you are on another distribution (or the one-click install script has errors), you can try the second option: manual installation.
sudo apt install python3 python3-pip git python3-pyaudio swig libatlas-base-dev pulseaudio make alsa-utils sox libsox-fmt-mp3
mkdir ringrobotx && cd ringrobotx
git clone https://gitee.com/waterflames-team/ring-robot-x
cd ring-robot-x
pip3 install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple some-package
After running this command, ring will be downloaded to the directory where the command was executed
Of course, if you are looking for stability, you can download the distribution from our project repository or download the master branch directly
If you are looking for new features, please download the development branch
*PS: If you are not going to use the snowboy feature, then you can skip this step and change true to false after ""enable":" in the downloaded project directory /func_packages/ZZZ_Snowboy/config.json *
Wake-up function depends on snowboy
To avoid some problems, snowboy will not be integrated into ringrobotx for now
So, we need to install snowboy manually
Please execute the following command.
git clone https://github.com/Kitt-AI/snowboy.git
cd snowboy/swig/Python3
make
cd ... /... /... /...
cp snowboy/swig/Python3/_snowboydetect.so ring-robot-x/func_packages/ZZZ_Snowboy
cp snowboy/examples/Python3/snowboydetect.py ring-robot-x/func_packages/ZZZ_Snowboy
cp -a snowboy/resources/ ring-robot-x/func_packages/ZZZ_Snowboy/resources
cd ... /
pip3 install mariner-rrx #The following command needs to be run in the directory where RingRobotX is installed
marx install web #Install the admin backend
marx install chathistory #Manage backend dependencies
Mariner-RRX is a skill manager that we have prepared for RingRobotX with the command marx. See marx for details
The first run after installation will automatically initialize the skills, please wait a little while
cd ringrobotx/ring-robot-x
python3 ring.py
The built-in model wake-up word is "Lingkong Lingkong", the recording will have different effects on different devices, it is recommended to train on your own device for better results
You can replace it, the model file in config/snowboy/model.pmdl
After running, the program will open a backend on local port 8901 by default
User name is random, password will be set randomly in the first start, please pay attention to the console output
You can change the password and port number in /config/RingRobotX_Web.json
See the various json files in the config directory for details
If you need to disable a plugin, then go to func_packages/plugin_name/config.json and change enable to false
For more on getting started poke me for the documentation
If you encounter a problem, or have a good suggestion, feel free to contact us at
If you are prepared to close the source and use it commercially, then please make sure you know that WaterFlames is not responsible for the security, availability, integrity, and other risks and losses that may result from any use of the secondary distribution software.
The Apache License 2.0 Open Source Agreement governs any remaining or conflicting terms.
In addition, this project is not subject to LingKongRobot's GPL license.
We welcome every creator to contribute to the open source project. Each contributor is welcome to create a pr and contribute to the project according to the Submission Information Specification!
Thanks to every contributor!
If you find our open source software helpful, you can provide support to WaterFlames by clicking here -> https://afdian.com/a/epeiuss
The English version is translated using DeepL, any errors are welcome to be pointed out.
This project only supports Chinese language use.
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。
1. Open source ecosystem
2. Collaboration, People, Software
3. Evaluation model