README

harmonylink • Docs

---

[!WARNING]
Support for Lavalink Version 3 is planned, but not confirmed to be done.

Table of Contents

1. About
   • Demo
   • Built With
2. Getting Started
   • Installation
3. Example Usage
4. Contributing
5. License

About

Seamlessly connect to LavaLink nodes for high-quality audio streaming in your applications. HarmonyLink offers a reliable and easy-to-use interface, perfect for building music bots and audio applications with superior performance.

(back to top)

Demo:

URL	Features	Additional Information
RhythmCore	Advanced Music bot With AI	Invite
Example Bot	Verry basic example bot	coming soon

(back to top)

Getting Started

Here is how to install HarmonyLink on your project.

Installation

# Using npm
npm install harmonylink

# Using yarn
yarn add harmonylink

(back to top)

Example Usage

// With Discord.js Version 14
import { DJSLibrary } from "HarmonyLink";
import { Client } from "discord.js"

// Initialize your client
const client = new Client();

const config: HarmonyLinkConfiguration = {
  nodes: [
    {
      name: "Example Node",
      host: "example.com",
      port: 2333,
      password: "youshallnotpass",
      secure: false
    }
  ] // Your nodes. 
  library: new DJSLibrary(client),
};

const HarmonyLink = new HarmonyLink(config)

// Creating a player
await HarmonyLink.createPlayer()

For more examples, please refer to the Documentation

For more details, see the NodeType documentation.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)