Skip to content
This repository has been archived by the owner on Jun 15, 2024. It is now read-only.

Digital-Dimensions-LLC/azrael-djs

Repository files navigation

adjs-logo

Azrael-DJS is a powerful Node.js module built off of Discord.js v12 that allows you to easily interact with the Discord API.

  • Object-oriented
  • Predictable abstractions
  • Performant
  • 100% coverage of the Discord API
  • Native Interactions Support

Installation

Node.js 16.9.0 or newer is required.

npm install azrael-djs

Optional packages

  • zlib-sync for WebSocket data compression and inflation (npm install zlib-sync)
  • erlpack for significantly faster WebSocket data (de)serialisation (npm install discord/erlpack)
  • bufferutil for a much faster WebSocket connection (npm install bufferutil)
  • utf-8-validate in combination with bufferutil for much faster WebSocket processing (npm install utf-8-validate)
  • @discordjs/voice for interacting with the Discord Voice API (npm install @discordjs/voice)

Example usage

const Discord = require('azrael-djs');
const client = new Discord.Client();

client.on('ready', () => {
  console.log(`Logged in as ${client.user.tag}!`);
});

client.on('message', msg => {
  if (msg.content === 'ping') {
    msg.reply('pong');
  }
});

client.login('token');

Links

Create a bug report

If you see an error message or run into an issue, please create bug report. This effort is valued and it will help all Azrael-DJS users.

Contributing

Azrael-DJS is an open-source project. We are committed to a fully transparent development process and appreciate highly any contributions. Whether you are helping us fix bugs, proposing new features, or spreading the word - we would love to have you as part of the Azrael-DJS community.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

💻TheCuteFoxxy
💻Airbus A330-200

Source Credit

Azrael-DJS is built off of the Discord.js source code and modified for public use.