Skip to content

Latest commit

 

History

History
98 lines (61 loc) · 3.31 KB

README.md

File metadata and controls

98 lines (61 loc) · 3.31 KB

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. ~ @Solaris9

Documentation & Guides

Prerequisites

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
npm install erela.js
Yarn
yarn add erela.js

Note: Node v14 is required!

Getting Started

  • Create an application.yml file in your working directory and copy the example 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://solaris.codes/projects/erelajs/guides/introduction.html

Plugins

You can use plugins below to extend Erela.js' features easily.

Note: These are the only ones shown before being published, check the GitHub repository for a complete list.

  • erela.js-spotify - Converts a Spotify URL into a UnresolvedTrack to play later.

Contributors

👤 Solaris

👤 Anish Shobith

👤 ayntee