10000 GitHub - MenuDocs/erela.js at 44d4629287312b43f936772c3edab4c66cd04511
[go: up one dir, main page]

Skip to content
This repository was archived by the owner on Nov 13, 2022. It is now read-only.

MenuDocs/erela.js

Repository files navigation

READ ME FIRST

Erela v3 changes a LOT how Erela works and how it's used. To start it is no longer a single package but rather several and usage of Erela depends on what package is being used. Audio providers is the main breaking change where you can use either Lavalink or FFMPEG with your bot and switch at any time with some code changes. Anything from now on out may be changed

Contributors

Before you want to help, understand this is a bigger project than it was before and is still in early development, help is appreciated but please only help when you 100% know what is going on

Documentation & Guides

Out dated at this point, please use with caution

Developing

Note: This is more of a first time setup.

Note: I also recommend using Yarn over NPM, you can have both installed and use either one but for this project Yarn is preferred.

  1. Fork the repository
  2. yarn install
  3. yarn run lerna bootstrap
  4. yarn run lerna run build
  5. yarn run lerna run types
  6. yarn link the packages you wish to test to your test folder

Note: This may not be correct as I (Solaris) am using the example bot to test.

Contributors

👤 Solaris

👤 Anish Shobith

  • Contributor
  • Github: @Anish-Shobith
  • Has helped maintained through the different versions.

👤 2D

  • Contributor
  • Github: @melike2d
  • Helped with v3 audio provider and general Lavalink things.

👤 ayntee

  • Contributor
  • Github: @ayntee
  • Helped with v1 and v2.

And the many others in the community who have helped keep Erela.JS running clean, thank you.

0