https://github.com/darkslayerhaos/ruvyrias-example

A music bot with command and event handling, using Ruvyrias and Lavalink | Discord.js V14.
https://github.com/darkslayerhaos/ruvyrias-example

discordjs djs djs-v14 lavalink music-bot nodejs ruvyrias typescriptt

Last synced: about 2 months ago
JSON representation

A music bot with command and event handling, using Ruvyrias and Lavalink | Discord.js V14.

• Host: GitHub
• URL: https://github.com/darkslayerhaos/ruvyrias-example
• Owner: DarkslayerHaos
• License: mit
• Archived: true
• Created: 2024-03-11T22:17:32.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-04-16T20:58:34.000Z (7 months ago)
• Last Synced: 2024-09-28T08:42:22.595Z (about 2 months ago)
• Topics: discordjs, djs, djs-v14, lavalink, music-bot, nodejs, ruvyrias, typescriptt
• Language: TypeScript
• Homepage:
• Size: 84 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## 🚀 Setting Up The Environment

* It is necessary to have [NodeJS](https://nodejs.org/en/download/current/) version 16.9x or higher installed.

* After downloading/cloning the repository, use the command `npm install` to install all dependencies.

* Inside the `src/settings` folder, rename the `.env.example` file to `.env` and insert your bot's **token** into it.

```yaml

TOKEN=bot-token

PREFIX=.

```

## 💡 Configure Lavalink

* To tailor the bot to your specific needs, you must adjust the Lavalink server settings. Locate the configuration file in the following directory:

```

├── 📁 music-bot

|  └── 📁 src

|     └── 📁 settings

|        └── 📄 config.ts

```

* Insert the fields below according to your needs:

```

{

    name: 'main',

    host: 'localhost',

    port: 80,

    password: 'youshallnotpass',

    secure: false,

}

```

* If you've done everything correctly, now you just need to use the command `npm start`, and your bot should come online.

## 🎶 Music Commands

* Once the bot is online, you can use the following music commands:

| Command                         | Description                                                           |

| ------------------------------- | --------------------------------------------------------------------- |

| `.play `      | Play a song by providing a link or the name of the song.              |

| `.pause`                        | Pause the currently playing track.                                    |

| `.resume`                       | Resume playback.                                                      |

| `.skip`                         | Skip to the next track in the queue.                                  |

| `.stop`                         | Stop the music and clear the queue.                                   |

| `.queue`                        | Display the current music queue.                                      |

| `.playprevious`                 | Play the previously played track.                                     |

| `.loop`                         | Toggle loop mode for the entire queue.                                |

| `.bassboost`                    | Enhance the bass of the music.                                        |

| `.save`                         | Save the currently playing track and send the link in DM to the user. |

| `.volume <1-100>`               | Adjust the volume of the music.                                       |