/mycroft-electro

Mycroft AI Desktop UI
  1. JavaScript 91.1%
  2. HTML 4.3%
  3. CSS 2.5%
  4. Shell 2.1%
JavaScript HTML CSS Shell
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Open in Desktop Download ZIP
Find file
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
source
.babelrc
.gitignore
.gitmodules
LICENSE
README.md
package.json
webpack.config.js

README.md

A Mycroft UI for Desktop and Magic Mirrors

A UI for Mycroft designed for a magic mirror also with a desktop mode

modular using reactjs and can handle plugins

#####*note* before starting copy config.json.example to $HOME/.mycroft-electro/config.json and edit to include your path to this clone and your mycroft-core folder

to run npm install && npm start

  1. Have a working install of mycroft (https://github.com/MycroftAI/mycroft-core)

  2. Have a working install of nodejs/npm (https://nodejs.org)

  3. Clone this repo $ git clone https://github.com/joshymcd/mycroft-electro.git

  4. edit config.json in mycroft-magic-mirror folder with two paths to mycroft-core and this mycroft-magic-mirror (i will streamline this part); NOTE See below under 'config' section

  5. in terminal $ cd mycroft-electro

    (pull in modules (git submodules) )

    $ git submodule update --init --recursive

    $ npm install

Start-up scripts

There are a couple of ways to start up the UI

Mode

  1. Desktop Mode - shows a desktop friendly UI in a borderless window which can be resized and dragged around
  2. Mirror Mode - A fullscreen black and white UI designed for use in magic mirror like projects

Startup type

  1. Manual - you manually have to select to start each Mycroft service and then connect (hint click on the 'Mycroft Inside' text to show the admin menu)
  2. Auto - Automagically starts up Mycroft and connects Note: Not yet implemented!

Start Commands

####Basic

  1. npm start This runs the UI in Desktop & Manual Mode
  2. npm test This runs the UI in Desktop & Manual Mode with the main menu/toolbar avalible (so you can access chrome developer options and the console)
  3. npm run start-desktop This runs the UI in Desktop & Manual Mode
  4. npm run start-mirror This runs the UI in Mirror & Auto Mode

####Other Startup Modes

  1. npm run start-desktop-auto
  2. npm run start-desktop-manual
  3. npm run start-mirror-auto
  4. npm run start-mirror-manual

Configurations

Configurations are held in a .json file under source/baseconfig.json. this contains the default settings.

Any properties placed in source/config.json will override baseconfig.json. this file is ignored by git so should persist between pulls.