Skip to content

Latest commit

 

History

History
78 lines (54 loc) · 1.97 KB

README.md

File metadata and controls

78 lines (54 loc) · 1.97 KB

Melody

Melody is an open-source music bot built with NodeJS and TypeScript. It utilizes Lavalink for audio streaming and Sakulink for handling YouTube links and other music-related functionalities.

Features

  • 🎶 Play music from various sources
  • 🔊 Support for playlists
  • 🎧 Real-time voice channel management
  • 🎵 Easy integration with Discord.js and Sapphire
  • 🌐 Open-source and actively maintained

Prerequisites

Before you begin, ensure you have met the following requirements:

Installation

  1. Clone the repository
git clone https://github.com/JirayuSrisawat-Github/melody.git
cd melody
  1. Install dependencies
npm install
  1. Config by put your token in config.ts
import { NodeOptions } from "sakulink";

export const token: string = "xxx";
export const defaultSearchPlatform: string = "youtube music";
export const defaultVolume: number = 75; 
export const nodes: NodeOptions[] = [
  {
    identifier: "Jirayu_V4",
    host: "lavalink.jirayu.net",
    port: 13592,
    password: "youshallnotpass",
  },
];
  1. Build
npm run build
  1. Start your bot
npm run start

Usage

  • Invite the bot to your server using the OAuth2 URL generated in the Discord Developer Portal.
  • Use commands to play, pause, skip, and manage your music queue.

Example Commands

  • /play query:<string> - Play a song.
  • /stop - Stop the music.
  • /skip - Skip current song.

Contributing

We welcome contributions! Please read our Contributing Guide for details on how to get started.