This documentation was last modified: Tuesday, May 14th, 2019 at 6:52 pm
Welcome to the documentation for all elements of Mycroft – the open source voice assistant.
Our documentation, just like our source code, is open source, and you can contribute to improving it here. Alternatively, please rate our documentation and leave comments on how we can improve.
- About Mycroft
- Getting Mycroft
- Your home.mycroft.ai account
- Mark 1
- Mycroft for Linux platforms
- Mycroft for Docker
- Mycroft for Android
- Mycroft Logs
- Mycroft Skills
- Developing Skills for Mycroft
- Introduction to developing Skills for Mycroft
- Automatic testing for Mycroft Skills
- Preparing your Skill for submission to the Mycroft Skills Repo
- Mycroft Skills Kit
- Skills Acceptance Process
- Skill Settings
- Common issues in Skills development
- Repurposing Skills developed for other platforms
- Conversational Context
- Audio Service
- Display Control
- Fallback Skills
- Common Play Framework
- Mycroft Skill Manager
- Message Bus
- Other languages in Mycroft
- Mimic Recording Studio
- Troubleshooting and known errors
- Getting help and support
This is a useful starting point, and provides an overview of all the elements of the Mycroft ecosystem.
Aimed at developers, our Contributing section provides detailed instructions on how to contribute to Mycroft.
Aimed at developers and investors, our Roadmap illustrates our key development effort and goals.
A handy reference of all new terms you might come across while working with Mycroft.
How to download and install Mycroft for your preferred Device or platform.
How to pair your Device with home.mycroft.ai, and set basic configuration fields such as location.
Getting started using Mycroft Skills.
In depth information about the Mark 1 reference hardware Device.
In depth information about the Picroft build of Mycroft for Raspberry Pi.
Learn how to configure your Raspberry Pi 3 to output audio via USB, HDMI and Bluetooth
Are you on an enterprise network? The automated WiFi network connection process not working? Learn how to manually configure WiFi.
Want to turn off automatic updates? Change what time they occur? Learn how to manually configure updates.
In depth information on how to build Mycroft for common Linux distributions.
How to build Mycroft in a Docker container either by building an image or pulling the image off Docker Hub.
In depth information on the Mycroft companion app for Android.
Learn about the
mycroft.conf file and the settings it contains.
Information about which logs Mycroft keeps, where they are located, and useful diagnostic commands.
An overview of the Skills that can be installed on your Mycroft Device.
Learn about the prerequisites of a Skill, and what makes a good Skill.
Take your next step in Developing Skills for Mycroft. Learn about the structure of a Skill, and how to start creating your own.
Learn how to use the Integration Test Runner for automatic testing of your Mycroft Skills.
Read more about the process used by Skill Authors, the Skill Management Team and Mycroft staff to ensure the robustness and quality of Skills in the Mycroft AI ecosystem.
Aimed at developers, this is a step by step guide to submitting a new Skill you’ve developed to the Mycroft Skills Repo.
Learn how to use the Mycroft Skills Kit to make the creation, testing and submission of Skills a lot easier.
Aimed at Developers, this is a step by step guide to storing and retrieving persistent settings that your Skill needs.
Explanations of common issues developers encounter in building new Skills, and helpful advice for overcoming them.
Already develop for another voice assistant? Learn how to transfer those skills to Mycroft.
Want to add more natural interaction to Mycroft? Conversational context allows a Skill to add context to the Intent Parser to create a more natural interaction style.
The Audio Service handles playback of audio files within a Skill. If your Skill deals with audio files, you’ll want to know about the Audio Service.
Display Control manages features of the Enclosure, such as the mouth and eyes on the Mark 1.
Fallback Skills handle an Intent if one can’t be matched with an Utterance and are a useful catch-all. This documentation shows how to write a new Fallback Skill and set its order of precedence.
Learn how to use the
CommonPlaySkill class instead of the regular
MycroftSkill class to develop Skills which use the
Learn how to use
msm to install, search and update Skills. Includes a comprehensive list of
msm error codes, and how to resolve them.
Aimed at advanced Skill Authors, learn how the Mycroft
MessageBus is used to emit and consume messages.
Learn more about languages in Mycroft, and all the components that have to be in place to support additional languages.
Learn more about the Adapt Intent Parser, which matches spoken words with Intents.
Examples of the different types of Intent Parsing supported by Adapt.
A tutorial on writing Intent Parsers using Adapt.
Learn about the Mimic Text to Speech (TTS) tool.
Learn about the Mimic Recording Studio that uses a corpus of phrases to help you make voice recordings that can be used in your own TTS voice.
Precise is a Wake Word Listener that listens and then ‘wakes up’ Mycroft, ready to hear your commands and questions.
Padatious is an Intent parser. Unlike Adapt, which is based on Speech to Text, Padatious is trained on sounds.
Stuck? Learn common tricks and techniques for resolving common errors.
Audio is one of the most common areas that requires troubleshooting.