https://github.com/xzfirzal/discord-media-player

@discordjs/voice wrapper to manage audio resource easier
https://github.com/xzfirzal/discord-media-player

discord discord-bot discord-js discord-music-bot discord-player discord-voice discordjs discordjs-voice

Last synced: 3 months ago
JSON representation

@discordjs/voice wrapper to manage audio resource easier

• Host: GitHub
• URL: https://github.com/xzfirzal/discord-media-player
• Owner: XzFirzal
• License: mit
• Created: 2021-08-08T13:04:45.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-09-10T14:01:21.000Z (over 3 years ago)
• Last Synced: 2024-04-25T14:03:26.064Z (8 months ago)
• Topics: discord, discord-bot, discord-js, discord-music-bot, discord-player, discord-voice, discordjs, discordjs-voice
• Language: TypeScript
• Homepage: https://xzfirzal.github.io/discord-media-player/index.html
• Size: 1.47 MB
• Stars: 3
• Watchers: 0
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# discord-media-player

[![NPM Version](https://img.shields.io/npm/v/discord-media-player.svg?maxAge=3600)](https://www.npmjs.com/package/discord-media-player)

[![NPM Downloads](https://img.shields.io/npm/dt/discord-media-player.svg?maxAge=3600)](https://www.npmjs.com/package/discord-media-player)

## Table Of Contents

- [About](#about)

- [Dependencies](#dependencies)

  - [Opus](#opus-libraries) (Required)

  - [Encryption](#encryption-libraries) (Required)

  - [FFmpeg](#ffmpeg) (Optional)

- [Examples](#examples)

- [Links](#links)

- [Contributing](#contributing)

## About

[@discordjs/voice](https://npmjs.com/package/@discordjs/voice) wrapper to manage audio resource easier

With some additional features such as:

- Caching

- Looping

- Filtering

- Seeking

## Dependencies

### Opus Libraries

Required, install one of the following:

- @discordjs/opus (Recommended)

- node-opus

- opusscript

### Encryption Libraries

Required, install one of the following:

- sodium

- libsodium-wrappers

- tweetnacl

### FFmpeg

Optional, choose one of the following:

- [FFmpeg](https://www.ffmpeg.org/download.html) (Install manually on the machine)

- npm install ffmpeg-static

FFmpeg is used for audio filters, arbitrary source, and fallback when no opus format found.

## Examples

- [Simple Player](https://github.com/XzFirzal/discord-media-player/blob/main/examples/simple_player.js)

- [Simple Music Bot](https://github.com/XzFirzal/discord-media-player/blob/main/examples/simple_music_bot.js)

## Links

- [Documentation](https://XzFirzal.github.io/discord-media-player/stable/index.html)

- [Documentation (Development)](https://XzFirzal.github.io/discord-media-player/index.html)

- [Source Code](https://github.com/XzFirzal/discord-media-player)

## Contributing

Suggestion will most likely won't be accepted.

Before creating an issue, ensure it hasn't already been reported, and double-check the [Documentation](#https://XzFirzal.github.io/discord-media-player/stable/index.html).

See [CONTRIBUTING.md](https://github.com/XzFirzal/discord-media-player/blob/main/.github/CONTRIBUTING.md) before submitting Pull Request.