Setup Project

Prerequisites

In order to use Seyfert, you must have installed:

• NodeJS installed (18 or higher)
• TypeScript installed (4.9 or higher)
• npm installed (or a package manager alike)

Install seyfert

Installing seyfert...

npm add seyfert

Also you might want to install the github version for the latest changes:

Installing seyfert from github...

npm add github:tiramisulabs/seyfert

Typescript settings

To make Seyfert work as intended you must update your tsconfig.json file and add emitDecoratorMetadata and experimentalDecorators in order to be able to use decorators:

tsconfig.json

tsconfig.json

{
  "compilerOptions": {

    "outDir": "./dist",
    "emitDecoratorMetadata": true,
    "experimentalDecorators": true,
  }
}

tsconfig.json (example)

tsconfig.json

{
  "compilerOptions": {
    "module": "CommonJS",
    "target": "ESNext",
    "moduleResolution": "node",
    "strict": true,
    "esModuleInterop": true,
    "experimentalDecorators": true,
    "emitDecoratorMetadata": true,
    "preserveConstEnums": true,
    "noImplicitAny": true,
    "strictNullChecks": true,
    "strictFunctionTypes": true,
    "noImplicitThis": true,
    "noUnusedLocals": true,
    "noUnusedParameters": true,
    "noImplicitReturns": true,
    "skipLibCheck": true,
    "noErrorTruncation": true,
    "outDir": "./dist",
    "rootDir": "./src",
    "baseUrl": ".",
    "stripInternal": true,
  },
  "exclude": ["node_modules"],
  "include": ["src/**/*"]
}

Selecting Your Bot Type.

Currently, Seyfert supports two types of applications: one based on the Discord gateway, and one based on the Discord HTTP interaction system, the former being used the most. It is key to understand the differences between these two types in order to choose whichever application for your needs.

Gateway

• The Gateway client receives all events from discord like messageCreate, interactionCreate, guildCreate, ready, etc.
• The events that the client receives depend on the client intents.

HTTP

• Unlike gateway, does not receive events.
• Only executes commands with an http request from discord.

Configuration

Once tsconfig.json has been modified, we still have a few steps to follow before we can run our bot. In this case, you must tell your project’s structure to seyfert: so create a file called seyfert.config.js in the root folder of your project and add the following code:

Gateway

seyfert.config.js

// @ts-check is better
const { config } = require('seyfert');

module.exports = config.bot({
   token: process.env.BOT_TOKEN ?? "",
   intents: ["Guilds"],
   locations: {
       base: "src",
       output: "dist", //If you are using bun, set "src" instead
   }
});

HTTP

seyfert.config.js

// @ts-check is better
const { config } = require('seyfert');

module.exports = config.http({
    token: process.env.BOT_TOKEN ?? "",
    applicationId: process.env.BOT_APP_ID,
    port: 3000, // by default is 8080
    publicKey: process.env.BOT_PUBLIC_KEY,
    locations: {
        base: "src",
        output: "dist", //If you are using bun, set "src" instead
    }
});

And let’s create the main file called index in the src folder and add the following code:

Gateway

src/index.ts

import { Client, ParseClient } from "seyfert";

const client = new Client();

// This will start the connection with the gateway and load commands, events, components and langs
client.start();

declare module 'seyfert' {
  interface UsingClient extends ParseClient<Client<true>> { }
}

HTTP

In order to use the http client, you must install uws-adapter.

Note

We have another adapter generic-adapter but we recommend using uws-adapter for most cases except for cloudflare workers

npm add @slipher/uws-adapter

src/index.ts

import { HttpClient, ParseClient } from "seyfert";
import { UwsAdapter } from '@slipher/uws-adapter';

const client = new HttpClient();
const adapter = new UwsAdapter(client);

// This will start listening to `https://yourweb.xyz/interactions` and load commands, components and langs
client.start();
adapter.start();

declare module 'seyfert' {
  interface UsingClient extends ParseClient<HttpClient> { }
}

Note

the declare module 'seyfert' is necessary to tell typescript which client we are using. Understaind declare module

So after finishing these steps, your project structure should look like this:

• Directorysrc

  • index.ts
• seyfert.config.js
• package.json
• .env
• tsconfig.json