docs: updated README.md

This commit is contained in:
Xiaohan-Tian
2026-01-17 14:02:49 -08:00
parent e8b79efde7
commit 8c1ab53f25
+4 -3
View File
@@ -48,7 +48,7 @@ This project investigates how AI-human collaboration can enhance creative music-
- Click here to start using the app online: [K.G.Studio (kgaudiolab.github.io/kgstudio)](https://kgaudiolab.github.io/kgstudio) - Click here to start using the app online: [K.G.Studio (kgaudiolab.github.io/kgstudio)](https://kgaudiolab.github.io/kgstudio)
- [Click here to get a free OpenRouter API Key](https://openrouter.ai/keys) (you may need an OpenRouter account). - [Click here to get a free OpenRouter API Key](https://openrouter.ai/keys) (you may need an OpenRouter account).
- In **Settings ⚙️ → General → LLM Provider**, select **OpenAI Compatible**. - In **Settings ⚙️ → General → LLM Provider**, select **OpenAI Compatible**.
- In **OpenAI Compatible Server → Key**, paste your key. (Note: on nonlocalhost, your key isnt persisted; youll reenter it after refresh the page. Keep it safe.) - In **OpenAI Compatible Server → Key**, paste your key. (Note: on nonlocalhost, your key isn't persisted by default for security; you can enable "Persist API Keys on Non-Localhost" in Settings to persist them, though this may increase XSS risk.)
- In **OpenAI Compatible Server → Model**, enter `qwen/qwen3-30b-a3b:free` or `qwen/qwen3-235b-a22b:free`. (Note: these are free models [qwen3-30b-a3b](https://openrouter.ai/qwen/qwen3-30b-a3b:free) and [qwen3-235b-a22b](https://openrouter.ai/qwen/qwen3-235b-a22b:free); nonfree models may require billing; some model providers may retain your data, check their privacy policies; this project is not affiliated with OpenRouter or any model provider.) - In **OpenAI Compatible Server → Model**, enter `qwen/qwen3-30b-a3b:free` or `qwen/qwen3-235b-a22b:free`. (Note: these are free models [qwen3-30b-a3b](https://openrouter.ai/qwen/qwen3-30b-a3b:free) and [qwen3-235b-a22b](https://openrouter.ai/qwen/qwen3-235b-a22b:free); nonfree models may require billing; some model providers may retain your data, check their privacy policies; this project is not affiliated with OpenRouter or any model provider.)
- In **OpenAI Compatible Server → Base URL**, enter `https://openrouter.ai/api/v1/chat/completions`. - In **OpenAI Compatible Server → Base URL**, enter `https://openrouter.ai/api/v1/chat/completions`.
@@ -110,6 +110,7 @@ K.G.Studio loads defaults from `./public/config.json` (with an internal fallback
- **General** - **General**
- LLM provider: OpenAI, or OpenAIcompatible - LLM provider: OpenAI, or OpenAIcompatible
- API keys and models for the selected provider - API keys and models for the selected provider
- Persist API Keys on Non-Localhost: Enable to persist API keys on non-localhost environments (security opt-in, not recommended for shared/production environments)
- OpenAIcompatible base URL (for selfhosted gateways) - OpenAIcompatible base URL (for selfhosted gateways)
- Soundfont base URL (CDN for instrument samples) - Soundfont base URL (CDN for instrument samples)
- **Behavior** - **Behavior**
@@ -125,7 +126,7 @@ K.G.Studio loads defaults from `./public/config.json` (with an internal fallback
- Downloading instrument sound samples from the configured soundfont CDN - Downloading instrument sound samples from the configured soundfont CDN
- Communicating with the LLM provider you select (e.g., OpenAI or OpenAIcompatible services) - Communicating with the LLM provider you select (e.g., OpenAI or OpenAIcompatible services)
- Outside of the two cases above, the app functions locally. If you block those endpoints, the app still loads; instrument playback and AI features will not function until network access is restored. - Outside of the two cases above, the app functions locally. If you block those endpoints, the app still loads; instrument playback and AI features will not function until network access is restored.
- For security, when running from a nonlocal host we do not persist your API key in IndexedDB (to reduce XSS risk). Youll be prompted to enter it each time you start K.G.Studio. - For security, when running from a nonlocal host we do not persist your API key in IndexedDB by default (to reduce XSS risk). You'll be prompted to enter it each time you start K.G.Studio. To optin to persistence on nonlocal hosts, enable "Persist API Keys on Non-Localhost" in Settings (not recommended for shared/production environments).
## Using the App ## Using the App
@@ -223,7 +224,7 @@ OpenRouter is a platform that provides unified access to a wide range of languag
Currently, based on our evaluation, OpenAIs opensource models (`gptoss20b` and `gptoss120b`) are not yet compatible with the current agent implementation; support is planned. Currently, based on our evaluation, OpenAIs opensource models (`gptoss20b` and `gptoss120b`) are not yet compatible with the current agent implementation; support is planned.
For security, when using K.G.Studio from a nonlocal host, API keys are not persisted in IndexedDB; you will need to input your API key each time you start K.G.Studio. For security, when using K.G.Studio from a nonlocal host, API keys are not persisted in IndexedDB by default; you will need to input your API key each time you start K.G.Studio. To optin to persistence on nonlocal hosts, enable "Persist API Keys on Non-Localhost" in Settings (not recommended for shared/production environments).
K.G.Studio does not provide or host any of the models listed above, nor is it affiliated with any model provider. All data is stored locally on your device; K.G.Studio does not collect or transmit your data. You are solely responsible for any data you provide to thirdparty model providers. K.G.Studio does not provide or host any of the models listed above, nor is it affiliated with any model provider. All data is stored locally on your device; K.G.Studio does not collect or transmit your data. You are solely responsible for any data you provide to thirdparty model providers.