erela.js

KO | EN

gitlite — search

#java #php #android #golang #http #cpp #nodejs #javascript #library #python #react #rsa

★ 189 Open GitHub ↗

An easy-to-use Lavalink client for NodeJS.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

## Archived

Due to a growing concern about the status of Music Bots on Discord and a lack of motivation from the team, we have decided to archive Erela and drop support for it entirely.

We recommend to use another lavalink client and not a fork, you can find another one [here](https://github.com/freyacodes/lavalink#client-libraries).

<!--
> Erela was transferred to MenuDocs, because I no longer wish to work with Discord related development. It will from now on be maintained by [MenuDocs](https://github.com/MenuDocs). ~ @Solaris9

## Documentation & Guides

- [Documentation](https://erelajs-docs.netlify.app/docs/gettingstarted.html "Erela.js Documentation")

- [Guides](https://erelajs-docs.netlify.app/guides/introduction.html "Erela.js Guides")

## Prerequisites

- Java - [Azul](https://www.azul.com/downloads/zulu-community/?architecture=x86-64-bit&package=jdk "Download Azul OpenJDK"), [Adopt](https://adoptopenjdk.net/ "Download Adopt OpenJDK") or [sdkman](https://sdkman.io/install "Download sdkman")

- [Lavalink](https://ci.fredboat.com/viewLog.html?buildId=lastSuccessful&buildTypeId=Lavalink_Build&tab=artifacts&guest=1 "Download Lavalink")

**Note**: _Java v11 or newer is required to run the Lavalink.jar. Java v13 is recommended._ If you are using **sdkman** then _its a manager, not Java, you have to install sdkman and use sdkman to install Java_

**Warning**: Java v14 has issues with Lavalink.

## Installation

##### **NPM**

```bash
npm install erela.js
```

##### **Yarn**

```bash
yarn add erela.js
```

**Note**: _Node **v16** is required!_

## Getting Started

- Create an application.yml file in your working directory and copy the [example](https://github.com/freyacodes/Lavalink/blob/master/LavalinkServer/application.yml.example "application.yml file") into the created file and edit it with your configuration.

- Run the jar file by running `java -jar Lavalink.jar` in a Terminal window.

## Example usage

Please read the guides to start: <https://erelajs-docs.netlify.app/docs/gettingstarted.html#example-usage>

## Contributors

👤 **Solaris**

- Author
- Website: <https://solaris.codes/>
- Github: [@Solaris9](https://github.com/Solaris9)

👤 **Anish Shobith**

- Contributor
- Github: [@Anish-Shobith](https://github.com/Anish-Shobith)

👤 **melike2d**

- Contributor
- Github: [@melike2d](https://github.com/melike2d)

👤 **ayntee**

- Contributor
- Github: [@ayntee](https://github.com/ayntee)
--!>

erela.js

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README