34 Star 355 Fork 89

GVPOpen WaterFlames / RingRobotX 灵音

Create your Gitee Account
Explore and code with more than 12 million developers,Free private repositories !:)
Sign up
Clone or Download
contribute
Sync branch
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
README_en.md
Apache-2.0

RingRobotX | A Chinese Modular Speech Robot Framework Using Single-Wheel Dialogue Design
star fork
中文 | Documentation | Gitee | Github | Discussions

Write at the beginning

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:

  1. skill package with strong flexibility to dispose of skills at will.
  2. direct dialogue in the command window.
  3. configuration simplicity, configuration can be modified in the config directory, to avoid direct modification of the source code.
  4. continuous dialogue, finally you can play idiom solitaire with the robot.
  5. open, simple interface, easy to access.
  6. highly customizable.
  7. open HTTP interface, let your application quickly access RingRobotX framework!

Okay, ready to experience RingRobotX? Start now!

Must know

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)

Getting Started

Installation

This project currently supports linux environment for the time being

Option 1: Auto-install script

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.

Option 2: Manual installation

1. Install RingRobotX

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

2. Install the voice wakeup feature

*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 ... /

Install the skill package manager

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

Run

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

web backend

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

Settings

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

Contact

If you encounter a problem, or have a good suggestion, feel free to contact us at

Secondary Development

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.

Code Contribution

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!

Special thanks to

  • wzpan (This project borrows part of the basic underlying code from the wukong-robot project & snowboy training site. wukong-robot is really a superb project!)
  • The predecessor of this project, lingkong-robot, and its creator, Epeiuss

The English version is translated using DeepL, any errors are welcome to be pointed out.

This project only supports Chinese language use.

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

About

一个采用单轮对话设计的中文模块化语音机器人框架 expand collapse
Python and 3 more languages
Apache-2.0
Cancel

Releases (8)

All

Contributors

All

Activities

Load More
can not load any more
Python
1
https://gitee.com/waterflames-team/ring-robot-x.git
git@gitee.com:waterflames-team/ring-robot-x.git
waterflames-team
ring-robot-x
RingRobotX 灵音
master

Search

F2647f8d 8189591 Bbdfb06e 8189591