amarok1412/rori_linux_client

The linux client for RORI

RORI: Linux client

This is the linux client for RORI

To have more informations on what is RORI, please see the wiki. But in short RORI is a modulable open-source chatterbot platform. The first version was written in 2011 (2.0 in September 2012). I rewrote it in Rust in 2017, and I'm currently migrating the whole communication to use GNU Ring.

Why RORI?

I run a lot of chatterbots on multiple services (IRC, Discord, Websites, my computer). Some bots do the exact same thing but run on a different service. The idea is to avoid to rewrite the core of each chatterbot and use the same base. Now, I just have to write an interface to communicate with this core on each services.

This is some examples of what I will do with RORI (as soon as the migration is finished):

• Ask RORI to launch music on the best device (on my computer, or stream on a discord server for example).
• Ask RORI to be alarmed at 7:40.
• Ask RORI to send messages to a friend.
• Ask RORI to shutdown a device.
• Send a picture to RORI and ask to store this pict in the best folder.
• Ask RORI to send me a notification before a rendez-vous.

Install

First, you will need mimic for the TTS capability (read install instructions or run make dep, this will install mimic and SpeechRecognition).

Then, make build to compile the client and make run to execute it.

Speech to text

For now, the client uses a Python module to perform speech recognition: Speech Recognition (see scripts/stt.py). It's a separate script which interact with the client via an API. This will be replaced when DeepSpeech will be good. To directly run the client with the Speech Recognition enabled, just run make run_with_stt.

Contribute

Please, feel free to contribute to this project in submitting patches, corrections, opening issues, etc.

If you don't know what you can do, you can look the good-first-issue label, or still creates modules.

For more infos and ideas read CONTRIBUTING.md (this file doesn't exists for now) and CODE_OF_CONDUCT.md.

rori_linux_client's Issues

Add music orders

• Play
• Pause
• Stop
• Next
• Previous
• Improve music by searching on youtube or on the computer

Add speech recognition

Will use: https://github.com/mozilla/DeepSpeech

Improve build system

• Add documentation for building
• Add Dockerfile
• Add .travis.yml
• Add simple scripts for running the client

Automatic language configuration

RORI can speak in a lot of languages. A way should exists to configure that automatically.

A configuration can be done like that: https://www.youtube.com/watch?v=VYhl-h5TzGQ&index=2&list=WL (first 3 minutes)

Add scenario tests

And 100% coverage

Login

Process

For now, the user need to enter the name server to connect. Then the username they want.
Now, there is two possibilities:

1. Username is already taken ask to link or to change
2. Username is not taken, /register

Full schema:

Connection to RORI

(1): If the name server exists ns/name/rori is retrieven.
(2): Else the user must change the name server

Connection with an username

(3): The username is not taken /register
(4): The username is already taken by the same ring id, connected (/addr/xxxx = username)
(5): The username is taken by someone, can change username
(6): The username is taken by someone, can link

Status

• (1)
• (2)
• (3)
• (4)
• (5)
• (6)

Gif in README.md

A little demo directly in the README.md could be awesome.

Add alarm order

For waking up!

Solve self-signed certificate

Actually Endpoint::get_ring_id() doesn't work with self-signed certificate.

Need to find a solution. Linked to AmarOk1412/rori_core#9

Add community files

• Update description
• README.md
• CODE_OF_CONDUCT.md
• License.md
• Issue and PR templates.

Operations should be done in a queue

For now, RORI can start the speech synthesis and say multiple message at the same time.

The Speech synth should have a queue to say messages one by one.

Could be perfect if the music is in a queue too.

Add speech synthesis

For now, use mimic

• Call mimic from code
• Install script
• Update README
• Add documentation in wiki

Future

• Switch to https://github.com/mozilla/tts if result is better.
• Wait for a free open source wavenet https://deepmind.com/blog/wavenet-generative-model-raw-audio/
• test mimic2 https://github.com/MycroftAI/mimic2

UI specification

TBD,

See AmarOk1412/RORI#2 for now