# discord-musicbot-develop

> Discord Music Bot

Latest version **1.0.0** (published 2023-11-12) · ISC license · 0 weekly downloads

## Install

```sh
npm install discord-musicbot-develop
pnpm add discord-musicbot-develop
yarn add discord-musicbot-develop
bun add discord-musicbot-develop
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2023-11-12 |
| First published | 2023-11-12 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 1.4 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | wolf5 |

## Links

- npm: https://www.npmjs.com/package/discord-musicbot-develop
- npm.io page: https://npm.io/package/discord-musicbot-develop

## Dependencies (1)

- [express](https://npm.io/package/express.md) ^4.18.2

## Recent versions

- 1.0.0 (latest) — 2023-11-12

## README

<h1 align="center"> Discord Music Bot </h1>

## 🚧 | Prerequisites

- [Docker](https://www.docker.com/)
- Optionally: [GNU Make](https://www.gnu.org/software/make/)

## 📝 | Tutorial

### Written Setup

- Follow the [installation](https://github.com/BioCla/Discord-MusicBot/blob/feature/DJSv14/djs-bot/README.md) procedure for the bot
  - Do keep in mind that this is the ONLY part of the tutorial that you need to follow from the original repo, which is the core of the bot

#### For everything else:
- Make sure you have [Docker](https://www.docker.com/) (and [GNU Make](https://www.gnu.org/software/make/)) installed on your machine
  - If you are planning on running the bot through docker on windows, then you'll have to use WSL and set up the appropriate docker configurations for that [(click here)](https://docs.docker.com/desktop/windows/wsl/)
- Open a terminal session in in the root directory of the project
- Run `make help` to see the list of available commands
  - If you don't have or can't install makefile utilities then run `./dc.sh help`
  - If you're having trouble running the script due to lack of permissions be sure to `chmod +x dc.sh`

#### Docker setup

- Run `make up` to start the docker environment with all services active
  - Use `make up help` for a list of available sub commands
- Run `make log` to see the logs of all services at once
  - You can exit them at any time without closing the process by pressing `Ctrl + C`
- If you don't want a particular service to start up on `make up` you can simply add a `no` flag to the command. For example:
  - `make up nodb` will start the docker environment without the DB.
  - `make up noll` will start the docker environment without the lavalink server.
  - `make up nofe` will start the docker environment without the frontend.
  > Note: you can use any combination of the flags above to start the docker environment with only the services you want.

#### Lite version

The bot also supports a lite version to run the bot without docker. This is useful for development and testing purposes as well as potato machines.
- Run `make lite help` for a list of available sub commands
Contrary to the `make up` command, the `make lite` command will only start the bot, without any additional services.
- To add additional services you can use the `make lite` with the following flags:
  - `make lite db` to start the DB
  - `make lite ll` to start the lavalink server
  - `make lite fe` to start the frontend

#### Local setup

- Run `make up no-docker` to start the bot locally (on your maching, without virtualization and thus extended services)

- Run `make up help` to see the list of available commands and options
- Remember to remove the DB related environment variables from the `./djs-bot/.env` file if you are not using the DB at all.

## 📝 | [Support Server](https://discord.gg/sbySMS7m3v)

If you have major coding issues with this bot, please join and ask for help.

## 📸 | Screenshots

Soon

## 🚀 | Deploy

- No deployment options have been configured yet

## ✨ | Contributors

Contributions are always welcomed :D Make sure to follow [Contributing.md](/CONTRIBUTING.md)

<a href="https://github.com/SudhanPlayz/Discord-MusicBot/graphs/contributors">
  <img src="https://contributors-img.web.app/image?repo=SudhanPlayz/Discord-MusicBot" />
</a>

## 🌟 | Made with

- [Discord.js](https://discord.js.org/)
- [Lavalink](https://github.com/freyacodes/Lavalink) with erela.js, Cosmicord.js

---
_Source: https://npm.io/package/discord-musicbot-develop · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._