evie4/master-bot

A Discord music bot with slash commands, playlist support, Spotify, music quiz, saved playlists, lyrics, gifs and more

A Discord Music Bot written in JavaScript using the discord.js v13 library

System dependencies

• Node.js LTS or latest
• Java 13 (other versions have some issues with Lavalink)

Installing the Node.js dependencies

After cloning the repository, navigate to the project's folder and run the command npm i to install all Node.js module dependencies.

Setup

Create an application.yml in the root directory of the project.

Download the latest Lavalink jar from here and place it in the project's root directory (same directory as application.yml).

Before running node index.js, make sure to open a separate terminal in the root directory and run java -jar LavaLink.jar

Create a config.json file in the root directory of the project with the following contents:

Minimum settings

This is the minimum amount of settings that need to be set for the core part (music) of the bot to work.

Generate spotify client id and secret here

If you're running the bot using Docker, set lava_host's value to "lavalink" in config.json and in application.yml at line 3

{
  "client_id": "the-bots-discord-id",
  "token": "Your-Bot-Token",
  "lava_host": "0.0.0.0",
  "lava_pass": "youshallnotpass",
  "spotify_client_id": "get-it-from-spotify-dev",
  "spotify_client_secret": "get-it-from-spotify-dev"
}

Full settings

For full command support, including lyrics, GIFs, news, Twitch integration, and others, - (which some of them are part of Features to be added back) - All of the following settings need to be added. You can also choose to add only the ones for the functionalities you want.

{
  "invite": "false",
  "geniusLyricsAPI": "genius-api-key",
  "tenorAPI": "tenor-API-key",
  "newsAPI": "news-api-key",
  "rawgAPI": "rawg-api-key"
}

NOTE: When setting "invite": true, remember to enable the Public Bot option in the Discord Developer Portal.

Commands

Music

Command	Description	Usage
/play	Play any song or playlist from youtube, you can do it by searching for a song by name or song url or playlist url	!play darude sandstorm
/pause	Pause the current playing song	!pause
/resume	Resume the current paused song	!resume
/leave	Leaves voice channel if in one	!leave
/remove	Remove a specific song from queue by its number in queue	!remove 4
/queue	Display the song queue	!queue
/shuffle	Shuffle the song queue	!shuffle
/skip	Skip the current playing song	!skip
/skipall	Skip all songs in queue	!skipall
/skipto	Skip to a specific song in the queue, provide the song number as an argument	!skipto 5
/volume	Adjust song volume	!volume 80
/music-trivia	Engage in a music trivia with your friends. You can add more songs to the trivia pool in resources/music/musictrivia.json	!music-trivia
/loop	Loop the currently playing song or queue	!loop
/lyrics	Get lyrics of any song or the lyrics of the currently playing song	!lyrics song-name
/now-playing	Display the current playing song with a playback bar	!now-playing
/move	Move song to a desired position in queue	!move 8 1
/queue-historu	Display the queue history	!queue-history

Other

Command	Description	Usage
/cat	Get a cute cat picture	!cat
/dog	Get a cute dog picture	!dog
/fortune	Get a fortune cookie tip	!fortune
/insult	Generate an evil insult	!insult
/chucknorris	Get a satirical fact about Chuck Norris	!chucknorris
/motivation	Get a random motivational quote	!motivation
/world-news	Latest headlines from reuters, you can change the news source to whatever news source you want, just change the source in line 13 in world-news.js or ynet-news.js	!world-news
/random	Generate a random number between two provided numbers	!random 0 100
/translate	Translate to any language using Google translate.(only supported languages)	!translate english ありがとう
/about	Info about me and the repo	!about
/8ball	Get the answer to anything!	!8ball Is this bot awesome?
/rps	Rock Paper Scissors	!rps
/bored	Generate a random activity!	!bored
/advice	Get some advice!	!advice
/kanye	Get a random Kanye quote	!kanye
/urban dictionary	Get definitions from urban dictionary	!urban javascript

GIFs

Command	Description	Usage
/animegif	Get an anime related gif by a query	!animegif one punch man
/gif	Get any gif by a query	!gif labrador
/gintama	Replies with a random gintama gif	!gintama
/jojo	Replies with a random jojo gif	!jojo

Resources

Getting a Tenor API key

Getting a NewsAPI API key

Getting a Genius API key

Getting a Twitch API key

Getting a rawg API key

Installing Node.js on Debian

Installing Node.js on Windows

Installing on a Raspberry Pi

Contributing

Fork it and submit a pull request! Anyone is welcome to suggest new features and improve code quality!

Contributors ❤️

Bacon Fixation - 'connect4', 'tic-tac-toe', 'game-search', 'google-translate', 'speedrun' commands, 'invite', 'vote', 'poll', 'welcome', 'mute', 'unmute', 'twitchstatus', 'twitch-announcer', 'welcome-message', 'tv-show-search', pi instructions and visual updates

ModoSN - 'resolve-ip', 'rps', '8ball', 'bored', 'trump', 'advice', 'kanye', 'urban dictionary' commands and visual updates

Natemo6348 - 'mute', 'unmute'

kfirmeg - play command flags, dockerization, docker wiki

rafaeldamasceno - 'music-trivia' and Dockerfile improvements, minor tweaks

navidmafi - 'LeaveTimeOut' and 'MaxResponseTime' options, update issue template, fix leave command

Kyoyo - added back 'now-playing'

MontejoJorge - added back 'remind'

malokdev - 'uptime' command

chimaerra - minor command tweaks