speakerbot

KO | EN

gitlite — search

#ios #macos #swift #python #react #hacktoberfest #javascript #cpp #php #testing #docker-compose #spring-boot

★ 52 Open GitHub ↗

A simple Discord music bot written in Go

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![Speakerbot](https://raw.githubusercontent.com/dustinblackman/speakerbot/master/assets/banner.jpg)

[![Build Status](https://travis-ci.org/dustinblackman/speakerbot.svg?branch=master)](https://travis-ci.org/dustinblackman/speakerbot)
[![Go Walker](http://gowalker.org/api/v1/badge)](https://gowalker.org/github.com/dustinblackman/speakerbot)
[![Go Report Card](http://goreportcard.com/badge/dustinblackman/speakerbot)](http://goreportcard.com/report/dustinblackman/speakerbot)
[![ImageLayers](https://badge.imagelayers.io/dustinblackman/speakerbot:latest.svg)](https://imagelayers.io/?images=dustinblackman/speakerbot:latest 'Get your own badge on imagelayers.io')

Speakerbot is a multiserver music bot for Discord written in Go. Supports Youtube links and querying Youtube, as well as on the fly converting resulting in instant playback (no wait times between songs!).

## Commands

- `!play` - Queues/Plays Youtube link, or searches Youtube and picks the first result
- `!skip` - Skips current track
- `!stop` - Stops playing and clears queue
- `!help` - Sends a message in text channel with the above commands

## Installation

Speakerbot requires both [`ffmpeg`](https://ffmpeg.org/download.html) and [`opus-tools`](https://www.opus-codec.org/downloads/) to be installed locally and available in PATH. Currently tested with Go 1.6 on OSX.

```bash
go get github.com/dustinblackman/speakerbot
make
```

A configuration file is available to plugin your Discord email and password, as well as a [Google API key](https://developers.google.com/youtube/v3/getting-started) that can search Youtube. You can either rename the `config.example.json` to `config.json`, or copy/paste the following.

```json
{
  "email": "",
  "password": "",
  "googleKey": ""
}
```

Lastly, start Speakerbot

```bash
./speakerbot
```

## Docker

An automated docker build is available [here](https://hub.docker.com/r/dustinblackman/speakerbot/). You can boot it up with `docker-compose` like so as an example.

```yaml
speakerbot:
  image: dustinblackman/speakerbot
  environment:
    EMAIL:
    PASSWORD:
    GOOGLEKEY:
```

## Contribute/Development

If you wish to contribute and add features to Speakerbot, feel free! This app was just a practice app to begin learning Go, so there won't be very much (or any at all) future development from myself. For a more full and feature packed bot, check out [Gravebot](https://github.com/Gravebot/Gravebot).

Make sure to run `make test` before submitting a PR.

## [License](LICENSE)

MIT

speakerbot

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README