3dtours/KGStudio
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

updated README.md.

Browse Source
This commit is contained in:
Xiaohan-Tian
2025-08-11 18:47:09 -07:00
parent de51967b49
commit 4ceadbd09c
1 changed files with 11 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+11 -5
View File
@@ -2,7 +2,7 @@
<img src="./public/logo.png" alt="K.G.Studio Logo" width="160" /> <img src="./public/logo.png" alt="K.G.Studio Logo" width="160" />
</div> </div>
## K.G.Studio — Browser-based DAW (Digital Audio Workstation) ## K.G.Studio — A Browser-based DAW with AI Assistant
K.G.Studio is a lightweight, modern DAW that runs entirely in the browser with **K.G.Studio Musician Assistant** at its core. It features realistic instrument playback via Tone.js samplers, a piano‑roll editor, track and region management with full undo/redo, project persistence to IndexedDB, a configurable settings panel, and an integrated AI assistant with tool execution. K.G.Studio is a lightweight, modern DAW that runs entirely in the browser with **K.G.Studio Musician Assistant** at its core. It features realistic instrument playback via Tone.js samplers, a piano‑roll editor, track and region management with full undo/redo, project persistence to IndexedDB, a configurable settings panel, and an integrated AI assistant with tool execution.
@@ -23,15 +23,19 @@ For a deeper technical overview, see `res/overview.md`.
## Getting Started ## Getting Started
### Prerequisites ### Start using the app online: [K.G.Studio (kgaudiolab.github.io/kgstudio)](https://kgaudiolab.github.io/kgstudio)
- Node.js 20.19.3+
### Install & Run ### Or clone and run locally:
```bash ```bash
git clone https://github.com/Xiaohan-Tian/KGSP {your-local-path} # Make sure you have Node.js >= 20.19.3 installed
# Clone the repository
git clone https://github.com/KGAudioLab/KGStudio {your-local-path}
cd {your-local-path} cd {your-local-path}
# Install dependencies
npm install npm install
# Run the development server
npm run dev npm run dev
``` ```
@@ -61,6 +65,8 @@ K.G.Studio loads defaults from `./public/config.json` (with an internal fallback
## Using the App ## Using the App
You can find the detailed user guide [here](./docs/USER_GUIDE.md).
1. Start the app and a default project will load. A default “Melody” MIDI track is ensured on load. 1. Start the app and a default project will load. A default “Melody” MIDI track is ensured on load.
2. Add tracks, rename and reorder them. Click or drag in the track grid to create and arrange regions. 2. Add tracks, rename and reorder them. Click or drag in the track grid to create and arrange regions.
3. Add a region by double‑clicking or holding Ctrl/Cmd and clicking. Drag the edges to resize a region; drag the center to move it. Use Ctrl/Cmd+C and Ctrl/Cmd+V to copy/paste regions. 3. Add a region by double‑clicking or holding Ctrl/Cmd and clicking. Drag the edges to resize a region; drag the center to move it. Use Ctrl/Cmd+C and Ctrl/Cmd+V to copy/paste regions.