Skip to content

Commit

Permalink
Added README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Struck713 committed Feb 23, 2024
1 parent b35aa09 commit eedef73
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# music-bot

A bot that can play music! It's as simple as it sounds.

### Config

If you are self-hosting this bot, you need to do some configuration:

- You will need to have a YTDLP binary installed for this to work, you can get one [here](https://github.com/yt-dlp/yt-dlp/releases).
- Once you configure (below), you can run `/deploy` to deploy all of the slash commands to the bot.

```JSON
{
"token": "Your discord bot token",
"development": {
"application_id": "Your application ID",
"guild_id": "Your guild"
},
"youtube": {
"api_key": "Youtube API key",
"binary_path": "Absolute path to YTDLP"
}
}
```

### Extra features

This bot can also:

- Generate memes with the `/meme` command
- Oobinate (change all vowels of a word to oob) with the `/oob` command
- More dumb stuff I will later

0 comments on commit eedef73

Please sign in to comment.