Skip to content

CHANGELOG.md

Latest commit

 

History

History
92 lines (73 loc) · 2.88 KB

CHANGELOG.md

File metadata and controls

92 lines (73 loc) · 2.88 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

Planned

  • Real-time model loading/unloading
  • Stem separation support
  • MIDI output functionality
  • Cloud generation option
  • Marketplace release preparation

[1.0.0] - 2024-XX-XX

Added

  • Initial plugin structure for UE5.3+
  • Core music generation module (UE5PMGCore)
  • Editor tools and UI (UE5PMGEditor)
  • Machine learning inference module (UE5PMGML)
  • Blueprint function library (UE5PMGRuntime)
  • Adaptive music component for gameplay integration
  • Text-to-music generation via ONNX models
  • Audio processing utilities (normalization, fades, mixing)
  • Python ML training scripts
    • LoRA training for MusicGen
    • ONNX export functionality
    • Dataset preprocessing tools
  • Comprehensive documentation
  • Unit tests for core functionality
  • Example content and tutorials

Core Features

  • Music Generation: Generate music from text prompts using AI
  • Blueprint Integration: Easy-to-use Blueprint nodes
  • C++ API: Full C++ API for advanced users
  • Adaptive Music: Dynamic music that responds to gameplay
  • Audio Processing: Built-in audio effects and mixing
  • Model Support: MusicGen small, medium, and large models
  • LoRA Training: Custom model fine-tuning support
  • ONNX Inference: Local, offline music generation

Modules

  • UE5PMGCore: Core music generation and audio processing
  • UE5PMGEditor: Editor-only tools and UI
  • UE5PMGML: ONNX model loading and inference
  • UE5PMGRuntime: Blueprint library and runtime components

Python Tools

  • train_musicgen_lora.py: LoRA model training
  • export_to_onnx.py: Model export to ONNX format
  • dataset_preprocessor.py: Audio dataset preprocessing

Documentation

  • Complete README with quick start guide
  • ML training workflow documentation
  • API reference documentation
  • Troubleshooting guide
  • Example projects and tutorials

Known Issues

  • Model loading requires UE5's NeuralNetworkInference plugin
  • Large models may cause memory issues on GPUs with <8GB VRAM
  • Initial generation latency due to model loading

[0.1.0] - 2024-XX-XX

Added

  • Project scaffolding and initial structure
  • Basic module setup
  • Development environment configuration

Version History

Version Naming Convention

  • Major.Minor.Patch (e.g., 1.0.0)
  • Major: Breaking changes, major feature releases
  • Minor: New features, backward compatible
  • Patch: Bug fixes, minor improvements

Release Tags

  • v1.0.0 - First stable release
  • v0.1.0 - Initial development version

Note: This changelog will be updated as the project develops. Check the Releases page for downloadable versions.