SDK for creating Aurora Melody plugins - generate melodies with Python
Project description
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
.amlwithaurora-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-pluginand drag.amlinto 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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file aurora_melody_sdk-1.0.1.tar.gz.
File metadata
- Download URL: aurora_melody_sdk-1.0.1.tar.gz
- Upload date:
- Size: 26.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
49fb0809284d0ae8d251958ff549cffcef1cb74b90a95bfc411025eb1973f734
|
|
| MD5 |
0981bca88c6742164d1d3646ebbec900
|
|
| BLAKE2b-256 |
ca540171c465d2fa951d0f4f6103aebb26adb92ae03090c9e71b434a2d36d3d0
|
File details
Details for the file aurora_melody_sdk-1.0.1-py3-none-any.whl.
File metadata
- Download URL: aurora_melody_sdk-1.0.1-py3-none-any.whl
- Upload date:
- Size: 25.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e55b5a21cd1e38e76837bdb28177c4d6efc18194c4d5ba21a67c84178641f831
|
|
| MD5 |
3c7480a15d200ed397d1b1a13f3c91af
|
|
| BLAKE2b-256 |
933f5b80878eb7e8f58edb9296688013160f7cc226b1b802e7430816e3cefc2c
|