Skip to content

A multipurpose Discord music app written in TypeScript.

License

Notifications You must be signed in to change notification settings

devmoreir4/BeatKeeper

Repository files navigation

BeatKeeper Discord App

BeatKeeper is a Discord app focused on playing music from a local library, while also offering additional features and extra commands for server management and fun.

Installation & Setup

Prerequisites

  • Node.js v20.17.0 or higher.
  • npm (usually comes with Node.js).
  • FFmpeg: Required for audio processing and transcoding.
    • You can install FFmpeg globally or use the ffmpeg-static package.

Installation Steps

  1. Clone the Repository:
git clone https://github.com/devmoreir4/BeatKeeper.git
cd BeatKeeper
  1. Install Dependencies:
npm install
  1. Configure Environment Variables:

Rename the .env.example file to .env and add your Discord token:

DISCORD_TOKEN=your_discord_token_here

NOTE: You can get your token from the discord developer portal.

  1. Add Your Music Library:

Place your audio files (mp3, webm, wav, etc.) into the /musics folder.

  1. Compile and Start the App:

For development, you can run:

npm run dev

To compile and run the app:

npm run build
npm start

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests to improve the project.

About

A multipurpose Discord music app written in TypeScript.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published