Setup Seyfert Project

Typescript settings

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

tsconfig.json

tsconfig.json

{
  "compilerOptions": {

    "emitDecoratorMetadata": true,
    "experimentalDecorators": true,
  }
}

we use

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, which is the most commonly used, and another based on the Discord HTTP interaction system, which is less frequently used. It is important to understand the differences between these two types in order to choose the appropriate application for your needs.

Read this

In these first steps, the options that are shared by both types of applications are shown. Later on, they will be separated.

Gateway

• Gateway client receive all events from discord like messageCreate, interactionCreate, guildCreate, ready…
• The events that the client receive depends of the client intents.

HTTP

• Unlike gateway, don’t receive events.
• Only execute commands with http request from discord.

Configuration

Once tsconfig.json has been modified, we still have a few steps to go before we can run the application. In this case you need to tell seyfert your project’s structure: so is necessary to 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
       commands: "commands"
   }
});

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
        commands: "commands"
    }
});

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

Gateway

src/index.ts

import { Client } from 'seyfert';

const client = new Client();

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

HTTP

src/index.ts

import { HttpClient } from 'seyfert';

const client = new HttpClient();

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

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

• Directorysrc

  • Directorycommands/

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