Git Product home page Git Product logo

qbot's Introduction

logo

๐Ÿค– QBot (Discord Music Bot)

QBot is a Discord Music Bot built with discord.js & uses Command Handler from discordjs.guide

Requirements

  1. Discord Bot Token Guide
  2. Node.js v14.0.0 or newer

๐Ÿš€ Getting Started

git clone [email protected]:Unnil/qbot.git
cd qbot
npm i

After installation finishes follow configuration instructions then run npm run start to start the bot.

โš™๏ธ Configuration

Copy or Rename config.json.example to config.json and fill out the values:

โš ๏ธ Note: Never commit or share your token or api keys publicly โš ๏ธ

{
  "TOKENS": [""],
  "REDIS_URL": "",
  "SOUNDCLOUD_CLIENT_ID": "",
  "SPOTIFY_CLIENT_ID": "",   
  "SPOTIFY_SECRET_ID": "",
  "MAX_PLAYLIST_SIZE": 50,
  "PREFIX": "/",
  "PRUNING": false,
  "LOCALE": "en",
  "DEFAULT_VOLUME": 10,
  "STAY_TIME": 30
}

๐Ÿ“ Features & Commands

Note: The default prefix is '/'

  • ๐ŸŽถ Play music from YouTube via url

/play https://www.youtube.com/watch?v=GLvohMXgcBo

  • ๐Ÿ”Ž Play music from YouTube via search query

/play under the bridge red hot chili peppers

  • ๐ŸŽถ Play music from Spotify via url

/play https://open.spotify.com/playlist/37i9dQZF1EIY5o2jtmm5PI?si=f66aba8d9ff74c11

  • ๐Ÿ”Ž Search and select music to play

/search Pearl Jam

Reply with song number or numbers seperated by comma that you wish to play

Examples: 1 or 1,2,3

  • ๐Ÿ“ƒ Play youtube playlists via url

/playlist https://www.youtube.com/watch?v=YlUKcNNmywk&list=PL5RNCwK3GIO13SR_o57bGJCEmqFAwq82c

  • ๐Ÿ”Ž Play youtube playlists via search query

/playlist linkin park meteora

  • Now Playing (/np)
  • Queue system (/queue, /q)
  • Loop / Repeat (/loop)
  • Shuffle (/shuffle)
  • Volume control (/volume, /v)
  • Lyrics (/lyrics, /ly)
  • Pause (/pause)
  • Resume (/resume, /r)
  • Skip (/skip, /s)
  • Skip to song # in queue (/skipto, /st)
  • Move a song in the queue (/move, /mv)
  • Remove song # from queue (/remove, /rm)
  • Play an mp3 clip (/clip song.mp3) (put the file in sounds folder)
  • List all clips (/clips)
  • Show ping to Discord API (/ping)
  • Show bot uptime (/uptime)
  • Toggle pruning of bot messages (/pruning)
  • Help (/help, /h)
  • Command Handler from discordjs.guide
  • Media Controls via Reactions

๐ŸŒŽ Locales

Currently available locales are:

  • English (en)
  • Spanish (es)

๐Ÿค Contributing

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/your-username/evobot.git
  3. Create your feature branch: git checkout -b my-new-feature
  4. Stage changes git add .
  5. Commit your changes: cz OR npm run commit do not use git commit
  6. Push to the branch: git push origin my-new-feature
  7. Submit a pull request

๐Ÿ“ Credits

@iCrawl For the queue system used in this application which was adapted from @iCrawl/discord-music-bot @eritislami For generate the first version

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.