Skip to content

Commit

Permalink
docs: add eris
Browse files Browse the repository at this point in the history
  • Loading branch information
twlite committed Aug 11, 2024
1 parent 503dfc4 commit 7cda518
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion apps/website/src/pages/guide/_guides/welcome/welcome.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ Discord Player is a robust framework for developing Discord Music bots using Jav
- Offers easy debugging methods
- Out-of-the-box voice states handling
- IP Rotation support
- Limited support for [Eris](https://npmjs.com/eris)

> Eris compat mode does not support `VoiceStateUpdate` handler. You need to handle it manually.
## Installation

Expand Down Expand Up @@ -94,7 +97,7 @@ $ npm install --save ffmpeg-binaries

YouTube streaming is not supported without installing one of the following package. If you want to add support for YouTube playback, you need to install a streaming library. This step is not needed if you do not plan on using youtube source.

* The default Youtube streaming appears to be unstable due to recent changes. It is recommend to install [`discord-player-youtubei`](https://npm.im/discord-player-youtubei)*
- The default Youtube streaming appears to be unstable due to recent changes. It is recommend to install [`discord-player-youtubei`](https://npm.im/discord-player-youtubei)\*

```bash
$ npm install --save youtube-ext
Expand Down Expand Up @@ -135,6 +138,20 @@ await player.extractors.loadDefault((ext) => ext !== 'YouTubeExtractor');

</CH.Code>

## Eris Setup

Discord Player has limited support for Eris. You can use the following code to set up Discord Player with Eris:

<CH.Code>

```js index.js
const { Player, createErisCompat } = require('discord-player');

const player = new Player(createErisCompat(client));
```

</CH.Code>

Discord Player is mostly events based. It emits different events based on the context and actions. Let's add a basic event listener to notify the user when a track starts to play:

<CH.Code>
Expand Down

0 comments on commit 7cda518

Please sign in to comment.