• This repository has been archived on 12/Jul/2023
  • Stars
    star
    320
  • Rank 131,126 (Top 3 %)
  • Language
    TypeScript
  • License
    Apache License 2.0
  • Created almost 4 years ago
  • Updated over 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Implementation of the Discord Voice API for discord.js and other JS/TS libraries

discord.js


Discord server npm version npm downloads Build status Code coverage Patreon

About

An implementation of the Discord Voice API for Node.js, written in TypeScript.

Features:

  • Send and receive* audio in Discord voice-based channels
  • A strong focus on reliability and predictable behaviour
  • Horizontal scalability and libraries other than discord.js are supported with custom adapters
  • A robust audio processing system that can handle a wide range of audio sources

*Audio receive is not documented by Discord so stable support is not guaranteed

Installation

Node.js 16.0.0 or newer is required.

npm install @discordjs/voice
yarn add @discordjs/voice
pnpm add @discordjs/voice

Dependencies

This library has several optional dependencies to support a variety of different platforms. Install one dependency from each of the categories shown below. The dependencies are listed in order of preference for performance. If you can't install one of the options, try installing another.

Encryption Libraries (npm install):

  • sodium: ^3.0.2
  • tweetnacl: ^1.0.3
  • libsodium-wrappers: ^0.7.9

Opus Libraries (npm install):

  • @discordjs/opus: ^0.4.0
  • opusscript: ^0.0.7

FFmpeg:

  • FFmpeg (installed and added to environment)
  • ffmpeg-static: ^4.2.7 (npm install)

Links

Contributing

Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the documentation.
See the contribution guide if you'd like to submit a PR.

Help

If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official discord.js Server.

More Repositories

1

discord.js

A powerful JavaScript library for interacting with the Discord API
TypeScript
24,119
star
2

guide

The official guide for discord.js, created and maintained by core members of its community.
JavaScript
1,402
star
3

Commando

Official command framework for discord.js
JavaScript
500
star
4

discord-api-types

Up to date Discord API Typings, versioned by the API version
TypeScript
446
star
5

RPC

A simple RPC client for Discord
JavaScript
438
star
6

discord.js-modules

Modularisation of discord.js (WIP)
TypeScript
200
star
7

website

The discord.js site what else
Vue
185
star
8

opus

Native opus bindings for node
C++
173
star
9

collection

Utility data structure used in Discord.js
TypeScript
115
star
10

builders

A collection of builders that you can use when creating your bot.
TypeScript
97
star
11

docgen

The docs.json generator for discord.js and its related projects
JavaScript
65
star
12

discord-utils-bot

Discord slash command utility for discord.js bot developer support
TypeScript
56
star
13

Commando-guide

Beginner's guide for discord.js-commando.
55
star
14

discord.js-typings

Official TypeScript type definitions for Discord.js
TypeScript
49
star
15

voicelink

29
star
16

uws

Fork of node.js bindings for uWebSockets.
C++
29
star
17

discord-toolkit-bot

Discord bot application providing useful utilities to the discord.js support server
TypeScript
25
star
18

resource-webhooks

A collection of webhooks to update our resources on discord
TypeScript
20
star
19

voice-examples

A collection of examples of how to use @discordjs/voice in your projects
TypeScript
15
star
20

action-eslint

TypeScript
12
star
21

docs

Documentation files
TypeScript
11
star
22

webhook-filter

Filters out push events for specific repositories/branches from a GitHub webhook
JavaScript
11
star
23

gh-discord-middleware

TypeScript
8
star
24

action-docs

Shell
6
star
25

.github

Here lies our profile.
2
star
26

action-webpack

Shell
2
star