OVOS-core
OpenVoiceOS is an open source platform for smart speakers and other voice-centric devices.
Mycroft is a hackable, open source voice assistant by MycroftAI. OVOS-core is a backwards-compatible descendant of Mycroft-core, the central component of Mycroft. It contains extensions and features not present upstream. All Mycroft Skills and Plugins should work normally with OVOS-core. Other Mycroft-based assistants are also believed, but not guaranteed, to be compatible.
The biggest difference between OVOS-core and Mycroft-core is that OVOS-core is fully modular. Furthermore, common components have been repackaged as plugins. That means it isn't just a great assistant on its own, but also a pretty small library!
Furthermore, it offers a number of cli bindings. The old Mycroft shell scripts still exist, and still work, but that
stuff is now built into the Python program (docs to follow in the form of --help, because it's a lot.)
Installing OVOS-core (NOTE: at this early stage, required system libs are presumed, and your distribution might be a question mark.)
We suggest you do this in a virtualenv:
pip install ovos-core[all]
As always, the OpenVoiceOS team thanks the following entities (in addition to MycroftAI) for making certain code and/or manpower resources available to us which may not have been compatible with our practices before:
- NeonGecko
- KDE
- Blue Systems
Table of Contents
You can find detailed documentation over at the community-docs
Running Mycroft
start-mycroft.sh is available to perform common tasks.
Note: MycroftAI's dev_setup.sh does not exist in OVOS-core.
Assuming you installed mycroft-core in your home directory, run:
cd ~/ovos-core./start-mycroft.sh debug
The "debug" command will start the background services (microphone listener, skill, messagebus, and audio subsystems) as
well as bringing up a text-based Command Line Interface (CLI) you can use to interact with Mycroft and see the contents
of the various logs. Alternatively you can run ./start-mycroft.sh all to begin the services without the command line
interface. Later you can bring up the CLI using ./start-mycroft.sh cli.
The background services can be stopped as a group with:
./stop-mycroft.sh
Skills
Mycroft is nothing without skills. There are a handful of default skills, but most need to be installed explicitly.
See the Skill Repo to discover skills made by others.
Please share your own interesting work!
Getting Involved
This is an open source project. We would love your help. We have prepared a contributing guide to help you get started.
If this is your first PR, or you're not sure where to get started, say hi in OpenVoiceOS Chat and a team member would be happy to mentor you. Join the Discussions for questions and answers.