@elizaos/plugin-suno 0.1.9

package/.turbo/turbo-build.log

@@ -0,0 +1,23 @@
+
+
+> @elizaos/plugin-suno@0.1.9 build /Users/Shakker/WorkSpace/ShakkerNerd/ai16z/eliza/packages/plugin-suno
+> tsup
+
+CLI Building entry: src/index.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v7.3.0
+CLI Using tsup config: /Users/Shakker/WorkSpace/ShakkerNerd/ai16z/eliza/packages/plugin-suno/tsup.config.ts
+CLI Target: es2020
+CLI Cleaning output folder
+CJS Build start
+ESM Build start
+CJS dist/index.js     12.09 KB
+CJS dist/index.js.map 24.46 KB
+CJS ⚡️ Build success in 17ms
+ESM dist/index.mjs     11.00 KB
+ESM dist/index.mjs.map 24.40 KB
+ESM ⚡️ Build success in 18ms
+DTS Build start
+DTS ⚡️ Build success in 1587ms
+DTS dist/index.d.ts  878.00 B
+DTS dist/index.d.mts 878.00 B

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,207 @@
+@elizaos/plugin-suno
+
+A Suno AI music generation plugin for ElizaOS that enables AI-powered music creation and audio manipulation.
+
+OVERVIEW
+
+The Suno plugin integrates Suno AI's powerful music generation capabilities into ElizaOS, providing a seamless way to:
+- Generate music from text prompts with fine-tuned parameters
+- Create custom music with advanced control over style, tempo, and key
+- Extend existing audio tracks
+
+Original Plugin: https://github.com/gcui-art/suno-api?tab=readme-ov-file
+
+INSTALLATION
+
+    npm install @elizaos/plugin-suno
+
+QUICK START
+
+1. Register the plugin with ElizaOS:
+
+    import { sunoPlugin } from '@elizaos/plugin-suno';
+    import { Eliza } from '@elizaos/core';
+
+    const eliza = new Eliza();
+    eliza.registerPlugin(sunoPlugin);
+
+2. Configure the Suno provider with your API credentials:
+
+    import { sunoProvider } from '@elizaos/plugin-suno';
+
+    sunoProvider.configure({
+      apiKey: 'your-suno-api-key'
+    });
+
+FEATURES
+
+1. Generate Music (suno.generate-music)
+   Generate music using a text prompt with basic control parameters. This is ideal for quick music generation when you need less fine-grained control:
+
+   - Simple text-to-music generation
+   - Consistent output quality with default parameters
+   - Suitable for most common use cases
+
+    await eliza.execute('suno.generate-music', {
+      prompt: "An upbeat electronic dance track with energetic beats",
+      duration: 30,
+      temperature: 1.0,
+      topK: 250,
+      topP: 0.95,
+      classifier_free_guidance: 3.0
+    });
+
+2. Custom Music Generation (suno.custom-generate-music)
+   Create music with detailed control over generation parameters. Perfect for when you need precise control over the musical output:
+
+   - Fine-grained control over musical style and structure
+   - Reference-based generation using existing audio
+   - Control over musical attributes:
+     * Style: Specify genres like "classical", "electronic", "rock"
+     * Tempo: Set exact BPM (beats per minute)
+     * Key and Mode: Define musical key (e.g., "C") and mode ("major"/"minor")
+   - Advanced parameter tuning for generation quality
+
+    await eliza.execute('suno.custom-generate-music', {
+      prompt: "A melodic piano piece with soft strings",
+      duration: 30,
+      temperature: 0.8,
+      topK: 250,
+      topP: 0.95,
+      classifier_free_guidance: 3.0,
+      reference_audio: "path/to/reference.mp3",
+      style: "classical",
+      bpm: 120,
+      key: "C",
+      mode: "major"
+    });
+
+3. Extend Audio (suno.extend-audio)
+   Extend existing audio tracks to create longer compositions. Useful for:
+
+   - Lengthening existing music pieces
+   - Creating seamless loops
+   - Generating variations of existing tracks
+
+    await eliza.execute('suno.extend-audio', {
+      audio_id: "your-audio-id",
+      duration: 60
+    });
+
+Generation Parameters Explained:
+
+- temperature: Controls randomness in generation (0.0-1.0+)
+  * Lower values (0.1-0.5): More conservative, consistent output
+  * Higher values (1.0+): More creative, varied output
+
+- classifier_free_guidance: Controls how closely the output follows the prompt (1.0-20.0)
+  * Lower values: More creative interpretation
+  * Higher values: Stricter adherence to prompt
+
+- topK/topP: Control the diversity of the generation
+  * topK: Limits the number of tokens considered
+  * topP: Controls the cumulative probability threshold
+
+API REFERENCE
+
+SunoProvider Configuration
+The Suno provider accepts the following configuration options:
+
+    interface SunoConfig {
+      apiKey: string;
+    }
+
+Action Parameters:
+
+1. Generate Music (suno.generate-music)
+    interface GenerateParams {
+      prompt: string;
+      duration?: number;        // Duration in seconds
+      temperature?: number;     // Controls randomness
+      topK?: number;           // Top K sampling
+      topP?: number;           // Top P sampling
+      classifier_free_guidance?: number; // Guidance scale
+    }
+
+2. Custom Generate Music (suno.custom-generate-music)
+    interface CustomGenerateParams {
+      prompt: string;
+      duration?: number;
+      temperature?: number;
+      topK?: number;
+      topP?: number;
+      classifier_free_guidance?: number;
+      reference_audio?: string; // Path to reference audio file
+      style?: string;          // Musical style
+      bpm?: number;            // Beats per minute
+      key?: string;            // Musical key
+      mode?: string;           // Musical mode (e.g., "major", "minor")
+    }
+
+3. Extend Audio (suno.extend-audio)
+    interface ExtendParams {
+      audio_id: string;        // ID of the audio to extend
+      duration: number;        // Additional duration in seconds
+    }
+
+Response Type:
+    interface GenerationResponse {
+      id: string;             // Generated audio ID
+      status: string;         // Status of the generation
+      url?: string;          // URL to download the generated audio
+      error?: string;        // Error message if generation failed
+    }
+
+ERROR HANDLING
+
+The plugin includes built-in error handling for common scenarios:
+
+    try {
+      await eliza.execute('suno.generate', params);
+    } catch (error) {
+      if (error.code === 'SUNO_API_ERROR') {
+        // Handle API-specific errors
+      }
+      // Handle other errors
+    }
+
+EXAMPLES
+
+Creating a Pop Song:
+
+    const result = await eliza.execute('suno.generate-music', {
+      prompt: "Create a pop song with vocals, drums, and guitar",
+      duration: 180,
+      temperature: 1.0,
+      classifier_free_guidance: 3.5
+    });
+
+Creating a Custom Classical Piece:
+
+    const result = await eliza.execute('suno.custom-generate-music', {
+      prompt: "A classical piano sonata in the style of Mozart",
+      duration: 120,
+      temperature: 0.8,
+      style: "classical",
+      bpm: 120,
+      key: "C",
+      mode: "major"
+    });
+
+Extending an Existing Track:
+
+    const extended = await eliza.execute('suno.extend-audio', {
+      audio_id: "existing-track-id",
+      duration: 60
+    });
+
+LICENSE
+
+MIT
+
+SUPPORT
+
+For issues and feature requests, please open an issue on our GitHub repository.
+
+---
+Built with ❤️ for ElizaOS

package/dist/index.d.mts

@@ -0,0 +1,26 @@
+import { Action, Provider, IAgentRuntime, Memory, State, Plugin } from '@elizaos/core';
+
+declare const generateMusic: Action;
+
+declare const customGenerateMusic: Action;
+
+declare const extendAudio: Action;
+
+interface SunoConfig {
+    apiKey: string;
+    baseUrl?: string;
+}
+declare class SunoProvider implements Provider {
+    private apiKey;
+    private baseUrl;
+    static get(runtime: IAgentRuntime, _message: Memory, _state?: State): Promise<SunoProvider>;
+    constructor(config: SunoConfig);
+    get(_runtime: IAgentRuntime, _message: Memory, _state?: State): Promise<{
+        status: string;
+    }>;
+    request(endpoint: string, options?: RequestInit): Promise<any>;
+}
+
+declare const sunoPlugin: Plugin;
+
+export { customGenerateMusic as CustomGenerateMusic, extendAudio as ExtendAudio, generateMusic as GenerateMusic, SunoProvider, sunoPlugin as default, sunoPlugin };

package/dist/index.d.ts

@@ -0,0 +1,26 @@
+import { Action, Provider, IAgentRuntime, Memory, State, Plugin } from '@elizaos/core';
+
+declare const generateMusic: Action;
+
+declare const customGenerateMusic: Action;
+
+declare const extendAudio: Action;
+
+interface SunoConfig {
+    apiKey: string;
+    baseUrl?: string;
+}
+declare class SunoProvider implements Provider {
+    private apiKey;
+    private baseUrl;
+    static get(runtime: IAgentRuntime, _message: Memory, _state?: State): Promise<SunoProvider>;
+    constructor(config: SunoConfig);
+    get(_runtime: IAgentRuntime, _message: Memory, _state?: State): Promise<{
+        status: string;
+    }>;
+    request(endpoint: string, options?: RequestInit): Promise<any>;
+}
+
+declare const sunoPlugin: Plugin;
+
+export { customGenerateMusic as CustomGenerateMusic, extendAudio as ExtendAudio, generateMusic as GenerateMusic, SunoProvider, sunoPlugin as default, sunoPlugin };