Skip to content

Commit 2fa2f94

Browse files
committed
docs(readme): document AI Agent
1 parent 7b9831d commit 2fa2f94

1 file changed

Lines changed: 20 additions & 2 deletions

File tree

README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
# OpenStudio
1313

1414

15-
OpenStudio is a browser and desktop DAW built with React, Web Audio API, and Electron. It brings the core beatmaking workflow into one app: browse sounds, build patterns, edit melodies, arrange clips, mix tracks, save projects locally or in the cloud, and export the final track to WAV or MP3.
15+
OpenStudio is a browser and desktop DAW built with React, Web Audio API, and Electron. It brings the core beatmaking workflow into one app: browse sounds, build patterns, edit melodies, arrange clips, mix tracks, save projects locally or in the cloud, and export the final track to WAV or MP3. The built-in AI Agent helps shape your project, from melodies and drum patterns to instruments, mixer settings, clips, BPM, and FX.
1616
<br><br>
1717
![OpenStudio Preview](docs/media/openstudio-preview.gif)
1818

@@ -22,6 +22,7 @@ OpenStudio is a browser and desktop DAW built with React, Web Audio API, and Ele
2222
- [Why OpenStudio](#why-openstudio)
2323
- [Highlights](#highlights)
2424
- [Feature Overview](#feature-overview)
25+
- [AI Agent](#ai-agent)
2526
- [Themes](#themes)
2627
- [Built-in Instruments](#built-in-instruments)
2728
- [Screenshots](#screenshots)
@@ -52,6 +53,7 @@ It is a full interactive app rather than a static UI mockup, with multiple DAW w
5253
- Realtime sample playback, SoundFont instruments, mixer routing, meters, and built-in FX
5354
- Local `.os` project files plus Supabase-backed cloud saves, loading, overwrites, search, sorting, and deletion
5455
- Offline WAV / MP3 rendering through the same audio-domain timing logic used by playback
56+
- Built-in AI Agent with OpenAI/Gemini BYOK support, project-aware edit plans, Preview + Apply, and one-click plan undo
5557
- Runtime DAW themes with separate plugin styling for consistent built-in effect UIs
5658
- Electron desktop packaging from the same React/Web Audio codebase
5759

@@ -128,6 +130,19 @@ It is a full interactive app rather than a static UI mockup, with multiple DAW w
128130
- Load project window with cloud project search, sortable columns, local file loading, and delete confirmation
129131
- Cloud project files are stored in Supabase Storage while project metadata lives in a Supabase database table
130132

133+
## AI Agent
134+
135+
OpenStudio includes a built-in AI Agent for project-aware music production assistance. It can prepare editable plans for melodies, drum patterns, channels, instruments, mixer settings, playlist clips, BPM, chords, and FX.
136+
137+
The agent uses a Preview + Apply workflow: it proposes a validated operation list first, then you decide whether to apply it. Applied AI plans can be undone in one step.
138+
139+
AI provider support is bring-your-own-key:
140+
141+
- OpenAI
142+
- Gemini
143+
144+
API keys are used client-side and are only stored on the device when `Remember on this device` is enabled. Authenticated users can also keep Supabase-backed AI conversation history.
145+
131146
## Themes
132147

133148
OpenStudio includes a runtime theme system built around CSS custom-property tokens. DAW themes override the application shell, windows, browser, playlist, mixer, and controls, while plugin styling is kept separate so loaded FX keep a consistent interface across themes.
@@ -274,10 +289,12 @@ Installer artifacts are generated in `release/`.
274289
```text
275290
OpenStudio/
276291
|-- src/
292+
| |-- ai/ AI Agent prompts, provider clients, summaries, sample index, and operation validation
277293
| |-- audio/ realtime scheduling, mixer graph, export/render pipeline
278294
| | |-- core/ scheduler, mixer graph, playback nodes, voice helpers
279295
| | `-- domain/ pure audio/domain helpers for samples, stretch, FX params
280296
| |-- components/ DAW windows, editors, Browser, Mixer, Playlist, Piano Roll
297+
| | |-- ai-agent/ AI Agent chat, plan panel, conversation list, and controller hook
281298
| | |-- browser/ Packs and plugin browser trees
282299
| | |-- channel-rack/ Channel Rack rows, controls, step grid, piano preview
283300
| | |-- fx-plugin/ Graphic EQ, Reverb, Maximizer, FX editor utilities
@@ -305,8 +322,9 @@ OpenStudio/
305322
- `soundfont-player` - built-in SoundFont instrument playback
306323
- `@breezystack/lamejs` - MP3 encoding for rendered projects
307324
- Supabase Auth - account creation, sign in, and authenticated user sessions
308-
- PostgreSQL / Supabase Database - project metadata and user profile records
325+
- PostgreSQL / Supabase Database - project metadata, user profile records, and AI conversation history
309326
- Supabase Storage - cloud `.os` project file storage
327+
- OpenAI / Gemini APIs - optional BYOK AI Agent providers for project-aware edit plans
310328
- Vite 8 - dev server and production bundling
311329
- Electron 41 - desktop runtime for the Windows app
312330
- Electron Builder - unpacked desktop builds and NSIS installer packaging

0 commit comments

Comments
 (0)