Skip to content

Latest commit

 

History

History
69 lines (49 loc) · 2.12 KB

README.md

File metadata and controls

69 lines (49 loc) · 2.12 KB

ovos-mac

Run OVOS natively on Mac OS. No containers, no PulseAudio - just pure Python.

Very much a work in progress! This is intended a proof-of-concept, not as comprehensive instructions. For support, please visit Matrix chat or open an issue on this repo.

Tested on an M1 Macbook Air and an M2 Macbook Pro.

Prerequisites

  • Homebrew
  • Python 3.10 or 3.11
  • Poetry
  • fann2 (optional, Padatious intent engine only)

Considerations

  • Padatious does not install very well on an M1-3 Mac. Padacioso will be the default, but note it is quite a bit slower than Padatious. To install Padatious anyway, see the below section.

Steps

Set up a few minimal requirements in ~/.config/mycroft/mycroft.conf:

{
  "play_wav_cmdline": "afplay %1",
  "play_mp3_cmdline": "afplay %1",
  "listener": {
    "microphone": {
      "module": "ovos-microphone-plugin-sounddevice"
    },
    "VAD": {
      "module": "ovos-vad-plugin-silero",
      "ovos-vad-plugin-silero": {
        "threshold": 0.5
      }
    }
  }
}

Then clone this repo, cd into the directory, and run:

# brew install poetry # If you don't have it
poetry install --without padatious # Or just poetry install if you want Padatious
poetry shell
./startup.sh

Installing Padatious

First, build fann from source following the instructions on their repo. Then run:

poetry shell
LIBRARY_PATH=/usr/local/lib poetry install --with padatious

Adding skills

OVOS skills are just Python packages, so you can simply run poetry add my-skill to add a skill to your environment. You can also clone a skill repo and add it to your environment with poetry add /path/to/my-skill. Finally, you can also add a skill from a git repo with poetry add git+https://my-skill/repo.git.

Once the skill is installed, stop your startup.sh script and start it again. Sometimes the skill will load without even restarting!

Known issues

  • Padatious does not install easily on M1-3 Macs
  • Sometimes afplay will clip on Macbook default speakers