Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
sKiLdUsT committed Nov 7, 2017
0 parents commit d35c7b8
Show file tree
Hide file tree
Showing 13 changed files with 1,532 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
node_modules/
config.json
111 changes: 111 additions & 0 deletions COMMANDS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
# Command Help

### help
*Available to all permissions*
Shows this help message
**Example**
```
/help
```
---
### ping
*Available to all permissions*
Pong!
**Example**
```
/ping
```
---
### grant (userId, permission)
*Available to permission "admin" only*
Grant someone a specific permission of either
- *moderator*
- *admin*

**Example**
```
/grant 122143660027412480 admin
```
---
### revoke (userId, permission)
*Available to permission "admin" only*
Revoke someone's permissions
**Example**
```
/revoke 122143660027412480
```
---
### set (key, value)
*Available to permission "admin" only*
Assign a specific value to a key, which may be one of the following:
- *voiceChannel* - Set the default voice channel to connect to
- *onlyListenIn* - Set the channel to accept commands from exclusively

**Example**
```
/set voiceChannel 369768568931221508
/set onlyListenIn 369768568931221506
```
---
### play (subject)
*Available to all permissions*
Play something according to the subject of either
- *YouTube Link*
- *Soundcloud Link*
- *Generic search term to be lookup up on YouTube*

**Example**
```
/play https://www.youtube.com/watch?v=DLzxrzFCyOs
/play https://soundcloud.com/rick-astley-official/never-gonna-give-you-up
/play never gonna give you up
```
---
### pause
*Available to all permissions*
Pause playback of current song
**Example**
```
/pause
```
---
### resume
*Available to all permissions*
Resume playback of current song
**Example**
```
/resume
```
---
### skip
*Available to all permissions, requires vote under permission "moderator"*
Skip playback of current song
**Example**
```
/skip
```
---
### clear
*Available to all permissions, requires vote under permission "moderator"*
Clear the playlist
**Example**
```
/clear
```
---
### vol
*Available to all permissions*
Sets current playback volume, defaults to 20. Limited to **100**
**Example**
```
/vol 30
```
---
### queue
*Available to all permissions*
Shows current playlist.
**Example**
```
/queue
```
---
29 changes: 29 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
BSD 3-Clause License

Copyright (c) 2017, sKiLdUsT
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

* Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# awesomebot

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg?style=flat-square)](https://standardjs.com)

Simple and fast Discord music bot using [discord.js](https://discord.js.org)

### How to use

- clone this repository
- run `npm install`
- copy `config.example.json` to `config.json` and fill it in

And you're done! Use `node app` to run the bot. See [COMMANDS.md](/COMMANDS.md) for command usage help.

### License

BSD 3-Clause License
Loading

0 comments on commit d35c7b8

Please sign in to comment.