Skip to content

Commit be815a7

Browse files
feat: upgrade speaker.bot docs to new content format
1 parent 7cd7ccb commit be815a7

33 files changed

Lines changed: 178 additions & 1206 deletions

speakerbot/0.get-started/0.installation.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,20 @@ Click the button below to download the latest stable version of Speaker.bot.
88

99
You should end up with a regular `.zip` file.
1010

11-
::card-group
12-
::card{icon=i-mdi-download title="Speaker.bot" to=https://streamer.bot/api/releases/twitchspeaker/latest/download target=_blank}
13-
Download the latest stable version of Speaker.bot
14-
::
11+
::card{icon=i-mdi-download title="Speaker.bot" to=https://streamer.bot/api/releases/twitchspeaker/latest/download target=_blank}
12+
Download the latest stable version of Speaker.bot
1513
::
1614

1715
## Extract
1816
Extract the `.zip` archive to your desired location.
1917

20-
::callout{icon=i-mdi-lightbulb color=primary}
18+
::note
2119
Speaker.bot is a **portable** application, no further installation is needed!
2220
::
2321

2422
## Run
2523
Open the directory where you chose to extract the archive and execute `Speaker.bot.exe`!
2624

27-
::callout{icon=i-mdi-check color=green}
25+
::success
2826
Speaker.bot should now be running!
2927
::
Lines changed: 33 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,69 @@
1-
# Account Setup
1+
---
2+
title: Account Setup
3+
description: Configure your third-party accounts in Speaker.bot
4+
---
25

3-
::list{type="info"}
4-
- Navigate to `Settings -> Accounts`
6+
::navigate
7+
Navigate to **Settings > Accounts** in Speaker.bot
58
::
69

710
Here you will find account configuration settings for supported integrations.
811

12+
## Integrations
13+
914
### Twitch
1015

1116
The [Twitch](https://twitch.tv) integration is **required** to perform TTS on any live stream events.
1217

13-
::list{type="success"}
14-
- Login via OAuth
18+
::success
19+
Sign in to your Twitch account via OAuth
1520
::
1621

17-
::list{type="primary"}
18-
- Chat
19-
- Follows, subscriptions, gift bombs, etc.
20-
- Channel Point Rewards
21-
::
22+
| Supported Features |
23+
| ------------------------------------------------- |
24+
| Chat |
25+
| Events (follows, subscriptions, gift bombs, etc.) |
26+
| Channel Point Rewards |
2227

2328
### Streamer.bot
29+
2430
The [Streamer.bot](https://streamer.bot) integration allows you to authenticate with the Streamer.bot website for access to `beta` and `alpha` updates.
2531

26-
::list{type="success"}
27-
- Login via OAuth
32+
::success
33+
Sign in to your Streamer.bot account via OAuth
2834
::
2935

30-
::list{type="primary"}
31-
- Automatic Speaker.bot `beta` updates
32-
- Automatic Speaker.bot `alpha` updates
33-
::
36+
| Supported Features |
37+
| ------------------------------------- |
38+
| Automatic Speaker.bot `beta` updates |
39+
| Automatic Speaker.bot `alpha` updates |
3440

3541
### Streamlabs
3642

3743
The [Streamlabs](https://stremalabs.com) integration allows you to connect with Streamlabs for donation events.
3844

39-
::list{type="warning"}
40-
- Login via token
45+
::warning
46+
The Streamlabs integration requires an API token for authentication rather than OAuth.
4147
::
4248

4349
1. Navigate to the [API Settings](https://streamlabs.com/dashboard#/settings/api-settings) page in Streamlabs dashboard
4450
2. Continue to the `API Tokens` tab
4551
3. Copy your `API Access Token`
4652
4. Paste your token into the `Token` field in Speaker.bot Streamlabs account settings.
4753

48-
::list{type="primary"}
49-
- Donation events
50-
::
54+
| Supported Features |
55+
| ------------------ |
56+
| Donation Events |
5157

5258
### StreamElements
5359

5460
The [StreamElements](https://streamelements.com) integration allows you to connect with StreamElements for tip and merch events.
5561

56-
::list{type="success"}
57-
- Login via OAuth
62+
::success
63+
Sign in to your StreamElements account via OAuth
5864
::
5965

60-
::list{type="primary"}
61-
- Tip events
62-
- Merch events
63-
::
66+
| Supported Features |
67+
| ------------------ |
68+
| Tip Events |
69+
| Merch Events |

speakerbot/0.get-started/2.speech-engines.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,31 @@
1-
# Speech Engine Setup
2-
::list{type="info"}
3-
- Navigate to `Settings -> Speech Engines`
1+
---
2+
title: Speech Engine Setup
3+
description: Configure and enable your speech engines in Speaker.bot
4+
---
5+
6+
::navigate
7+
Navigate to **Settings > Speech Engines** in Speaker.bot
8+
9+
- Here you will be able to configure any of the supported TTS engines in Speaker.bot and view a list of available voices for all engines that have been set up.
410
::
511

6-
Here you will be able to add any of the Engines that Speaker.bot supports, as well as a list of Available Voices for engines that have been added.
712

8-
::callout{color=amber icon=i-mdi-lightbulb}
9-
To **Enable** an engine, click the button `Add`, and pick the desired engine type from the dropdown
13+
::tip
14+
**To enable an engine**, click the `Add` button and pick the desired engine type from the dropdown
1015
::
1116

17+
| Speech Engine | Type | Description |
18+
| -------------- | ---- | ----------- |
19+
| SAPI5 | :badge{label=Free color=success icon=mdi:check} | Microsoft Speech API - Native Windows TTS |
20+
| [Google Cloud](https://cloud.google.com/text-to-speech/) | :badge{label=Paid color=warning icon=mdi:currency-usd} :badge{label="Free Trial" color=info icon=mdi:party-popper} | Cloud-based TTS with WaveNet voices |
21+
| [Azure](https://azure.microsoft.com/en-us/products/cognitive-services/text-to-speech/#overview) | :badge{label=Paid color=warning icon=mdi:currency-usd} :badge{label="Free Tier" color=success icon=mdi:check} | Microsoft's cloud TTS platform |
22+
| [Amazon Polly](https://aws.amazon.com/polly/) | :badge{label=Paid color=warning icon=mdi:currency-usd} :badge{label="Free Tier" color=success icon=mdi:check} | AWS cloud TTS service |
23+
| [Watson](https://www.ibm.com/cloud/watson-text-to-speech) | :badge{label=Paid color=warning icon=mdi:currency-usd} :badge{label="Free Tier" color=success icon=mdi:check} | IBM's cloud TTS platform |
24+
| [UberDuck](https://uberduck.ai) | :badge{label=Paid color=warning icon=mdi:currency-usd} | AI voiceover and TTS platform |
25+
| [TTS Monster](https://tts.monster) | :badge{label=Paid color=warning icon=mdi:currency-usd} :badge{label="Free Tier" color=success icon=mdi:check} | AI-based TTS for streamers |
26+
| [Acapela](https://www.acapela-cloud.com) | :badge{label=Paid color=warning icon=mdi:currency-usd} | Cloud TTS by Acapela Group |
27+
| [CereProc](https://www.cereproc.com/en/products/cloud) | :badge{label=Paid color=warning icon=mdi:currency-usd} | CereVoice Cloud TTS platform |
28+
1229
## SAPI5
1330
::list{type="success"}
1431
- No account required
Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,32 @@
11
---
22
title: Quick Start
3+
description: Get started with Speaker.bot!
34
---
45

5-
# Quick Start Guide
6+
Make sure you've completed installation of Speaker.bot, initial account setup, and speech engine configuration before proceeding with this guide.
67

7-
Make sure you've completed the following:
8+
:read-more{to="/get-started/installation"}
9+
:read-more{to="/get-started/accounts"}
10+
:read-more{to="/get-started/speech-engines"}
811

9-
::list{type=primary}
10-
- [Install Speaker.bot](/get-started/installation)
11-
- [Twitch Account Setup](/get-started/accounts)
12-
- [Speech Engine Setup](/get-started/speech-engines)
13-
::
12+
::steps{level=2}
1413

1514
## Create a Voice Alias
16-
::list{type=info}
17-
- Navigate to `Settings -> Voice Aliases`
15+
::navigate
16+
Navigate to **Settings > Voice Aliases** in Speaker.bot
1817
::
1918

2019
Enter a `Name` for your alias and select your desired output device.
2120

2221
For the purposes of this guide, I recommend leaving the output device set to `Application Default`, which will use your current default audio output device.
2322

24-
::list{type=success}
25-
- `Test Speak` at the bottom of the view should now successfully speak the test message.
23+
::success
24+
`Test Speak` at the bottom of the view should now successfully speak the test message.
2625
::
2726

2827
## Enable Global TTS
29-
::list{type=info}
30-
- Navigate to `Settings -> General`
28+
::navigate
29+
Navigate to **Settings > General** in Speaker.bot
3130
::
3231

3332
1. Ensure the `Enabled` checkbox is checked.
@@ -36,13 +35,13 @@ For the purposes of this guide, I recommend leaving the output device set to `Ap
3635
- Choose the voice alias you created in the previous steps
3736

3837
## Test TTS from Twitch
39-
::list{type=primary}
40-
- Your Speaker.bot instance should now be ready to speak commands from Twitch Chat!
41-
::
38+
**Your Speaker.bot instance should now be ready to speak commands from Twitch chat!**
4239

4340
1. Open Twitch Chat for the account you authenticated with Speaker.bot
44-
2. Enter `!say test` :copy-button{content="!say test"}
41+
2. Enter the command `!say test` :copy-button{content="!say test"}
4542

46-
::list{type=success}
43+
::success
4744
If everything is working, Speaker.bot should have spoken "Test"!
45+
::
46+
4847
::
Lines changed: 29 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
1-
# Chat Commands
2-
3-
Interact with your Speaker.bot instance directly from Twitch chat!
1+
---
2+
title: Chat Commands
3+
description: Interact with your Speaker.bot instance directly from Twitch chat!
4+
navigation.icon: mdi:chat-alert-outline
5+
---
46

57
## Default Commands
68

7-
::list{type=primary}
8-
- The following commands are made available by Speaker.bot automatically
9+
::tip
10+
The following commands are made available by Speaker.bot out of the box!
911
::
1012

1113
Name | Description
@@ -30,28 +32,36 @@ Name | Description
3032
`!tts [about\|aboot]` :copy-button{content="!tts about"} | Sends to chat the information about your TwitchSpeaker instance.
3133

3234
## Custom Commands
33-
34-
::list{type=info}
35-
- Navigate to the `Custom Commands` tab in Speaker.bot
35+
::tip
36+
Custom commands allow you to create your own TTS commands with specific voices and permission settings.
37+
- For example, a `!shoutout` command that uses a loud, energetic voice and is only available to moderators.
3638
::
3739

38-
Custom commands allow you to create TTS chat commands with a specified voice and user permissions configuration.
40+
### Configuration
41+
::navigate
42+
Navigate to the **Custom Commands** tab in Speaker.bot
43+
::
3944

40-
### Add Command
4145
You can create a custom command by filling out the fields detailed below, then clicking the `Add` button.
4246

43-
#### `Command`
44-
Enter the name you want to use for this command.
45-
- Example: `!say`
47+
::field-group
48+
:::field{name="Command" type="Text"}
49+
The text you want to use to trigger this command.
50+
<br>
51+
Example: `!say`
52+
:::
4653

47-
#### `Voice Alias`
54+
:::field{name="Voice Alias" type="Select"}
4855
Select the voice to use with this command.
56+
:::
4957

50-
#### `Permissions`
58+
:::field{name="Permissions" type="Checkbox Group"}
5159
Restrict this command to specific Twitch user roles.
60+
:::
61+
::
5262

53-
### Modify Command
54-
To modify any existing command, select it in the list and change any fields you like.
63+
---
5564

56-
### Delete Command
57-
To delete any existing command, select it in the list and then click the `Delete` button.
65+
::note
66+
To modify or delete an existing command, select it from the list, make your changes, then click `Update` or `Delete`.
67+
::

0 commit comments

Comments
 (0)