@elizaos/plugin-discord 1.0.0-alpha.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Shaw Walters, aka Moon aka @lalalune
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,102 @@
+# @elizaos/client-discord
+
+A Discord client implementation for ElizaOS, enabling rich integration with Discord servers for managing interactions, voice, and message handling.
+
+## 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.
+
+## Installation
+
+As this is a workspace package, it's installed as part of the ElizaOS monorepo:
+
+```bash
+pnpm install
+```
+
+## Configuration
+
+The client requires the following environment variables:
+
+```bash
+# Discord API Credentials
+DISCORD_APPLICATION_ID=your_application_id
+DISCORD_API_TOKEN=your_api_token
+
+# Optional Settings (add any additional details here if necessary)
+```
+
+## Usage
+
+### Basic Initialization
+
+```typescript
+import { DiscordClientInterface } from '@elizaos/client-discord';
+
+// Initialize the client
+const discordManager = await DiscordClientInterface.start(runtime);
+```
+
+### Slash Command Registration
+
+To register slash commands:
+
+```typescript
+await discordManager.command.registerCommands([
+  {
+    name: 'example',
+    description: 'An example slash command',
+    options: []
+  }
+]);
+```
+
+### Handling Messages
+
+```typescript
+// Listen for new messages
+await discordManager.message.handleNewMessage({
+  channelId: 'channel-id',
+  content: 'Hello Discord!'
+});
+```
+
+### Managing Voice Events
+
+```typescript
+// Join a voice channel
+await discordManager.voice.joinChannel('channel-id');
+
+// Handle voice interactions
+await discordManager.voice.handleInteraction({
+  userId: 'user-id',
+  action: 'speak'
+});
+```
+
+## Key Components
+
+1. **ClientBase**
+    - Handles authentication and session management.
+    - Manages websocket connections.
+
+2. **MessageManager**
+    - Processes incoming messages and responses.
+    - Supports message formatting and templating.
+
+3. **VoiceManager**
+    - Manages voice interactions and events.
+    - Handles joining and leaving voice channels.
+
+4. **CommandManager**
+    - Registers and processes slash commands.
+    - Ensures permissions are validated.
+
+## 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.

package/dist/index.d.ts

@@ -0,0 +1,91 @@
+import { Media, Character, IAgentRuntime, ChannelType, UUID, Plugin, Service } from '@elizaos/core';
+import { Message, Client, Channel, VoiceState, BaseGuildVoiceChannel, Guild, OAuth2Guild, MessageReaction, User } from 'discord.js';
+import { VoiceConnection, AudioPlayer } from '@discordjs/voice';
+import { EventEmitter } from 'node:events';
+import { Readable } from 'node:stream';
+
+declare class MessageManager {
+    private client;
+    private runtime;
+    private attachmentManager;
+    private getChannelType;
+    constructor(discordClient: any);
+    handleMessage(message: Message): Promise<void>;
+    processMessage(message: Message): Promise<{
+        processedContent: string;
+        attachments: Media[];
+    }>;
+    fetchBotName(botToken: string): Promise<string>;
+}
+
+interface IDiscordService {
+    client: Client;
+    character: Character;
+}
+
+declare class VoiceManager extends EventEmitter {
+    private processingVoice;
+    private transcriptionTimeout;
+    private userStates;
+    private activeAudioPlayer;
+    private client;
+    private runtime;
+    private streams;
+    private connections;
+    private activeMonitors;
+    private ready;
+    constructor(service: DiscordService, runtime: IAgentRuntime);
+    getChannelType(channel: Channel): Promise<ChannelType>;
+    private setReady;
+    isReady(): boolean;
+    handleVoiceStateUpdate(oldState: VoiceState, newState: VoiceState): Promise<void>;
+    joinChannel(channel: BaseGuildVoiceChannel): Promise<void>;
+    getVoiceConnection(guildId: string): VoiceConnection;
+    private monitorMember;
+    leaveChannel(channel: BaseGuildVoiceChannel): void;
+    stopMonitoringMember(memberId: string): void;
+    debouncedProcessTranscription(entityId: UUID, name: string, userName: string, channel: BaseGuildVoiceChannel): Promise<void>;
+    handleUserStream(userId: UUID, name: string, userName: string, channel: BaseGuildVoiceChannel, audioStream: Readable): Promise<void>;
+    private processTranscription;
+    private handleMessage;
+    private convertOpusToWav;
+    scanGuild(guild: Guild): Promise<void>;
+    playAudioStream(entityId: UUID, audioStream: Readable): Promise<void>;
+    cleanupAudioPlayer(audioPlayer: AudioPlayer): void;
+    handleJoinChannelCommand(interaction: any): Promise<void>;
+    handleLeaveChannelCommand(interaction: any): Promise<void>;
+}
+
+declare class DiscordService extends Service implements IDiscordService {
+    static serviceType: string;
+    capabilityDescription: string;
+    client: Client;
+    character: Character;
+    messageManager: MessageManager;
+    voiceManager: VoiceManager;
+    constructor(runtime: IAgentRuntime);
+    ensureAllChannelsExist(runtime: IAgentRuntime, guild: OAuth2Guild): Promise<void>;
+    private setupEventListeners;
+    private handleGuildMemberAdd;
+    static start(runtime: IAgentRuntime): Promise<DiscordService>;
+    static stop(runtime: IAgentRuntime): Promise<void>;
+    stop(): Promise<void>;
+    private onClientReady;
+    getChannelType(channel: Channel): Promise<ChannelType>;
+    handleReactionAdd(reaction: MessageReaction, user: User): Promise<void>;
+    handleReactionRemove(reaction: MessageReaction, user: User): Promise<void>;
+    private handleGuildCreate;
+    private handleInteractionCreate;
+    /**
+     * Builds a standardized list of rooms from Discord guild channels
+     */
+    private buildStandardizedRooms;
+    /**
+     * Builds a standardized list of users from Discord guild members
+     */
+    private buildStandardizedUsers;
+    private onReady;
+}
+declare const discordPlugin: Plugin;
+
+export { DiscordService, discordPlugin as default };