English | 文档 | Gitee 仓库 | Github仓库 | Discussions
这是一个采用单轮对话设计的中文模块化语音机器人框架，由 WaterFlames团队 使用 Python 制作，根据本团队项目 Lingkong-Robot 重构而来。
可用于智能音箱，语言遥控，甚至智能客服、家庭管家、微信机器人等等。
目的是让中国的 Maker 们也能够「一小时」入门，无需过多以及不必要的配置。
特色功能：
- 技能包具有较强的灵活性，可随意支配技能
- 命令窗口直接对话
- 配置简单化，配置可以在 config 目录修改，避免直接修改源代码
- 实现了连续对话，终于可以和机器人玩成语接龙了
- 开放，简洁的接口，接入简单
- 高度可自定义
- 开放的 HTTP 接口，让你的应用程序快速接入 RingRobotX 框架！
好了，准备好体验 RingRobotX 了吗？现在开始！
RingRobotX 是 Lingkong-Robot 的重构版本
RingRobotX默认（git仓库版本）内置图灵、百度ASR&TTS、snowboy唤醒插件
（是的即使snowboy停止维护了但是还能耍
在线模型训练：https://snowboy.hahack.com/
感谢wzpan老师的网站）
目前本项目暂且支持 linux 环境下运行
自动安装脚本只支持使用apt的linux发行版（如debian，ubuntu等等），建议你使用清华软件源
若您要使用稳定版本，请运行：
wget -O install.sh https://gitee.com/waterflames-team/ring-robot-x/raw/master/install.sh && sudo bash install.sh若您要使用测试版本，请运行：
wget -O install.sh https://gitee.com/waterflames-team/ring-robot-x/raw/develop/install.sh && sudo bash install.sh安装程序会安装到脚本执行目录/ringrobotx/ring-robot-x
当然，如果你是其他发行版（或者一键安装脚本有错误），可以试着第二种方案：手动安装。
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运行此命令后，ring将会下载到命令执行的目录
当然，如果你追求稳定，可以从我们的项目仓库下载发行版或直接下载master分支的内容
如果你追求新功能，请下载develop分支的内容
PS：若您不准备使用snowboy功能，那么可以跳过此步，并将下载的项目目录/func_packages/ZZZ_Snowboy/config.json中“"enable": ”后面的true改为false
唤醒功能依赖snowboy
为了避免某些问题，snowboy暂时不会集成到ringrobotx
所以，我们需要手动安装snowboy
请执行以下命令：
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 #以下命令需要在RingRobotX安装的目录运行
marx install web #安装管理后台
marx install chathistory #管理后台的依赖Mariner-RRX 是我们为 RingRobotX 所准备的一个技能管理器，命令为 marx。详细请见 marx
安装后第一次运行会自动初始化技能，请稍等一小会
cd ringrobotx/ring-robot-x
python3 ring.py内置的模型唤醒词是“灵空灵空”，不同设备上录音会有不同效果，建议在自己设备上训练效果更好
你可以替换掉，模型文件在config/snowboy/model.pmdl
运行后，程序默认会在本地的8901端口开启一个后台
用户名随意，密码在第一次启动会随机设置，请留意控制台输出
你可以修改密码、端口号在/config/RingRobotX_Web.json中
详见config目录下的各种json文件
如果你需要禁用某一插件，那么到func_packages/插件名/config.json的enable改为false即可
更多有关入门的内容戳我查看文档
如果遇到了问题，或者是有一个好建议，欢迎联系我们：
- 你可以选择 戳我 来创建一个issue
- 也可以通过邮箱联系我们：[email protected]
- 或是通过以下方式加入用户群
如果你准备将其闭源并商业使用，那么请确认你知晓 WaterFlames水焰 不为任何使用了二次分发软件的 安全性，可用性，完整性 以及其可能带来的 其它风险及损失 承担责任。
其余或有冲突之处以 Apache License 2.0 开源协议为准
另外，本项目不受 LingKongRobot 的 GPL 协议影响。
我们欢迎每一位创作者加入本项目的开源贡献中。欢迎每一位贡献者创建pr，并按照 提交信息规范 来为项目进行贡献！
感谢每一位贡献者！
如果您觉得我们的开源软件对你有所帮助，可以向 WaterFlames 提供支持,戳这里 -> https://afdian.com/a/epeiuss
- wzpan （本项目借鉴了 wukong-robot 项目的一部分基本底层代码 & snowboy训练网站。wukong-robot真的是个超级无敌好项目！）
- 本项目的前身 lingkong-robot 及其创作者Epeiuss