README.md

Jukebot

A Minecraft-themed music streaming Discord bot.

Table of Contents

• Technologies
• Reviews
• Installation
• Documentation
  • Script Reference
  • Dependency Reference

Technologies

Reviews

Installation

See the installation guide.

Documentation

Script Reference

• start Starts bot with hot-reloading enabled.
• build Compiles bot into JavaScript.
• lint Makes sure code follows style rules.
• typecheck Makes sure there are no type errors in the code.
• test Runs tests.
• check-all Does linting, typechecking, and testing. Note that this requires pnpm.
• auth Initiates YouTube/Spotify login process.

Dependency Reference

• @discordjs/opus Opus bindings for Node.
• @discordjs/voice Discord voice API wrapper.
• dayjs Helps displaying relative times.
• discord.js Discord API wrapper.
• play-dl Searching, downloading, and streaming of music.
• sodium-native Audio encryption library, improves performance.