Getting Started

You'll need a Discord application with a bot token. Create one in the Discord Developer Portal, then follow the steps below.

Clone and install

git clone https://github.com/fozmu/relay
cd relay
npm install

Add your token

Copy the example env file and paste your bot token:

cp .env.example .env

.env

DISCORD_TOKEN=your-bot-token-here
DISCORD_CLIENT_ID=your-application-id

Start the bot

npm run start

Relay registers its slash commands on boot and logs in:

[relay] Logged in as Relay#4821
[relay] Registered 14 commands across 3 plugins
[relay] Ready — watching 1 guild

Commands not showing up?

Global slash commands can take up to an hour to appear. For instant updates while developing, set DISCORD_GUILD_ID to register commands to a single server.

Configuration

Per-guild behaviour lives in relay.config.ts:

relay.config.ts

import { defineConfig } from "@fozmu/relay";
 
export default defineConfig({
  prefix: "/",
  moderation: {
    antiSpam: true,
    antiRaid: true,
    blockedDomains: ["example-scam.com"],
  },
  plugins: ["welcome", "reminders", "roles"],
});

Next, see the full Commands list.