README.md 1.82 KB
Newer Older
Bart Ribbers's avatar
Bart Ribbers committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
# ![Logo](https://plasma-bigscreen.org/wp-content/uploads/sites/3/2020/03/bigscreen-logo.png)

A big launcher giving you easy access to any installed apps and skills.
Controllable via voice or TV remote.

This project is using various open-source components like Plasma Bigscreen, Mycroft AI and libcec.

### Voice Control

Bigscreen supports Mycroft AI, a free and open-source voice assistant that can be run completely decentralized on your own server.

### Remote control your TV via CEC

CEC (Consumer Electronics Control) is a standard to control devices over HDMI.
Use your normal TV remote control, or a RC with built-in microphone for voice control and optional mouse simulation.

### Voice apps

Download new apps (aka skills) for your Bigscreen or add your own ones for others to enjoy.

## Build Instructions

```
$ git clone https://invent.kde.org/plasma/plasma-bigscreen
$ cd plasma-bigscreen
$ cmake -B build \
      -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release 
$ cmake --build build
# cmake --build build --target install
$ plasmashell --replace -p org.kde.plasma.mycroft.bigscreen
```

<details>
<summary><b>Click here to see dependencies</b></summary>

### KDE Plasma Dependencies

- plasma-nano - https://invent.kde.org/plasma/plasma-nano

### KDE KF5 dependencies

- Activities
- ActivitiesStats
- Plasma
- I18n
- Kirigami2
- Declarative
- KCMUtils
- Notifications
- PlasmaQuick
- KIO
- Wayland
- WindowSystem
- KDEConnect
Aditya Mehra's avatar
Aditya Mehra committed
56
  
Bart Ribbers's avatar
Bart Ribbers committed
57 58 59 60 61 62 63 64 65 66 67 68
### Qt dependencies

- Quick
- Core
- Qml
- DBus
- Network

### Optional dependencies

The following can be installed for extra functionality but are not required to build or run:

Aditya Mehra's avatar
Aditya Mehra committed
69 70 71
- Mycroft-Core (development branch) https://github.com/MycroftAI/Mycroft-Core
- Mycroft-GUI - https://github.com/MycroftAI/Mycroft-GUI
- MycroftSkillInstaller - https://github.com/AIIX/MycroftSkillInstaller
Bart Ribbers's avatar
Bart Ribbers committed
72 73 74

</details>