Giter VIP home page Giter VIP logo

jukebot-js's Introduction

Welcome to JukeBot's repository!

requires a mere 3 dependencies not including the dependencies of those dependencies

doesn't require ffmpeg/avconv, very low CPU & RAM usage because of the low dependency count & the fact that it'll only play opus format

soundcloud is probably broken because of the strict opus-only stuff

Self-Hosting: Getting Started

You'll need several things:

A Discord Account (duh)

A Discord Bot Account

A Google API Key

NodeJS 7.x

Git

Self-Hosting: Configuring & Running

Once you have the basics done above, begin by creating a folder somewhere accessible (E.g. your desktop).

Open your newly created folder, and shift+right-click inside. Select 'Open Command Window Here'.

In the command window, type in the following command:

git clone https://github.com/Devoxin/JukeBot.git

In the new 'JukeBot' folder that's just been created, head into /src/, rename config.example.json to config.json and open it.

Inside config.json, enter your youtube key, bot token, desired prefix & paste your ID (in quotations, don't use your 4 digit discriminator) in the owner array, like so:

(You can get a youtube key from the Google API page. Create a project & enable the 'YouTube Data API v3' for it).

Property Breakdown:

token      - This is your bot token
owners     - This acts as a bot override ensuring full permissions.
youtube    - This is your Google API key, used for accessing YouTube data
soundcloud - This is your SoundCloud API key, used for accessing SoundCloud data
prefix     - This is the character users will need to prefix their messages with to use the bot
version    - DO NOT CHANGE. This helps diagnose issues should you encounter any.
hardblock  - Users blocked from using the bot everywhere

Once you've filled in config.json with the relevant info, return to your command window and type in

npm install && npm start

This will install the necessary modules and start JukeBot.

The last step is inviting the bot to your server. Head Here and paste your bot's client ID from the discord developers page into the box at the bottom left, and then click on the generated link. You'll be taken to the Discord page to invite the bot to your server, select the appropriate server and hit Authorize! You may now begin using the bot :)

jukebot-js's People

Contributors

devoxin avatar stylite avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.