klaudio 0.1.0 → 0.3.0

package/README.md

@@ -1,65 +1,67 @@
-# klaudio
-
-Add sound effects to your [Claude Code](https://docs.anthropic.com/en/docs/claude-code) sessions. Plays sounds when Claude finishes a task, sends a notification, and more.
-
-## Quick Start
-
-```bash
-npx klaudio
-```
-
-The interactive installer walks you through:
-
-1. **Choose scope** — install globally (`~/.claude`) or per-project (`.claude/`)
-2. **Pick a source** — use a built-in preset, scan your local games for sounds, or provide custom files
-3. **Preview & assign** — listen to sounds and assign them to events
-4. **Install** — writes Claude Code hooks to your `settings.json`
-
-## Sound Sources
-
-### Built-in Presets
-
-Ready-made sound packs (Retro 8-bit, Minimal Zen, Sci-Fi Terminal, Victory Fanfare) that work out of the box.
-
-### Game Sound Scanner
-
-Scans your Steam and Epic Games libraries for audio files:
-
-- Finds loose audio files (`.wav`, `.mp3`, `.ogg`, `.flac`, `.aac`)
-- Extracts packed audio (Wwise `.wem`, FMOD `.bank`, `.fsb`) using [vgmstream](https://vgmstream.org/) (downloaded automatically)
-- Parses Wwise metadata (`SoundbanksInfo.json`) for descriptive filenames
-- Categorizes sounds (voice, ambient, music, SFX, UI, creature) for easy browsing
-- Caches extracted sounds in `~/.klonk/cache/` for instant reuse
-
-### Custom Files
-
-Point to your own `.wav`/`.mp3` files.
-
-## Features
-
-- **Auto-preview** — sounds play automatically as you browse the list (toggle with `p`)
-- **Category filtering** — drill into voice, ambient, SFX, etc. when a game has enough variety
-- **Type-to-filter** — start typing to narrow down long lists
-- **10-second clamp** — long sounds are processed with ffmpeg: silence stripped, fade out baked in
-- **Background scanning** — game list updates live as directories are scanned
-- **Cross-platform** — Windows (PowerShell/ffplay), macOS (afplay/ffplay), Linux (aplay/ffplay)
-
-## Events
-
-| Event | Triggers when |
-|---|---|
-| Task Complete | Claude finishes a response |
-| Notification | Claude needs your attention |
-
-## Uninstall
-
-```bash
-npx klaudio --uninstall
-```
-
-## Requirements
-
-- Node.js 18+ (Claude Code already requires this)
-- [Claude Code](https://docs.anthropic.com/en/docs/claude-code) installed
-- For packed audio extraction: internet connection (vgmstream-cli is downloaded automatically)
-- For best playback with fade effects: [ffmpeg/ffplay](https://ffmpeg.org/) on PATH (falls back to native players)
+# klaudio
+
+Add sound effects to your [Claude Code](https://docs.anthropic.com/en/docs/claude-code) sessions. Plays sounds when Claude finishes a task, sends a notification, and more.
+
+## Quick Start
+
+```bash
+npx klaudio
+```
+
+The interactive installer walks you through:
+
+1. **Choose scope** — install globally (`~/.claude`) or per-project (`.claude/`)
+2. **Pick a source** — use a built-in preset, scan your local games for sounds, or provide custom files
+3. **Preview & assign** — listen to sounds and assign them to events
+4. **Install** — writes Claude Code hooks to your `settings.json`
+
+## Sound Sources
+
+### Built-in Presets
+
+Ready-made sound packs (Retro 8-bit, Minimal Zen, Sci-Fi Terminal, Victory Fanfare) that work out of the box.
+
+### Game Sound Scanner
+
+Scans your Steam and Epic Games libraries for audio files:
+
+- Finds loose audio files (`.wav`, `.mp3`, `.ogg`, `.flac`, `.aac`)
+- Extracts packed audio (Wwise `.wem`, FMOD `.bank`, `.fsb`) using [vgmstream](https://vgmstream.org/) (downloaded automatically)
+- Parses Wwise metadata (`SoundbanksInfo.json`) for descriptive filenames
+- Categorizes sounds (voice, ambient, music, SFX, UI, creature) for easy browsing
+- Caches extracted sounds in `~/.klonk/cache/` for instant reuse
+
+### Custom Files
+
+Point to your own `.wav`/`.mp3` files.
+
+## Features
+
+- **Auto-preview** — sounds play automatically as you browse the list (toggle with `p`)
+- **Category filtering** — drill into voice, ambient, SFX, etc. when a game has enough variety
+- **Type-to-filter** — start typing to narrow down long lists
+- **10-second clamp** — long sounds are processed with ffmpeg: silence stripped, fade out baked in
+- **Background scanning** — game list updates live as directories are scanned
+- **Cross-platform** — Windows (PowerShell/ffplay), macOS (afplay/ffplay), Linux (aplay/ffplay)
+
+## Events
+
+| Event | Triggers when |
+|---|---|
+| Task Complete | Claude finishes a response |
+| Notification | Claude needs your attention |
+
+## Uninstall
+
+```bash
+npx klaudio --uninstall
+```
+
+## Requirements
+
+- Node.js 18+ (Claude Code already requires this)
+- [Claude Code](https://docs.anthropic.com/en/docs/claude-code) installed
+- For packed audio extraction: internet connection (vgmstream-cli is downloaded automatically)
+- For best playback with fade effects: [ffmpeg/ffplay](https://ffmpeg.org/) on PATH (falls back to native players)
+
+> **Note:** Currently only tested on Windows. macOS and Linux support is planned but not yet verified.

package/package.json

@@ -1,40 +1,44 @@
-{
-  "name": "klaudio",
-  "version": "0.1.0",
-  "description": "Add sound effects to your coding sessions — play sounds when tasks complete, notifications arrive, and more",
-  "type": "module",
-  "bin": {
-    "klaudio": "./bin/cli.js"
-  },
-  "files": [
-    "bin/",
-    "src/",
-    "sounds/"
-  ],
-  "scripts": {
-    "generate-sounds": "node scripts/generate-sounds.js",
-    "start": "node bin/cli.js",
-    "build": "bun run build.js",
-    "build:all": "bun run build.js --all"
-  },
-  "keywords": [
-    "klonk",
-    "sounds",
-    "sfx",
-    "hooks",
-    "notifications",
-    "audio",
-    "claude-code",
-    "coding-tools"
-  ],
-  "license": "MIT",
-  "dependencies": {
-    "ink": "^6.8.0",
-    "ink-select-input": "^6.2.0",
-    "ink-spinner": "^5.0.0",
-    "react": "^19.2.4"
-  },
-  "engines": {
-    "node": ">=18"
-  }
-}
+{
+  "name": "klaudio",
+  "version": "0.3.0",
+  "description": "Add sound effects to your coding sessions — play sounds when tasks complete, notifications arrive, and more",
+  "type": "module",
+  "bin": {
+    "klaudio": "./bin/cli.js"
+  },
+  "files": [
+    "bin/",
+    "src/",
+    "sounds/"
+  ],
+  "scripts": {
+    "generate-sounds": "node scripts/generate-sounds.js",
+    "start": "node bin/cli.js",
+    "build": "bun run build.js",
+    "build:all": "bun run build.js --all"
+  },
+  "keywords": [
+    "klonk",
+    "sounds",
+    "sfx",
+    "hooks",
+    "notifications",
+    "audio",
+    "claude-code",
+    "coding-tools"
+  ],
+  "license": "MIT",
+  "dependencies": {
+    "ink": "^6.8.0",
+    "ink-select-input": "^6.2.0",
+    "ink-spinner": "^5.0.0",
+    "react": "^19.2.4"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/needle-tools/klaudio.git"
+  }
+}