Coder Social home page Coder Social logo

andlo / ovos-core Goto Github PK

View Code? Open in Web Editor NEW

This project forked from openvoiceos/ovos-core

0.0 0.0 0.0 82.33 MB

OpenVoiceOS Core, the FOSS Artificial Intelligence platform.

Home Page: https://openvoiceos.com

License: Apache License 2.0

Shell 1.09% JavaScript 0.17% Python 80.36% QML 18.32% Dockerfile 0.06%

ovos-core's Introduction

License Unit Tests codecov PRs Welcome Chat GitHub Discussions

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.

Links

ovos-core's People

Contributors

00tiagopolicarpo00 avatar aatchison avatar aiix avatar aleale99 avatar amcgee7 avatar augustnmonteiro avatar chancencounter avatar christopherrogers1991 avatar chrisveilleux avatar davidwagnerkc avatar domcross avatar el-tocino avatar ethanaward avatar forslund avatar isaacnward avatar jarbasai avatar jarbasal avatar jasonehines avatar jdorleans avatar kathyreid avatar kfezer avatar krisgesling avatar learnedvector avatar matthewscholefield avatar neondaniel avatar neonjarbas avatar penrods avatar puretryout avatar soloveniaasaludar avatar the7erm avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.