search

henrymxu / evebot

E.V.E Bot is a Voice Enabled Discord Bot!
Apache License 2.0
6 stars 1 forks source link
discord discord-js

readme

E.V.E Bot

E.V.E

E.V.E is a voice enabled all in one discord bot. Feel free to host your own instance!

If you are a developer and wish to contribute / customize E.V.E, check out the wiki!

Table of Contents

Features

Usage

  1. Add the bot to your Discord Server
  2. Use the ?help command to see the various command groups
    • Use the ?help command with a command name or group to see the command details (e.g ?help play)
  3. Say one of the provided hotwords to start a voice command (Alexa, Hey Siri, and OK Google)
    • Wait for the chime to start saying your command
    • Don't worry about other people interrupting you

Installation

The installation process for E.V.E is quite long due to all the different services it requires.

These steps are if you wish to run the bot on your local machine (i.e. PC, laptop). E.V.E runs on macOS and Linux (Windows has not been tested).

Pre Installation

  1. Retrieve all the required / desired tokens
  2. Install the following external dependencies
    • ffmpeg
    • lame (pre-installed on macOS)
    • node / npm (node >=12.0.0)
  3. Set up the environment variables and api tokens
    • Set up a json file with the key value pairs
    • An example can be found in example_keys.json
    • Environment variables can be used instead of a json file

Installation from NPM

  1. Install the package (npm install -g evebot)
  2. Start the bot using evebot <path to keys.json> (e.g evebot ~/Documents/keys.json)

Installation From Source

  1. Clone / Download the git repository (git clone git@github.com:henrymxu/evebot.git)
  2. Copy the json file you created above into the evebot directory
    • Rename this file to be keys.json
  3. Inside a terminal, navigate to the newly cloned evebot directory
  4. Install TypeScript (npm install -g typescript) and ts-node (npm install -g ts-node)
  5. Install the dependencies using npm install
  6. Start the bot using npm start

Local Installation with Docker

// TODO

Heroku Deployment

// TODO

Environment Variables

Name Environment Variable Description Required
Bot Environment bot_environment Informs the bot to use either 'development' or 'production' settings. Defaults to development. ✗
Youtube Cookie youtube_cookie Required for the bot to bypass Youtube 429 Errors (Too many requests). ✗

General API Tokens

Name Environment Variable Description Required
Discord Bot Token discord_token Required for the bot to login and communicate with discord. ✓
Youtube Search API Token youtube_api_token Required for the bot to search for song URLs (Hopefully this will be converted to a scraper). ✓
Genius API Token genius_token Required for the bot to find lyrics of songs. ✗
Spotify API Tokens spotify_id Required for the bot to create radio playlists, search albums and playlists. ✗
spotify_secret ✗

Platform API Tokens

Details on how to authenticate and configure each provider can be found in each of their individual sections.

Summary

Name Speech-to-Text Text-to-Speech Cloud Storage
IBM Watson ✓ ✓ ✗
Microsoft Azure ✓ ✓ ✗
Google Cloud ✓ ✓ ✗
Amazon Web Services ✗ ✗ ✓

IBM Watson

Environment Variable Description
watson_token API Key
watson_url URL

Microsoft Azure

Environment Variable Description
microsoft_token KEY
microsoft_location LOCATION (e.g eastus)

Google Cloud

Environment Variable Description
google_keyFileCred Contents of the Google Cloud JSON Credentials File

Amazon Web Services

Environment Variable Description
AWS_REGION AWS Region
AWS_ENDPOINT Endpoint
AWS_ACCESS_KEY_ID Access Key ID
AWS_SECRET_ACCESS_KEY Secret Access Key

Configurations

Troubleshooting

Support

License

This repository is licensed under Apache 2.0. You may host an instance of this bot for non-commercial and personal use free of charge.