DiscordEarsBot

A speech-to-text bot for Discord written in NodeJS. Can be useful for hearing impaired and deaf people.

Demo:

Try the bot for yourself on our Discord server: https://discord.gg/ApdTMG9

You can follow the steps below to get this bot up and running.

Heroku (optional)

If you don't have a linux server/machine then you can use Heroku for hosting your bot 24/7 and it's free. I wrote an easy step-by-step guide here.

Docker (optional)

If you prefer using Docker instead of manually installing it:

1. Save the Dockerfile
2. Create a file settings.json and configure it (see Settings part)
3. run docker build -t discordearsbot . this may take a minute or two.
4. run docker run -it discordearsbot
5. skip to Usage part.

Linux Installation

You need nodeJS version 12+ with npm on your machine.

sudo apt-get install -y sox screen
git clone https://github.com/healzer/DiscordEarsBot.git
cd DiscordEarsBot
npm install

Windows Installation

Tutorial: https://www.youtube.com/watch?v=uD_Neq9DYn0

You need nodeJS version 12+ with npm on your machine.

Download and install the latest version of "sox" for Windows: https://sourceforge.net/projects/sox/files/sox/

You may need to manually add sox to your environment variables, here's a tutorial: https://stackoverflow.com/questions/17667491/how-to-use-sox-in-windows

Using shell or command prompt execute the following:

git clone https://github.com/healzer/DiscordEarsBot.git
cd DiscordEarsBot
npm install

Settings

Create a (free) discord bot and obtain the API credentials (Bot Token). Here's an easy tutorial: https://www.writebots.com/discord-bot-token/ Note: Give your bot enough permissions or simply grant it Administrator rights.

Create a (free) WitAI account and obtain the API credentials (Server Access Token): https://wit.ai/

Rename the file settings-sample.json to settings.json and enter the obtained API credentials:

{
    "discord_token": "your_token",
    "wit_ai_token": "your_token"
}

Running

Execute the following in your shell or prompt:

node index.js

Linux users can start background process as such:

./restart.sh     # this (re)starts a new background screen session of the bot, closing your terminal will keep the process running.

./close.sh       # this closes the background screen session.

Usage

By now you have a discord server, the DiscordEarsBot is running and is a part of your server. Make sure your server has a text and voice channel.

1. Enter one of your voice channels.
2. In one of your text channels type: *join, the bot will join the voice channel.
3. Everything said within that channel will be transcribed into text (as long as the bot is within the voice channel).
4. Type *leave to make the bot leave the voice channel.
5. Type *help for a list of commands.

notes:

• When the bot is inside a voice channel it listens to all speech and transcribes audio into text.
• Each user is a separate audio channel, the bot hears everyone separately.
• Only when your user picture turns green in the voice channel will the bot receive your audio.
• A long pause interrupts the audio input.
• (WitAI only) The duration of a single audio input is limited to 20 seconds, longer audio is not transcribed.

Language

WitAI supports over 120 languages (https://wit.ai/faq), however only one language can be used at a time. If you're not speaking English on Discord, then change your default language on your witAI account:

For developers

Using Mozilla DeepSpeech for speech recognition, tutorial.

Speech-To-Text

By default WitAI's free API is used for voice recognition / transcription. But you can easily integrate any other API into the bot. You can use Google's Speech-to-Text API as follows:

1. Open index.js, inside the function transcribe(file) make sure that transcribe_gspeech is being used and the other one(s) are disabled.
2. You may want to adjust the languageCode value if you're speaking a non-English language.
3. Enable Google Speech API here: https://console.cloud.google.com/apis/library/speech.googleapis.com
4. Create a new Service Account (or use your existing one): https://console.cloud.google.com/apis/credentials
5. Create a new Service Account Key (or use existing) and download the json file.
6. Put the json file inside your bot directory and rename it to gspeech_key.json.

Contact

For enquiries or issues get in touch with me:

Name: Ilya Nevolin

Email: [email protected]

Discord: https://discord.gg/ApdTMG9