Skip to content

discord_adapter_setup.md

Latest commit

 

History

History
82 lines (57 loc) · 3.82 KB

discord_adapter_setup.md

File metadata and controls

82 lines (57 loc) · 3.82 KB
Raw

Discord Adapter Setup Guide

This guide describes how to set up and configure the Discord adapter for Clawmini.

Prerequisites

  • A Discord account.
  • A Clawmini daemon running locally (the adapter communicates with it via TRPC over Unix sockets).

Step 1: Create a Discord Bot

  1. Go to the Discord Developer Portal.
  2. Click New Application.
  3. Give your application a name (e.g., "Clawmini-Bot") and click Create. (Optional: Set the App Icon using this default avatar image).
  4. In the left sidebar, click Bot.
  5. Under Bot Token, click Reset Token (or Copy Token) to retrieve your bot's token. Save this token securely; you will need it later.
  6. Scroll down to the Privileged Gateway Intents section.
  7. Enable Message Content Intent. This is required for the bot to read DM messages.
  8. Click Save Changes.

Step 2: Get Your Discord User ID

The adapter only responds to messages from a single authorized user. To find your Discord User ID:

  1. Open Discord and go to User Settings (the gear icon at the bottom left).
  2. Go to Advanced.
  3. Enable Developer Mode.
  4. Right-click on your profile picture or username in a server or DM and select Copy User ID.

Step 3: Invite the Bot to Your Direct Messages

Discord bots cannot initiate a DM conversation with a user unless the user has first interacted with the bot.

  1. In the Discord Developer Portal, go to OAuth2 -> URL Generator.
  2. Select the bot scope.
  3. If prompted for an Installation Method, ensure you select Guild Install. The bot scope is not valid for "User Install" and will cause an error.
  4. Select the Send Messages and Read Message History permissions under Bot Permissions.
  5. Copy the generated URL and paste it into your browser.
  6. Select your personal server (or any server you share with the bot) to invite the bot.
  7. Once the bot is in a shared server, you can right-click the bot and select Message to start a DM conversation.

Step 4: Configure the Adapter

The adapter requires a configuration file with your bot token and user ID. You can generate a template configuration file by running the init command:

npx clawmini-adapter-discord init

This will create a config.json file at .clawmini/adapters/discord/config.json. Open this file and replace the placeholders with your actual bot token and user ID:

{
  "botToken": "YOUR_DISCORD_BOT_TOKEN",
  "authorizedUserId": "YOUR_DISCORD_USER_ID",
  "chatId": "default",
  "requireMention": false
}

(Note: chatId defaults to "default". You can change this if you want the bot to associate with a different chat. requireMention defaults to false and can be set to true if you only want the bot to respond when explicitly mentioned).

Step 5: Start the Adapter

Ensure the Clawmini daemon is running, then start the Discord adapter:

npx clawmini-adapter-discord

The adapter will now forward authorized Discord DM messages to your Clawmini daemon and vice versa.

Routing and Creating Chats

By default, the adapter connects to a single chat (the one specified as chatId in your config.json). However, you can create new Discord channels (or use different DMs) to map to separate Clawmini chats.

  1. Create a new Text Channel in your Discord server (or open a new DM group).
  2. Invite the bot to the channel if necessary.
  3. Send the command /agent [agent-id] to automatically create a new Clawmini chat with that agent and map it to the current Discord channel.
  4. Alternatively, use /chat [chat-id] to map that specific Discord channel to an existing Clawmini chat.

Note: Each Discord channel can only be mapped to one Clawmini chat, and each Clawmini chat can only be mapped to one channel/space across all adapters.