/Sound

Soundbot - plug.dj

Primary LanguageJavaScriptMIT LicenseMIT

Soundbot - Plug.dj

###Rationale

Many features are inspired by the great tastybot. All hail. :octocat:

Soundbot is written in Javascript to take advantage of plug.dj's API. There are bugs and if you would like to help squash them, please make an issue if you encounter, and try to include the following:

  1. Short, detailed description
  2. Console error (Press F12 -> console tab, it should say on the right [bot.js]. On the left is the error.)
  3. Line number (this may not be always available)

If you are new to Javascript, and would like to contribute, here is a link to a pretty good website that helps with the basics.. Run through it. I've found that "coding to learn is better than learning to code".

For more advanced stuff and syntax highlighting, go here to look at some documentation.

###This was designed to be run on FireFox If you can help with some compatibilty with chrome, that'd be great.

####Uniform

This is meant for a guideline on how the code is easier to read and evaluate.

Refer here for the guidelines.

========

###Install Locally

To edit with ease, install this repository locally.

git clone https://github.com/FourBitus/Sound.git Soundbot

========

###Commands

Here is a list of commands.

Note: The list above isn't updated much. If you want a list of all the commands, type !commands [staff/manager/host/no input] to get a list.

=========

###Plug.dj API Documentation

Here is a link to it. You might have to signup.

==========

###Open Source License

The MIT License (MIT)

Copyright (c) 2014 FourBit

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.