https://github.com/nachotoast/jukebot

Yet another discord.js music bot.
https://github.com/nachotoast/jukebot

discord javascript nodejs typescript

Last synced: 2 days ago
JSON representation

Yet another discord.js music bot.

• Host: GitHub
• URL: https://github.com/nachotoast/jukebot
• Owner: NachoToast
• License: mit
• Created: 2022-01-26T02:42:19.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-12-16T04:56:28.000Z (7 days ago)
• Last Synced: 2024-12-16T05:27:56.030Z (7 days ago)
• Topics: discord, javascript, nodejs, typescript
• Language: TypeScript
• Homepage:
• Size: 1.56 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

        
# Jukebot 

[![CI](https://github.com/NachoToast/Jukebot/actions/workflows/node.js.ci.yml/badge.svg)](https://github.com/NachoToast/Jukebot/actions/workflows/node.js.ci.yml)

[![CodeQL](https://github.com/NachoToast/Jukebot/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/NachoToast/Jukebot/actions/workflows/codeql-analysis.yml)

[![Deploy](https://github.com/NachoToast/Jukebot/actions/workflows/deploy.yml/badge.svg)](https://github.com/NachoToast/Jukebot/actions/workflows/deploy.yml)

A Minecraft-themed music streaming Discord bot.

## Table of Contents 

- [Technologies](#technologies)

- [Reviews](#reviews)

- [Installation](#installation)

- [Documentation](#documentation)

  - [Script Reference](#script-reference)

  - [Dependency Reference](#dependency-reference)

### Technologies



  

  

  

  

  

  



### Reviews

![image](./.github/docs/Review0.png)

![image](./.github/docs/Review1.png)

### Installation

See the [installation guide](.github/docs/installationGuide.md).

### 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.