@elizaos/plugin-discord 1.0.6 → 1.0.8

package/README.md

@@ -4,12 +4,18 @@ A Discord plugin implementation for ElizaOS, enabling rich integration with Disc
 
 ## Features
 
-- Handle server join events and manage initial configurations.
-- Voice event management via the voice manager.
-- Manage and process new messages with the message manager.
-- Slash command registration and interaction handling.
-- Disconnect websocket and unbind all listeners when required.
-- Robust permissions management for bot functionality.
+- Handle server join events and manage initial configurations
+- Voice event management via the voice manager
+- Manage and process new messages with the message manager
+- Slash command registration and interaction handling
+- Support for Discord attachments and media files
+- Voice channel join/leave functionality
+- Conversation summarization
+- Media transcription capabilities
+- Channel state and voice state providers
+- Channel restriction support (limit bot to specific channels)
+- Robust permissions management for bot functionality
+- Event-driven architecture with comprehensive event handling
 
 ## Installation
 
@@ -24,7 +30,7 @@ bun install
 The plugin requires the following environment variables:
 
 ```bash
-# Discord API Credentials
+# Discord API Credentials (Required)
 DISCORD_APPLICATION_ID=your_application_id
 DISCORD_API_TOKEN=your_api_token
 
@@ -36,73 +42,75 @@ CHANNEL_IDS=123456789012345678,987654321098765432
 
 ## Usage
 
-### Basic Initialization
-
-```typescript
-import { DiscordClientInterface } from '@elizaos/client-discord';
-
-// Initialize the client
-const discordManager = await DiscordClientInterface.start(runtime);
+```json
+const character = {
+   "plugins": [
+      ...otherPlugins,
+      "@elizaos/plugin-discord"
+   ]
+}
 ```
 
-### Slash Command Registration
+### Available Actions
 
-To register slash commands:
+The plugin provides the following actions:
 
-```typescript
-await discordManager.command.registerCommands([
-  {
-    name: 'example',
-    description: 'An example slash command',
-    options: [],
-  },
-]);
-```
+1. **chatWithAttachments** - Handle messages with Discord attachments
+2. **downloadMedia** - Download media files from Discord messages
+3. **joinVoice** - Join a voice channel
+4. **leaveVoice** - Leave a voice channel
+5. **summarize** - Summarize conversation history
+6. **transcribeMedia** - Transcribe audio/video media to text
 
-### Handling Messages
+### Providers
 
-```typescript
-// Listen for new messages
-await discordManager.message.handleNewMessage({
-  channelId: 'channel-id',
-  content: 'Hello Discord!',
-});
-```
+The plugin includes two state providers:
 
-### Managing Voice Events
+1. **channelStateProvider** - Provides state information about Discord channels
+2. **voiceStateProvider** - Provides state information about voice channels
 
-```typescript
-// Join a voice channel
-await discordManager.voice.joinChannel('channel-id');
+### Event Types
 
-// Handle voice interactions
-await discordManager.voice.handleInteraction({
-  userId: 'user-id',
-  action: 'speak',
-});
-```
+The plugin emits the following Discord-specific events:
 
-## Key Components
+- `GUILD_MEMBER_ADD` - When a new member joins a guild
+- `GUILD_CREATE` - When the bot joins a guild
+- `MESSAGE_CREATE` - When a message is created
+- `INTERACTION_CREATE` - When an interaction is created
+- `REACTION_RECEIVED` - When a reaction is added to a message
 
-1. **ClientBase**
+## Key Components
 
-   - Handles authentication and session management.
-   - Manages websocket connections.
+1. **DiscordService**
+   - Main service class that extends ElizaOS Service
+   - Handles authentication and session management
+   - Manages Discord client connection
+   - Processes events and interactions
 
 2. **MessageManager**
-
-   - Processes incoming messages and responses.
-   - Supports message formatting and templating.
+   - Processes incoming messages and responses
+   - Handles attachments and media files
+   - Supports message formatting and templating
+   - Manages conversation context
 
 3. **VoiceManager**
+   - Manages voice channel interactions
+   - Handles joining and leaving voice channels
+   - Processes voice events and audio streams
+   - Integrates with transcription services
+
+4. **Attachment Handler**
+   - Downloads and processes Discord attachments
+   - Supports various media types
+   - Integrates with media transcription
 
-   - Manages voice interactions and events.
-   - Handles joining and leaving voice channels.
+## Testing
 
-4. **CommandManager**
-   - Registers and processes slash commands.
-   - Ensures permissions are validated.
+The plugin includes a test suite (`DiscordTestSuite`) for validating functionality.
 
 ## Notes
 
-Ensure that your `.env` file includes the required environment variables for proper functionality. Additional features or modules can be extended as part of the ElizaOS framework.
+- Ensure that your `.env` file includes the required `DISCORD_API_TOKEN` for proper functionality
+- The bot requires appropriate Discord permissions to function correctly (send messages, connect to voice channels, etc.)
+- If no token is provided, the plugin will load but remain non-functional with appropriate warnings
+- The plugin uses Discord.js v14.18.0 with comprehensive intent support

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elizaos/plugin-discord",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "type": "module",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -55,5 +55,9 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "646c632924826e2b75c2304a75ee56959fe4a460"
+  "gitHead": "646c632924826e2b75c2304a75ee56959fe4a460",
+  "agentConfig": {
+    "pluginType": "elizaos:plugin:1.0.0",
+    "pluginParameters": {}
+  }
 }