Just say what's in your squanch and people will understand ~Rick Sanchez C-137
This is a bot for discord written in javascript for the Node.js platform. It was created for the use of a small personal server. Its main functionality is playing user defined audio clips in voice chat, but it also has a few other functions.
By convention, most discord bots run as a single public entity that can be invited to servers. However, because this bot accepts file uploads from users and can end up storing quite a bit of data, I decided to not do that. If you would like to add this bot to your server you will need to generate a discord API key and run / host it for yourself.
- User-created audio commands
- Searchable tags for audio commands
- Stop audio control
- "Look at this photograph" meme generation
- WolframAlpha queries
- Urban Dictionary lookups
Table of Contents
- Hosting the bot
- Running the bot
- Usage
- WolframAlpha Integration
You will need to either download the source code from the gihtub repo, or use git to clone the project directly. You will also need Node.js to run the project.
Software:
- git
- Node.js (version 4.0 or above)
- npm (comes with node)
Accounts:
- Discord
- WolframAlpha (optional)
Either download the source code, or use git to clone the repo.
$> git clone https://github.com/muiro/squanchbot.git
Open the squanchbot directory and use npm to install all dependencies.
$> cd squanchbot
$> npm install
The bot is now installed and ready to be configured with your discord developer API token.
First you will need to acquire a bot API token, then add that token to squanchbot's configuration file.
- Log in to your discord account and go to the Developers page
- Open the My Applications link
- Click on New Application
- Fill in all required fields here. Add an icon if you want. When done press Create Application
- Click Create a Bot User, then confirm the warning
- Take note of the Client/Application ID and Token as you will need these for config
Open config/default.json in your favorite text editor. Enter your Token like so:
{
"bot": {
"token": "MSsoesuffstMSNenuf08guau-oeu88hsoeu_fe8HDed"
}
}
All of the required configuration is done, you can now run the bot
Run the bot by issuing the following command in the squanchbot directory:
$> npm start
A discord bot is added to a server by visiting a URL on your browser. Make sure you are first logged in and that you have permission to invite users to your server.
This is the URL you will need to visit. Replace the ******************* with your Client/Application ID created above.
https://discordapp.com/oauth2/authorize?client_id=*******************&scope=bot&permissions=66321471
Choose the server you want the bot to be added to (you can only add bots to servers you can invite users to), disable any permissions you don't think the bot should have, then click Authorize.
Note: This bot only uses edit message permissions, so everything else is unecessary. Functionality that uses these permissions may be added in the future.
Squnachbot listens for a number of commands in the server's text channel, each of which begin with the ! character. There are a number of built-in commands, and more commands can be added by you and your users. There are also a few commands which squanchbot can receive through a PM.
Lists all known tags and their usage count.
Displays a list of all commands, including user-added audio commands. Message dissapears after 10 seconds to avoid channel clutter.
Takes the URL of an image and processes that image inside the "look at this photograph" meme.
Example: !photograph http://website.com/funnypic.jpg
Responds with a rude "pong" type message.
Plays a random audio command. If given a tag, plays a random command which is tagged.
If it exists...
Stops all currently playing audio.
Lists the top 25 used tags.
Searches for commands with the given tag.
Looks up a word on Urban Dictionary and returns the first result
Queries WolframAlpha and displays all results. Simply type your query after !wolfram.
Example: !wolfram poisson distribution
These commands will only work in a PM with the bot. This is intended to keep administration of audio commands out of the main channel. This reduces chat clutter and also helps users surprise other users with new audio.
All of the PM commands can be sent to the bot with our without the proceeding '!'. For example, 'delete airhorn' is equivalent to '!delete airhorn'.
Displays the raw file and tag data for a given audio command.
Displays a list of all commands, including user-added audio commands.
When given the name of an audio command (without the !), this archives the file and removes it from the list of playable audio commands.
When given the name of an audio command (without the !), this sends the user the file requested.
Adds the specified tag to the command. Tags must be added one at a time and can contain spaces. Everything after the command name will be treated as the tag.
Displays all the tags for the supplied audio command. Tags are added to audio commands to help search and administer the list.
Removes the specified tag from the command. Tags must be removed one at a time and may contain spaces. Everything after the command name will be treated as the tag.
Users can create new audio commands by PMing audio files to the bot. These will then become available to all users and will cause squanchbot to connect to the requesting user's voice channel and play the file on command.
When uploading the file to the bot, initial tags for the audio can be included by typing them into the comment box. If more than one tag is desired, sepparate them with a comma.
The new command name will be a lowercased version of the file name without the extension. Thus, if the user uploads a file called 'YeAAaHhHh.ogg' the new command will be '!yeaaahhhh'. Additionally, spaces are replaced with underscores to help avoid cross platform filesystem issues.
To utilize the wolfram alpha integration, you will need to apply to their API program here: WolframAlpha API. This is free for personal use.
Once you have signed up and have your API key, edit config/default.json, add your key, and also set "enabeld" to true. The bot will need to be restarted for this to take effect.