From 5ca1076bc4eeb0245a765e8131d89856a360a8bb Mon Sep 17 00:00:00 2001 From: Nolan Darilek Date: Tue, 19 May 2020 10:00:37 -0500 Subject: [PATCH] Add initial README. --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..437d77b --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# Godot TTS + +This addon was primarily developed for the [Godot Accessibility addon](https://github.com/lightsoutgames/godot-accessibility), but should work well in other contexts where a Godot game might require text-to-speech. + +## Supported Platforms + +Text-to-speech is complicated, and some features may not work everywhere. Most optional features have an associated boolean property used to determine if the feature is available. Further, while I do attempt to ensure that this addon works as well as possible on all platforms, there may be bugs, and pull requests are welcome. Known supported platforms include: + +* Windows + * Screen readers via [Tolk](https://github.com/dkager/tolk/) + * Native WinRT +* Linux via [Speech Dispatcher](https://freebsoft.org/speechd) +* HTML 5 +* Android + +## Features + +* Speaking text, with interruption support on most platforms +* Stopping speech in progress +* Getting and setting speech rate in both native synthesizer units and percentages +* Detecting whether a screen reader is active + +## API + +The public-facing API is contained entirely within [TTS.GD](TTS.GD). + +## Download + +Download the [latest release](https://github.com/lightsoutgames/godot-tts/releases). \ No newline at end of file