Necord

A module for creating Discord bots using NestJS, based on Discord.js

BotAPI wrapper / SDK
necordjs/necordnecord.orgnecord

README

necord


About


This package uses the best of the NodeJS world under the hood. Discord.js is the most powerful
library for creating bots and Nest.js is a progressive framework for creating well-architectured applications.
This module provides fast and easy way for creating Discord bots and deep integration with your NestJS application.

Features

- Simple. Flexible. Easy to use.
- Ability to create custom decorators.
- Interact with Discord (Slash Commands, Context Menus, Message Components, Listeners).
- Full support of NestJS guards, interceptors, filters and pipes!

For questions and support please use
the Issues.

Installation


Node.js 16.6.0 or newer is required.

  1. ```bash
  2. $ npm i necord discord.js
  3. $ yarn add necord discord.js
  4. $ pnpm add necord discord.js
  5. ```

Usage


Once the installation process is complete, we can import the NecordModule into the root AppModule:

  1. ```typescript
  2. import { NecordModule } from 'necord';
  3. import { Module } from '@nestjs/common';

  5. @Module({
  6.     imports: [
  7.         NecordModule.forRoot({
  8.             token: 'DISCORD_BOT_TOKEN',
  9.             intents: ['Guilds', 'GuildMessages', 'DirectMessages']
  10.         })
  11.     ],
  12.     providers: []
  13. })
  14. export class AppModule {
  15. }
  16. ```

Then create app.update.ts file and add On/Once decorators for handling Discord API events:

  1. ```typescript
  2. import { Injectable, Logger } from '@nestjs/common';
  3. import { Context, On, Once, ContextOf } from 'necord';
  4. import { Client } from 'discord.js';

  6. @Injectable()
  7. export class AppUpdate {
  8.     private readonly logger = new Logger(AppUpdate.name);

  10.     public constructor(private readonly client: Client) {
  11.     }
  12.     
  13.     @Once('ready')
  14.     public onReady(@Context() [client]: ContextOf<'ready'>) {
  15.         this.logger.log(`Bot logged in as ${client.user.username}`);
  16.     }

  18.     @On('warn')
  19.     public onWarn(@Context() [message]: ContextOf<'warn'>) {
  20.         this.logger.warn(message);
  21.     }
  22. }
  23. ```

Whenever you need to handle any event data, use the Context decorator.

If you want to fully dive into Necord check out these resources:

Necord Wiki - Official documentation of Necord.
Nest JS - A progressive framework for creating well-architectured applications.
Discord JS - The most powerful library for creating bots.
Discord API - Official documentation of Discord API.

Backers



Stay in touch


Author - Alexey Filippov
Twitter - @SocketSomeone

License


MIT © Alexey Filippov