You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 2.0KB

4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
123456789101112131415161718192021222324
  1. # ![icon](https://u.teknik.io/znQBF.png) BansheeBot [![CodeFactor](https://www.codefactor.io/repository/github/calexil/bansheebot/badge)](https://www.codefactor.io/repository/github/calexil/bansheebot) [![icon](https://img.shields.io/badge/Heroku-Deployed-8460aa.svg)](https://bansheebot.herokuapp.com/) [![Build Status](https://travis-ci.org/calexil/BansheeBot.svg?branch=master)](https://travis-ci.org/calexil/BansheeBot) [![Maintainability](https://api.codeclimate.com/v1/badges/5cea1da12f8d344b472f/maintainability)](https://codeclimate.com/github/calexil/BansheeBot/maintainability) [![GitHub issues](https://img.shields.io/github/issues/calexil/BansheeBot.svg)](https://github.com/calexil/BansheeBot/issues)
  2. ## Intro
  3. A simple bot that reads the song info from the currently playing track in banshee media player and displays it in a Discord channel. Also includes some silly commands.
  4. ## Installation
  5. * 1: Clone the repo" `git clone https://github.com/calexil/BansheeBot.git` or fork it.
  6. * 2: Make a new app with the [discord developer dashboard](https://discordapp.com/developers/applications/me) and note your client secret.
  7. * 3: Link your free heroku account to github and deploy your fork or clone
  8. * 4: Edit the file [bot.js at line 43](https://github.com/calexil/BansheeBot/blob/master/bot.js#L43) to match your music channels Id, then [edit the file at line 60](https://github.com/calexil/BansheeBot/blob/master/bot.js#L60) so it matches your heroku app page.
  9. * 5: Make sure the [bansheecheck.sh script](https://github.com/calexil/BansheeBot/blob/master/bansheecheck.sh) is set it to run at your systems startup with `bash bansheecheck.sh` be sure to edit it to match your username and heroku app page endpoint
  10. * 6: Check out the [Command list here](https://github.com/calexil/BansheeBot/blob/master/Commands.md)
  11. * 7: Play music through Banshee media player and watch it go.
  12. ## Bug Reporting
  13. ### [Submit Issues here](https://github.com/calexil/BansheeBot/issues/new)
  14. ## Credits
  15. * [Calexil](https://github.com/calexil)
  16. * [TimboKZ](https://github.com/TimboKZ)