Skip to content

Commit b337f0e

Browse files
committed
Updated README
1 parent 4c7ec6c commit b337f0e

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

README.md

+15-13
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
1-
# OBS Control Script for Firebot
1+
# Google Cloud Text-to-Speech Script for Firebot
22

3-
## How to use
4-
1. Install the [OBS Websocket plugin](https://github.com/Palakis/obs-websocket/releases) for OBS
5-
2. Download the latest **obsControl.js** file from [Releases](https://github.com/ebiggz/firebot-script-obs-control/releases)
6-
3. Add the **obsControl.js** as a startup script in Firebot (Settings > Advanced > Startup Scripts)
7-
4. Restart Firebot and enjoy!
3+
## Overview
4+
Use Google Cloud's Text-to-Speech service in Firebot to have incredible TTS quality on stream! Choose from any English (US/UK/AU/IN) WaveNet voice. With controls for Pitch and Speech Rate, you can tailor the voice to whatever you need.
5+
6+
Looking to recreate the voice of A.D.A (Artificial Directory and Assistant) from Satisfactory? Choose `en-US-Wavenet-C` and adjust the Pitch to `-0.5` and Speed to `0.9`.
7+
8+
## Prerequisites
9+
You must have a Google Cloud Account, and a [Google Cloud API Key](https://cloud.google.com/docs/authentication/api-keys#creating_an_api_key) to use this script. Technically this is a paid service, however, each month Google will give you 1,000,000 free characters of TTS. If you exceed that, they charge USD $16 for every additional bucket of 1,000,000 characters.
810

9-
## Developers
10-
### Setup
11-
1. Clone or fork repo
12-
2. `npm install`
11+
The API Key may look something like: `AITEwL55bWmT-zZeuiWF8o9EpruWtue7QUhMy05`
1312

14-
### Building
15-
1. `npm run build`
16-
2. Copy the `.js` file in `/dist` to Firebot's `scripts` folder
13+
Make sure you have your API Key handy, as you'll need it once you install the Script in Firebot.
14+
15+
## How to use
16+
1. Download the latest **googleCloudTts.js** file from [Releases](https://github.com/heyaapl/firebot-script-google-cloud-tts/releases)
17+
2. Add the **googleCloudTts.js** as a startup script in Firebot (Settings > Advanced > Startup Scripts) and enter your Google Cloud API Key
18+
3. Restart Firebot and enjoy! You'll see a new Effect called **Google Cloud Text-to-Speech**!

0 commit comments

Comments
 (0)