Skip to content

README.md

Latest commit

 

History

History
68 lines (54 loc) · 2.79 KB

README.md

File metadata and controls

68 lines (54 loc) · 2.79 KB
Raw

ThreeVSCode

A 3D character that lives in your editor and speaks summaries of what Claude Code just did. Claude Code itself is the brain — there's no separate local LLM. Text-to-speech (Kokoro) runs fully client-side in the webview via WebGPU/WASM; nothing leaves your machine.

What it does

  • Opens a Companion panel by default, in the main editor area, showing the character. Opening a real file works normally alongside it.
  • Auto-launches an integrated terminal running claude on first open.
  • Installs UserPromptSubmit/Stop hooks into the current project's .claude/settings.local.json automatically the first time the extension activates — no manual setup step. A one-time notification confirms it if it can't (e.g. no folder open).
  • Streams Claude Code's responses to the character as they're written, sanitizing the markdown down to plain prose before speaking it.
  • The character isn't static: an autonomous idle head drift, breathing, arm sway, and a visor glow that pulses with live speech volume — recolor it live from the hamburger menu, and the choice is remembered across restarts.
  • Optional quiet background music, coordinated across multiple open VS Code windows so only one plays at a time, and unaffected by switching to another application.

Commands

  • ThreeVSCode: Open Character — reopen the Companion panel if you've closed it.
  • ThreeVSCode: Toggle Voice — mute/unmute without uninstalling the hook. Also available as a status bar item (bottom right).
  • ThreeVSCode: Restart Claude Terminal — force-recreate the terminal if claude died without the terminal pane itself closing.
  • ThreeVSCode: Enable Voice for Claude Code — manual re-run of the hook install, for troubleshooting; normal use doesn't need this.

Voice input

If you'd rather speak your prompts than type them, Sotto is a free, local-first dictation app (Windows/macOS) with a global hotkey that pastes the transcript at your cursor in any app — including the auto-launched Claude terminal. It's a separate, standalone tool (no API to integrate against), but works with this extension out of the box since its hotkey works everywhere.

Try it

npm install
npm run build

Then open this folder in VS Code and press F5 (or Run → Start Debugging). That launches an Extension Development Host window with the Companion panel open and a "Click to enable audio" prompt (a one-time click to satisfy the browser's audio-autoplay restriction).

npm run watch rebuilds on save if you're iterating.

Packaging

npx @vscode/vsce package

Produces an installable .vsix. Actually publishing to the Marketplace needs a publisher account (Azure DevOps + a Personal Access Token) set up separately — this only prepares the package.