Aurora Melody SDK

Python SDK for building .aml generator plugins for the Aurora Melody application (Standalone + Plugin).

Installation

pip install aurora-melody-sdk

Package name on PyPI is aurora-melody-sdk.
Import path in code is aurora_melody_sdk.

What You Build

With this SDK, developers can:

• create plugin classes that generate MIDI notes
• define plugin controls and metadata
• package plugin folders into .aml with aurora-pack
• ship plugins that run in Aurora Melody

Quick Example

from aurora_melody_sdk import AuroraPlugin


class MyPlugin(AuroraPlugin):
    name = "My Plugin"
    author = "Your Name"
    version = "1.0.0"

    def generate(self, context):
        return {
            "succeeded": True,
            "notes": [
                {
                    "noteNumber": 60,
                    "startBeat": 0.0,
                    "lengthBeats": 1.0,
                    "velocity": 100,
                    "channel": 1,
                }
            ],
            "applyMode": "Replace",
        }

User Paths

Basic Users

• use example plugins as a template
• edit parameters and note logic
• run aurora-pack ./my-plugin and drag .aml into Aurora Melody

Advanced Users

• build custom controls and AI-service backed plugins
• vendor third-party dependencies into plugin packages
• design complex generation pipelines and apply modes

Documentation

• Full SDK implementation guide: docs/AURORA-MELODY-SDK-GUIDE.md
• Plugin runtime contract: docs/PLUGIN-DEVELOPER-GUIDE.md
• Example plugins: aurora-melody-sdk/examples/

License

MIT - see LICENSE.