Skip to content
This repository has been archived by the owner on Aug 21, 2024. It is now read-only.

Commit

Permalink
Merge with master
Browse files Browse the repository at this point in the history
  • Loading branch information
kuff committed May 30, 2020
2 parents 6ec1e9c + dca75d3 commit 7f37c9d
Show file tree
Hide file tree
Showing 4 changed files with 602 additions and 437 deletions.
125 changes: 124 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,127 @@
.vscode
.idea
node_modules/
config.json
config.json


# Created by https://www.gitignore.io/api/node,visualstudiocode
# Edit at https://www.gitignore.io/?templates=node,visualstudiocode

### Node ###
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage
*.lcov

# nyc test coverage
.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# TypeScript v1 declaration files
typings/

# TypeScript cache
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variables file
.env
.env.test

# parcel-bundler cache (https://parceljs.org/)
.cache

# next.js build output
.next

# nuxt.js build output
.nuxt

# rollup.js default build output
dist/

# Uncomment the public line if your project uses Gatsby
# https://nextjs.org/blog/next-9-1#public-directory-support
# https://create-react-app.dev/docs/using-the-public-folder/#docsNav
# public

# Storybook build outputs
.out
.storybook-out

# vuepress build output
.vuepress/dist

# Serverless directories
.serverless/

# FuseBox cache
.fusebox/

# DynamoDB Local files
.dynamodb/

# Temporary folders
tmp/
temp/

### VisualStudioCode ###
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json

### VisualStudioCode Patch ###
# Ignore all local history of files
.history

# End of https://www.gitignore.io/api/node,visualstudiocode
2 changes: 2 additions & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
save=true
save-exact=true
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# discordify
*A single-server focused music bot for Discord.* See the [help command](https://github.com/kuff/discordify/blob/master/FEATURES.jpg) for a list of all available commands or watch the [video](https://www.youtube.com/watch?v=qAYvJtIg1qc)!
*A single-server focused music bot for Discord.* See the [help command](https://github.com/kuff/discordify/blob/master/FEATURES.jpg) for a list of all available commands or watch the [video](https://www.youtube.com/watch?v=qAYvJtIg1qc)! See also the [Discoinnect virtual currency](https://github.com/kuff/discoinnect).

## Installation
You are of course free to use this software however you like, as per the MIT license. Following is a short tutorial on how to spin up your own instance of the bot.
Expand Down Expand Up @@ -42,11 +42,9 @@ Under the main directory there's a **settings.json** file where you can tweak a
}
````
1. The **prefix** is the special character(s) that the bot should react on, meaning the one you put in front of a command keyword when you want the bot to do something, e.g. `.play a song`or `.pause`. As a result, I recommend that this be a special character, ensuring the bot is not invoked by mistake!
2. The **embed_color** is the color code for the embeds, more specifically the vertical strip of solid color on the left hand side of the Discord embeds. I recommend keeping this a darker color and have it match the pofile picture of your bot user.
2. The **embed_color** is the color code for the embeds, more specifically the vertical strip of solid color on the left hand side of the Discord embeds. I recommend keeping this a darker color and have it match the pofile picture of your bot user. Select from some of [these](https://gist.github.com/thomasbnt/b6f455e2c7d743b796917fa3c205f812) presets or use [this handy tool](https://leovoel.github.io/embed-visualizer/) to experiment with different embed colors!
3. The **memory_size** parameter is how many previously played songs the bot should remember. This is invoked with the `.replay` command and when autoplaying, and I do not recommend keeping it shorter than five.
4. **default_volume** is the volume used for playback when the bot starts playing. During playback the volume can then be changed with `.volume`, but is then reset once playback ends.
5. **audio_passes** dictates how many passes of the data is sent through the the Discord API. This is useful to help mitigate packet loss but will also significantly increase bandwidth usage, and as a result should probably not be changed!
See the [help command](https://github.com/kuff/discordify/blob/master/FEATURES.jpg) for a list of all available commands, and let me know if you have any trouble or suggestions!
**– kuff**
Loading

0 comments on commit 7f37c9d

Please sign in to comment.