https://github.com/fewieden/MMM-TTS

Text-To-Speech Module for MagicMirror²
https://github.com/fewieden/MMM-TTS

festival magicmirror offline text-to-speech text2speech

Last synced: 3 months ago
JSON representation

Text-To-Speech Module for MagicMirror²

• Host: GitHub
• URL: https://github.com/fewieden/MMM-TTS
• Owner: fewieden
• License: mit
• Created: 2016-08-15T11:59:26.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2023-12-20T17:17:14.000Z (11 months ago)
• Last Synced: 2024-06-29T10:32:52.039Z (5 months ago)
• Topics: festival, magicmirror, offline, text-to-speech, text2speech
• Language: JavaScript
• Homepage:
• Size: 5.86 KB
• Stars: 18
• Watchers: 6
• Forks: 11
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-mmm - **MMM-TTS**

README

        
# MMM-TTS [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://raw.githubusercontent.com/fewieden/MMM-TTS/master/LICENSE) [![Build Status](https://travis-ci.org/fewieden/MMM-TTS.svg?branch=master)](https://travis-ci.org/fewieden/MMM-TTS) [![Code Climate](https://codeclimate.com/github/fewieden/MMM-TTS/badges/gpa.svg?style=flat)](https://codeclimate.com/github/fewieden/MMM-TTS) [![Known Vulnerabilities](https://snyk.io/test/github/fewieden/mmm-tts/badge.svg)](https://snyk.io/test/github/fewieden/mmm-tts)

Text-To-Speech Module for MagicMirror2

## Dependencies

* An installation of [MagicMirror2](https://github.com/MichMich/MagicMirror)

* npm

* [say](https://www.npmjs.com/package/say)

* [festival](http://www.cstr.ed.ac.uk/projects/festival/)

## Installation

1. Clone this repo into `~/MagicMirror/modules` directory.

1. Configure your `~/MagicMirror/config/config.js`:

    ```

    {

        module: 'MMM-TTS',

        position: 'top_right',

        config: {

            ...

        }

    }

    ```

1. Run command `npm install` in `~/MagicMirror/modules/MMM-TTS` directory.

1. Run command `sudo apt-get install festival`.

## Config Options

| **Option** | **Default** | **Description** |

| --- | --- | --- |

| `debug` | `false` | Display text to speech. |

| `text` | `'MMM-TTS'` | Text to display in debug mode, while there's no text to speech. |

| `voice` | `null` | If you want another voice than default you have to install it seperately and then fill in the voice name here. http://www.festvox.org/docs/manual-2.4.0/festival_24.html#Voices |

| `speed` | `1.0` | How fast the speech should be. |

## For Developers

To use MMM-TTS in your module you have to send a socket notification like this `this.sendNotification('MMM-TTS', 'This is a text to read. Hello World!');`.