M-BOT

M-BOT is a simple music bot made for discord. Songs being pulled from youtube.

Summary

• Summary
• Getting Started
  • Install Dependencies
  • Environment Variables
  • Build
  • Running the application:
• Commands

Getting Started

Install Dependencies

First install the dependencies using, run in your bash:

npm install

# or with yarn

yarn install

Environment Variables

We are almost ready to run the application, but before that you must create an .env file with the same keys as the .env.example file. Changing key values with your information.

Build

After creating your .env file, it's time to build the application. Do this using the command:

npm run build

# or with yarn

yarn build

Running the application:

Now that the application has been builder, run it using the command:

npm run start

# or with yarn

yarn start

Commands

Before each command the prefix ! must be placed.

• !play:
  

  • Data: <value> - Name of the song

  • Description: Use this command to add a song to a new or existing playlist.
    

• !skip
  

  • Description: Skip the song being played to the next one in the list.
    

• !playlist
  

  • Data: <listId> - The list id

  • Description: Use this command to add all songs from a youtube playlist to a new or existing playlist.
    

• !volume
  

  • Data: <value> - Volume

  • Description: Set a new volume for a playlist.
    

• !help
  

  • Description: Displays all bot commands and their functions.
    

License

Distributed under the MIT License. See LICENSE for more information.