projects/godot-tts
1
0
Fork 0
mirror of https://github.com/lightsoutgames/godot-tts synced 2024-11-25 15:05:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

README polish.

Browse Source
This commit is contained in:
Nolan Darilek 2020-09-02 12:26:28 -05:00
parent 30eacee6ff
commit 00aadde492
1 changed files with 23 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -7,11 +7,13 @@ This addon was primarily developed for the [Godot Accessibility addon](https://g
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: 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 * Windows
* Screen readers via [Tolk](https://github.com/dkager/tolk/) * Screen readers/SAPI via Tolk
* Native WinRT * WinRT
* Linux via [Speech Dispatcher](https://freebsoft.org/speechd) * Linux via [Speech Dispatcher](https://freebsoft.org/speechd)
* HTML 5 * MacOS
* Android * AppKit on MacOS 10.13 and below
* AVFoundation on MacOS 10.14 and above, and iOS
* Web
## Features ## Features
@ -31,6 +33,23 @@ The public-facing API is contained entirely within [TTS.GD](https://github.com/l
Download the [latest release](https://github.com/lightsoutgames/godot-tts/releases). Download the [latest release](https://github.com/lightsoutgames/godot-tts/releases).
## Notes on Android
Usage on Android is a bit more complicated:
* Set up a [custom Android build](https://docs.godotengine.org/en/latest/getting_started/workflow/export/android_custom_build.html).
* Create a directory reachable at _res://android/plugins_ and place the _godot-tts.aar_ and _.godot-tts.gdap_ files from a release into that directory.
* Update _res://android/build/build.gradle_ to specify a `minSdkVersion` of at least 21:
```
defaultConfig {
minSdkVersion 21
targetSdkVersion 29
versionCode pluginVersionCode
versionName pluginVersionName
}
```
## Notes on Universal Windows Platform ## Notes on Universal Windows Platform
Godot's UWP export is [currently broken](https://github.com/godotengine/godot/issues/30558). In order to use this addon in a UWP game, do the following: Godot's UWP export is [currently broken](https://github.com/godotengine/godot/issues/30558). In order to use this addon in a UWP game, do the following: