vicgc / AwesomeTTS

Text-to-speech add-on for Anki

AwesomeTTS

AwesomeTTS brings text-to-speech support to Anki, including Ekho, eSpeak, Festival, Google Translate, the OS X Speech Synthesis Manager, the Microsoft Speech API, and Yandex.Translate.

More information about the add-on and how to use it can be found on its AnkiWeb add-on page.

AwesomeTTS is free and open source software, released under version 3 of the GNU General Public License.

Installation

There are a few different ways one can install this add-on.

Stable Package

The AnkiWeb add-on page has the latest stable branch of the add-on, which can be installed directly within the Anki user interface using add-on code 301952613.

Development and Other Versions

The develop branch, hotfixes and previews, and specific releases can be downloaded from GitHub or pulled in and installed with git and a script.

• Manually from GitHub: Choose the specific branch or tagged release you want, and download the zip or tarball. Extract AwesomeTTS.py and the awesometts/ subdirectory into the base of your Anki addons directory.

• Straight Install: Copy the files into your Anki addons directory using the install.sh helper, removing any other installation of AwesomeTTS. If you have an existing configuration file, it will be saved, but your cache will be cleared.

    $ git clone https://github.com/AwesomeTTS/AwesomeTTS.git
    $ cd AwesomeTTS
    $ git checkout [ref]  (if not using "develop", e.g. pre/v1.0-beta11)
    $ tools/install.sh [addons directory]  (e.g. ~/Anki/addons)
  

• Using Symlinks for Development: Symlink the files into your Anki addons directory using the symlink.sh helper, removing any other installation of AwesomeTTS. If you have an existing configuration file, it will be saved, but your cache will be cleared unless your new symlink happens to have a cache directory.

    $ git clone https://github.com/AwesomeTTS/AwesomeTTS.git
    $ cd AwesomeTTS
    $ git checkout [ref]  (if not using "develop", e.g. pre/v1.0-beta11)
    $ tools/symlink.sh [addons directory]  (e.g. ~/Anki/addons)
  

• Package into a Zip File: Package the files into a zip archive for installation somewhere else using the package.sh helper. This is also how the package is built for AnkiWeb.

    $ git clone https://github.com/AwesomeTTS/AwesomeTTS.git
    $ cd AwesomeTTS
    $ git checkout [ref]  (if not using "develop", e.g. pre/v1.0-beta11)
    $ tools/package.sh [zip target]  (e.g. ~/AwesomeTTS.zip)