Skip to content

docs

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History
 
 

docs

README.md

APC Documentation

Welcome to the comprehensive documentation for Audio Plugin Coder (APC) - the AI-powered framework for building professional audio plugins.

Quick Start

New to APC? Start here:

  1. Project Overview - What is APC and key features
  2. Plugin Development Lifecycle - The five-phase workflow
  3. Command Reference - All available commands
  4. FAQ - Common questions answered

Documentation Index

Getting Started

Document Description
Project Structure Complete directory layout and file organization
Plugin Development Lifecycle Detailed guide to all five phases
Command Reference All slash commands and PowerShell scripts
FAQ Frequently asked questions

Core Concepts

Document Description
State Management Deep Dive How APC tracks and manages project state
Build System CMake configuration and build scripts
WebView Framework Building plugins with HTML/CSS/JS UIs

Workflows & Processes

Document Description
Ship Workflow Packaging and distribution process
GitHub Actions CI/CD for cross-platform builds
Icon Management Adding icons to plugins
Installer Creation Creating platform installers

Troubleshooting & Support

Document Description
Troubleshooting Guide Common issues and solutions
Known Issues Database of known problems

Reference

Document Location Description
Agent Rules .agent/rules/agent.md Critical rules for AI agents
File Naming .agent/rules/file-naming-conventions.md Naming conventions
JUCE Protocols .agent/rules/juce-build-protocols.md Build system rules
State Guide .agent/guides/state-management-guide.md State management guide
WebView Templates .agent/templates/webview/ Starter templates

The Five-Phase Workflow

APC uses a structured workflow for plugin development:

💭 DREAM → 📋 PLAN → 🎨 DESIGN → 💻 IMPLEMENT → 🚀 SHIP
Phase Command Output
DREAM /dream MyPlugin Concept + Parameters
PLAN /plan MyPlugin Architecture + Framework
DESIGN /design MyPlugin UI Specifications
IMPLEMENT /impl MyPlugin Working Code
SHIP /ship MyPlugin Distribution Package

Learn more: Plugin Development Lifecycle

Common Commands

Slash Commands (AI Agent)

/dream MyPlugin      # Start new plugin
/plan MyPlugin       # Define architecture
/design MyPlugin     # Create UI design
/impl MyPlugin       # Implement code
/ship MyPlugin       # Package and distribute
/status MyPlugin     # Check progress
/resume MyPlugin     # Continue development
/test MyPlugin       # Run validation
/debug MyPlugin      # Debug issues

PowerShell Scripts

# Build plugin
powershell -ExecutionPolicy Bypass -File .\scripts\build-and-install.ps1 -PluginName MyPlugin

# Validate setup
.\scripts\validate-plugin-status.ps1 -PluginName MyPlugin

# Check system
.\scripts\system-check.ps1

Full reference: Command Reference

UI Frameworks

APC supports two UI frameworks:

WebView (HTML/CSS/JS)

  • Modern web technologies
  • Fast iteration with hot reload
  • Rich visualizations
  • Best for: Complex UIs, real-time graphics

Learn more: WebView Framework Guide

Visage (Pure C++)

  • Native C++ UI via Visage frames
  • Maximum performance
  • Full C++ control
  • Best for: Simple UIs, performance-critical plugins

Note: Visage integration is in active testing and may be unstable on some hosts.

Platform Support

Platform Local Build GitHub Actions Formats
Windows 11 ✅ Native ✅ VST3, Standalone
macOS ❌ ✅ VST3, AU, Standalone
Linux ❌ ✅ VST3, LV2, Standalone

Project Structure

audio-plugin-coder/
├── .agent/              # AI agent configuration
│   ├── skills/             # Domain knowledge
│   ├── workflows/          # Slash commands
│   ├── rules/              # System constraints
│   └── troubleshooting/    # Known issues
├── _tools/                 # JUCE, pluginval
├── docs/                   # This documentation
├── plugins/                # Your plugins
├── scripts/                # Build automation
└── build/                  # Build artifacts

Learn more: Project Structure

State Management

Every plugin has a status.json file that tracks:

  • Current development phase
  • UI framework selection
  • Validation checkpoints
  • Error recovery points

This enables:

  • Resume development anytime
  • Switch AI agents without losing context
  • Automatic prerequisite validation
  • Rollback capabilities

Learn more: State Management Deep Dive

Troubleshooting

Having issues? Check these resources:

  1. Troubleshooting Guide - Common problems and solutions
  2. Known Issues - Database of known problems
  3. Validation Scripts: 
    .\scripts\validate-plugin-status.ps1 -PluginName MyPlugin
.\scripts\validate-webview-setup.ps1 -PluginName MyPlugin

Contributing

Want to improve APC? See CONTRIBUTING.md for:

  • Adding new skills
  • Reporting bugs
  • Improving documentation
  • Testing on different platforms

External Resources

License

APC is licensed under the MIT License. See LICENSE for details.

Need help? Check the FAQ or review the troubleshooting guide.