Skip to content

Latest commit

 

History

History
56 lines (36 loc) · 2.08 KB

README.md

File metadata and controls

56 lines (36 loc) · 2.08 KB

discord-bot

build-and-release

A discord bot to run and host yourself to bring music playback to your discord server.

Contents

Run

  • Create Bot Account: For steps on how to create a Discord Bot Accont and invite it to your discord server follow the steps here: Create a Bot Account

  • git clone https://github.com/ronniegeraghty/discord-bot.git
    cd discord-bot
    mv .env.example .env
  • Edit the .env file with the specifics for your bot. For the Container runtime you'll need to fill out all th environment variables. For the Node.js runtime you'll only need to fill out the environment variables in the #Discord Bot Config & #Mongo DB Config sections.

  • There are 3 ways to run the app. Pull the container image from GHCR, Rebuild the container locally, or run the app in a Node.js env.

    • Pull Container from GHCR:

      • docker-compose up
    • Rebuild Container Locally:

      • docker-compose up --build
    • Node.js: Note: Requires Node.js v16 or higher & and MongoDB database.

      • npm i
        .\ci\postInstallFixes.sh
        npm run build
        npm run start
  • Once you can see your discord bot active in your discord server, enter this command in a text channel of the discord server.

    • <prefix>add-slash-commands Where <prefix> is the PREFIX environment variable you set.
  • You can test the bot by entering th /ping command in a text channel. This bot uses slash commands so you should see the command list pop up once you type a / in a text channel.

Features

  • Music Playback: Play audio of youtube videos in a discord voice channel.
    • Ex: /play url:https://www.youtube.com/watch?v=5aopMm7UGYA&ab_channel=BaconAkin