Mycroft Skills Repo

Content

Welcome

Welcome

A repository for sharing and collaboration for third-party Mycroft skills development. This is a place to publish complete Skills and learn Skill writing as well as share best practices.

You can visit the new HTML version of this document at https://mycroftai.github.io/mycroft-skills/

Default Skills and Triggering Them

Skill Name	Description "handled phrases"
AIML Fallback	AIML skill by JarbasAI
Alarm	Alarm
Audio Record	Record and Play Audio `"record"`
Configuration	Update Mycroft configuration `"configuration update"`
Date Time	Tell the date or time `"what time is it"`
Desktop Launcher	Open Applications on Desktop `"open firefox"`
DuckDuckGo	Query DuckDuckGo for general questions `"what is frankenstein"`
Hello World	Hello world and Mycroft manners `"how are you"`
IP	Check the device's IP Address `"what is your ip address"`
Joke	Tell jokes `"tell me a joke"`
Installer	Install skills `"install daily meditation"` `"uninstall skill"`
Mark-1 Demo	Demonstration of Mark 1
Media	Multimedia Control `"play", "pause", "next track"`
Naptime	Put Mycroft to sleep `"go to sleep"`
NPR News	Listen to the news from NPR `"news"` `"stop news"`
Pairing	Pair Mycroft with home.mycroft.ai `"pair my device"`
Personal	Learn about Mycroft `"what are you"`
Playback Control	Control audio subsystem `"play"`
Reminder	Reminders to do something `"remind me to turn off the oven in 5 minutes"`
Speak	Repeat anything `"say open source AI"`
Singing	Sing some Songs `"sing a song"`
Stock	Stock prices `"stock price of google"`
Stop	Stop running skills `"stop"`
Unknown Fallback	When Mycroft doesn't know an answer `"green jelly wood"`
Version Checker	Find the version of mycroft-core `"check version"`
Volume	Increases or Decreases/Mutes Volume `"reduce volume"`
Weather	Current Weather and Forecasts `"what is the weather"`
Wiki	Wikipedia queries `"tell me about AI"`
Platform Patch	Patching for official platforms `"platform patch"`

How to Add Skills to the Repo!

Step 1 Make a Repo

If you want to submit a skill, simply make a repo for it organized
as the template above. How To Make a Repo

Example Skill Template

Step 2 Clone Repo

Clone the mycroft-skills repo to a local directory, How To Clone if you are unfamiliar with the process.

Step 3 Generate Readme

To get the skill added, generate the Readme file using the Meta Editor You will fill out all the relative fields and it will give you the Markdown to put into your README.md file.

Step 4 Add Submodule

Next we need to add the submodule for your skill. For more help, feel free to check out this guide

Or, type the following in the terminal of your clone of the Skills-repo.

git submodule add $remote $name-your-skill

Where $remote is the git address for your repo (example https://github.com/mycroftai/skill-configuration) and $name-your-skill is what you want to name it. In general, we normally use BLANK-skill as a format for skill names.

This should have edited the .gitmodule file and added something similar to the bottom of the file:

+[submodule "NAME OF YOUR SKILL"]
 +	path = name-of-your-skill-skill
 +	url = URL.FOR.YOUR.SKILL.git

Step 5 Modify Skills Repo README.md

Modify the table section to include the direct link to your repo like the following example including the break tag and the phrase to trigger your skill:

| :heavy_check_mark:  | [home-assistant](https://github.com/btotharye/mycroft-homeassistant#readme)| Control your devices in home-assistant<br>```turn on office```

Ensure to put a proper status as well from the list below:

Status meaning:
✔️ good working order
🚧 still being developed and not ready for general use (for reference/collaboration)
❓ untested (by us)
💀 Broken, but good for ideas!

Step 6 Submit PR (Pull Request)

Once you've got your repo organized properly, submit the PR consisting of the following:

Ensure you use Meta Editor to create your standardized README.md file
The URL of your repo
A short name for the skill
A one sentence description of what it does
The development status of the skill (under construction or working)

MSM Compliance

To make your skill capable of being installed via MSM (the Mycroft Skill Manager) you need two additional files.

requirements.txt
requirements.sh requirements.txt is a list of all pip libraries your skill needs (if any). requirements.sh is a shell script that executes and installs package dependancies your skill needs (if any). So, if you need a specific pip library installed, like gensim, you can have it automatically installed in the correct vm using msm. This requirements.txt file would look like this:

gensim

That's it!