1
0
mirror of https://github.com/mgerb/go-discord-bot synced 2026-01-09 16:42:48 +00:00

update readme

This commit is contained in:
2017-04-07 23:46:26 -05:00
parent 2811d3cc1e
commit f9247c5417
2 changed files with 21 additions and 10 deletions

View File

@@ -4,13 +4,30 @@ This is a soundboard bot for discord. The back end is in GoLang and the front en
<img src="http://i.imgur.com/jtAyJZ1.png"/>
## Dependencies
## How to use
NOTE: Currently the binaries in the release package only run on linux. Check them out [here](https://github.com/mgerb/go-discord-bot/releases)
- download bot.zip and extract everything
- rename config.template.json to config.json
- add your bot token and preferred upload password (leave as is for no password)
- run the bot with `./bot` (you may need to use sudo if you leave it on port 80)
### NOTE
If you get a permissions error with ffmpeg:
`sudo chmod +x dist/ffmpeg`
Sounds are stored in the `dist/sounds` directory. You may copy files directly to this folder rather than uploading through the site.
## Building from Source
### Dependencies
- Go
- Yarn (or npm - makefile will need to be adjusted)
- make
## How to use
### Compiling
- Make sure dependencies are installed
- `make all`
- Rename the `config.template.json` to `config.json`
@@ -20,13 +37,6 @@ This is a soundboard bot for discord. The back end is in GoLang and the front en
- upload files
- success!
### NOTE
If you get a permissions error with ffmpeg:
`sudo chmod +x dist/ffmpeg`
Sounds are stored in the `dist/sounds` directory. You may copy files directly to this folder rather than uploading through the site.
### Windows
I've only compiled and run this on linux, but it should work on windows with little changes.
An ffmpeg executable is required. The linux executable is included.