opencode-smart-voice-notify 1.2.5 → 1.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -21
- package/README.md +332 -54
- package/example.config.jsonc +139 -158
- package/index.js +587 -97
- package/package.json +10 -3
- package/util/ai-messages.js +73 -0
- package/util/config.js +307 -27
- package/util/desktop-notify.js +319 -0
- package/util/focus-detect.js +372 -0
- package/util/per-project-sound.js +90 -0
- package/util/sound-theme.js +129 -0
- package/util/tts.js +123 -69
- package/util/webhook.js +743 -0
package/LICENSE
CHANGED
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
MIT License
|
|
2
|
-
|
|
3
|
-
Copyright (c)
|
|
4
|
-
|
|
5
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
-
in the Software without restriction, including without limitation the rights
|
|
8
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
-
furnished to do so, subject to the following conditions:
|
|
11
|
-
|
|
12
|
-
The above copyright notice and this permission notice shall be included in all
|
|
13
|
-
copies or substantial portions of the Software.
|
|
14
|
-
|
|
15
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
-
SOFTWARE.
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 MasuRii
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,25 +1,35 @@
|
|
|
1
|
-
<!-- Dynamic Header -->
|
|
2
|
-
<img width="100%" src="https://capsule-render.vercel.app/api?type=waving&color=0:667eea,100:764ba2&height=120§ion=header"/>
|
|
1
|
+
<!-- Dynamic Header -->
|
|
2
|
+
<img width="100%" src="https://capsule-render.vercel.app/api?type=waving&color=0:667eea,100:764ba2&height=120§ion=header"/>
|
|
3
|
+
|
|
4
|
+
# OpenCode Smart Voice Notify
|
|
5
|
+
|
|
6
|
+
[](https://www.npmjs.com/package/opencode-smart-voice-notify)
|
|
7
|
+
[](https://www.npmjs.com/package/opencode-smart-voice-notify)
|
|
8
|
+
[](https://github.com/MasuRii/opencode-smart-voice-notify/releases)
|
|
9
|
+
[](https://github.com/MasuRii/opencode-smart-voice-notify/actions/workflows/test.yml)
|
|
10
|
+
[](https://github.com/MasuRii/opencode-smart-voice-notify/blob/master/LICENSE)
|
|
11
|
+
[](https://nodejs.org)
|
|
12
|
+
[](https://github.com/MasuRii/opencode-smart-voice-notify#platform-support-matrix)
|
|
3
13
|
|
|
4
|
-
# OpenCode Smart Voice Notify
|
|
5
14
|
|
|
6
15
|
> **Disclaimer**: This project is not built by the OpenCode team and is not affiliated with [OpenCode](https://opencode.ai) in any way. It is an independent community plugin.
|
|
7
16
|
|
|
8
|
-
A smart voice notification plugin for [OpenCode](https://opencode.ai) with **multiple TTS engines
|
|
17
|
+
A smart voice notification plugin for [OpenCode](https://opencode.ai) with **multiple TTS engines**, native desktop notifications, and an intelligent reminder system.
|
|
9
18
|
|
|
10
19
|
<img width="1456" height="720" alt="image" src="https://github.com/user-attachments/assets/52ccf357-2548-400b-a346-6362f2fc3180" />
|
|
11
20
|
|
|
12
21
|
|
|
13
22
|
## Features
|
|
14
23
|
|
|
15
|
-
### Smart TTS Engine Selection
|
|
16
|
-
The plugin automatically tries multiple TTS engines in order, falling back if one fails:
|
|
17
|
-
|
|
18
|
-
1. **OpenAI-Compatible** (Cloud/Self-hosted) - Any OpenAI-compatible `/v1/audio/speech` endpoint (Kokoro, LocalAI, Coqui, AllTalk, OpenAI API, etc.)
|
|
19
|
-
2. **ElevenLabs** (Online) - High-quality, anime-like voices with natural expression
|
|
20
|
-
3. **Edge TTS** (Free) - Microsoft's neural voices
|
|
21
|
-
4. **Windows SAPI** (Offline) - Built-in Windows speech synthesis
|
|
22
|
-
5. **
|
|
24
|
+
### Smart TTS Engine Selection
|
|
25
|
+
The plugin automatically tries multiple TTS engines in order, falling back if one fails:
|
|
26
|
+
|
|
27
|
+
1. **OpenAI-Compatible** (Cloud/Self-hosted) - Any OpenAI-compatible `/v1/audio/speech` endpoint (Kokoro, LocalAI, Coqui, AllTalk, OpenAI API, etc.)
|
|
28
|
+
2. **ElevenLabs** (Online) - High-quality, anime-like voices with natural expression
|
|
29
|
+
3. **Edge TTS** (Free) - Microsoft's neural voices via Python CLI (recommended) or native npm fallback
|
|
30
|
+
4. **Windows SAPI** (Offline) - Built-in Windows speech synthesis
|
|
31
|
+
5. **macOS Say** (Offline) - Built-in macOS speech synthesis
|
|
32
|
+
6. **Local Sound Files** (Fallback) - Plays bundled MP3 files if all TTS fails
|
|
23
33
|
|
|
24
34
|
### Smart Notification System
|
|
25
35
|
- **Sound-first mode**: Play a sound immediately, then speak a TTS reminder if user doesn't respond
|
|
@@ -28,6 +38,7 @@ The plugin automatically tries multiple TTS engines in order, falling back if on
|
|
|
28
38
|
- **Sound-only mode**: Just play sounds, no TTS
|
|
29
39
|
|
|
30
40
|
### Intelligent Reminders
|
|
41
|
+
- **Granular Control**: Enable or disable notifications and reminders for specific event types (Idle, Permission, Question, Error) via configuration.
|
|
31
42
|
- Delayed TTS reminders if user doesn't respond within configurable time
|
|
32
43
|
- Follow-up reminders with exponential backoff
|
|
33
44
|
- Automatic cancellation when user responds
|
|
@@ -44,11 +55,15 @@ The plugin automatically tries multiple TTS engines in order, falling back if on
|
|
|
44
55
|
- **Smart fallback**: Automatically falls back to static messages if AI is unavailable
|
|
45
56
|
|
|
46
57
|
### System Integration
|
|
58
|
+
- **Native Desktop Notifications**: Windows (Toast), macOS (Notification Center), and Linux (notify-send) support
|
|
47
59
|
- **Native Edge TTS**: No external dependencies (Python/pip) required
|
|
48
|
-
-
|
|
49
|
-
-
|
|
50
|
-
-
|
|
51
|
-
-
|
|
60
|
+
- **Focus Detection** (macOS): Suppresses notifications when terminal is focused
|
|
61
|
+
- **Webhook Integration**: Receive notifications on Discord or any custom webhook endpoint when tasks finish or need attention
|
|
62
|
+
- **Themed Sound Packs**: Use custom sound collections (e.g., Warcraft, StarCraft) by simply pointing to a directory
|
|
63
|
+
- **Per-Project Sounds**: Assign unique sounds to different projects for easy identification
|
|
64
|
+
- **Wake monitor** from sleep before notifying
|
|
65
|
+
- **Auto-boost volume** if too low
|
|
66
|
+
- **TUI toast** notifications
|
|
52
67
|
|
|
53
68
|
## Installation
|
|
54
69
|
|
|
@@ -106,13 +121,6 @@ If you prefer to create the config manually, add a `smart-voice-notify.jsonc` fi
|
|
|
106
121
|
|
|
107
122
|
```jsonc
|
|
108
123
|
{
|
|
109
|
-
// ============================================================
|
|
110
|
-
// OpenCode Smart Voice Notify - Quick Start Configuration
|
|
111
|
-
// ============================================================
|
|
112
|
-
// For ALL available options, see example.config.jsonc in the plugin.
|
|
113
|
-
// The plugin auto-creates a comprehensive config on first run.
|
|
114
|
-
// ============================================================
|
|
115
|
-
|
|
116
124
|
// Master switch to enable/disable the plugin without uninstalling
|
|
117
125
|
"enabled": true,
|
|
118
126
|
|
|
@@ -137,22 +145,39 @@ If you prefer to create the config manually, add a `smart-voice-notify.jsonc` fi
|
|
|
137
145
|
"edgePitch": "+50Hz",
|
|
138
146
|
"edgeRate": "+10%",
|
|
139
147
|
|
|
148
|
+
// Desktop Notifications
|
|
149
|
+
"enableDesktopNotification": true,
|
|
150
|
+
"desktopNotificationTimeout": 5,
|
|
151
|
+
"showProjectInNotification": true,
|
|
152
|
+
|
|
140
153
|
// TTS reminder settings
|
|
141
154
|
"enableTTSReminder": true,
|
|
142
155
|
"ttsReminderDelaySeconds": 30,
|
|
143
156
|
"enableFollowUpReminders": true,
|
|
144
|
-
"maxFollowUpReminders": 3,
|
|
145
157
|
|
|
158
|
+
// Focus Detection (macOS only)
|
|
159
|
+
"suppressWhenFocused": true,
|
|
160
|
+
"alwaysNotify": false,
|
|
161
|
+
|
|
146
162
|
// AI-generated messages (optional - requires local AI server)
|
|
147
163
|
"enableAIMessages": false,
|
|
148
164
|
"aiEndpoint": "http://localhost:11434/v1",
|
|
149
|
-
"aiModel": "llama3",
|
|
150
|
-
"aiApiKey": "",
|
|
151
|
-
"aiFallbackToStatic": true,
|
|
152
165
|
|
|
166
|
+
// Webhook settings (optional - works with Discord)
|
|
167
|
+
"enableWebhook": false,
|
|
168
|
+
"webhookUrl": "",
|
|
169
|
+
"webhookUsername": "OpenCode Notify",
|
|
170
|
+
|
|
171
|
+
// Sound theme settings (optional)
|
|
172
|
+
"soundThemeDir": "", // Path to custom sound theme directory
|
|
173
|
+
|
|
174
|
+
// Per-project sounds
|
|
175
|
+
"perProjectSounds": false,
|
|
176
|
+
"projectSoundSeed": 0,
|
|
177
|
+
|
|
153
178
|
// General settings
|
|
154
179
|
"wakeMonitor": true,
|
|
155
|
-
"forceVolume":
|
|
180
|
+
"forceVolume": false,
|
|
156
181
|
"volumeThreshold": 50,
|
|
157
182
|
"enableToast": true,
|
|
158
183
|
"enableSound": true,
|
|
@@ -162,9 +187,9 @@ If you prefer to create the config manually, add a `smart-voice-notify.jsonc` fi
|
|
|
162
187
|
|
|
163
188
|
For the complete configuration with all TTS engine settings, message arrays, AI prompts, and advanced options, see [`example.config.jsonc`](./example.config.jsonc) in the plugin directory.
|
|
164
189
|
|
|
165
|
-
### OpenAI-Compatible TTS Setup (Kokoro, LocalAI, OpenAI API, etc.)
|
|
166
|
-
|
|
167
|
-
For cloud-based or self-hosted TTS using any OpenAI-compatible `/v1/audio/speech` endpoint:
|
|
190
|
+
### OpenAI-Compatible TTS Setup (Kokoro, LocalAI, OpenAI API, etc.)
|
|
191
|
+
|
|
192
|
+
For cloud-based or self-hosted TTS using any OpenAI-compatible `/v1/audio/speech` endpoint:
|
|
168
193
|
|
|
169
194
|
```jsonc
|
|
170
195
|
{
|
|
@@ -203,12 +228,15 @@ If you want dynamic, AI-generated notification messages instead of preset ones,
|
|
|
203
228
|
"aiEndpoint": "http://localhost:11434/v1",
|
|
204
229
|
"aiModel": "llama3",
|
|
205
230
|
"aiApiKey": "",
|
|
206
|
-
"aiFallbackToStatic": true
|
|
231
|
+
"aiFallbackToStatic": true,
|
|
232
|
+
"enableContextAwareAI": false // Set to true for personalized messages with project/task context
|
|
207
233
|
}
|
|
208
234
|
```
|
|
209
235
|
|
|
210
236
|
3. **The AI will generate unique messages** for each notification, which are then spoken by your TTS engine.
|
|
211
237
|
|
|
238
|
+
4. **Context-Aware Messages** (optional): Enable `enableContextAwareAI` for personalized notifications that include project name, task title, and change summary (e.g., "Your work on MyProject is complete!").
|
|
239
|
+
|
|
212
240
|
**Supported AI Servers:**
|
|
213
241
|
| Server | Default Endpoint | API Key |
|
|
214
242
|
|--------|-----------------|---------|
|
|
@@ -218,33 +246,154 @@ If you want dynamic, AI-generated notification messages instead of preset ones,
|
|
|
218
246
|
| vLLM | `http://localhost:8000/v1` | Use "EMPTY" |
|
|
219
247
|
| Jan.ai | `http://localhost:1337/v1` | Required |
|
|
220
248
|
|
|
249
|
+
### Discord / Webhook Integration (Optional)
|
|
250
|
+
|
|
251
|
+
Receive remote notifications on Discord or any custom endpoint. This is perfect for long-running tasks when you're away from your computer.
|
|
252
|
+
|
|
253
|
+
1. **Create a Discord Webhook**:
|
|
254
|
+
- In Discord, go to **Server Settings** > **Integrations** > **Webhooks**.
|
|
255
|
+
- Click **New Webhook**, choose a channel, and click **Copy Webhook URL**.
|
|
256
|
+
|
|
257
|
+
2. **Enable Webhooks in your config**:
|
|
258
|
+
```jsonc
|
|
259
|
+
{
|
|
260
|
+
"enableWebhook": true,
|
|
261
|
+
"webhookUrl": "https://discord.com/api/webhooks/...",
|
|
262
|
+
"webhookUsername": "OpenCode Notify",
|
|
263
|
+
"webhookEvents": ["idle", "permission", "error", "question"],
|
|
264
|
+
"webhookMentionOnPermission": true
|
|
265
|
+
}
|
|
266
|
+
```
|
|
267
|
+
|
|
268
|
+
3. **Features**:
|
|
269
|
+
- **Color-coded Embeds**: Different colors for task completion (green), permissions (orange), errors (red), and questions (blue).
|
|
270
|
+
- **Smart Mentions**: Automatically @everyone on Discord for urgent permission requests.
|
|
271
|
+
- **Rate Limiting**: Intelligent retry logic with backoff if Discord's rate limits are hit.
|
|
272
|
+
- **Fire-and-forget**: Webhook requests never block local sound or TTS playback.
|
|
273
|
+
|
|
274
|
+
**Supported Webhook Events:**
|
|
275
|
+
| Event | Trigger |
|
|
276
|
+
|-------|---------|
|
|
277
|
+
| `idle` | Agent finished working |
|
|
278
|
+
| `permission` | Agent needs permission for a tool |
|
|
279
|
+
| `error` | Agent encountered an error |
|
|
280
|
+
| `question` | Agent is asking you a question |
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
### Custom Sound Themes (Optional)
|
|
284
|
+
|
|
285
|
+
You can replace individual sound files with entire "Sound Themes" (like the classic Warcraft II or StarCraft sound packs).
|
|
286
|
+
|
|
287
|
+
1. **Set up your theme directory**:
|
|
288
|
+
Create a folder (e.g., `~/.config/opencode/themes/warcraft2/`) with the following structure:
|
|
289
|
+
```text
|
|
290
|
+
warcraft2/
|
|
291
|
+
├── idle/ # Sounds for when the agent finishes
|
|
292
|
+
│ ├── job_done.mp3
|
|
293
|
+
│ └── alright.wav
|
|
294
|
+
├── permission/ # Sounds for permission requests
|
|
295
|
+
│ ├── help.mp3
|
|
296
|
+
│ └── need_orders.wav
|
|
297
|
+
├── error/ # Sounds for agent errors
|
|
298
|
+
│ └── alert.mp3
|
|
299
|
+
└── question/ # Sounds for agent questions
|
|
300
|
+
└── yes_milord.mp3
|
|
301
|
+
```
|
|
302
|
+
|
|
303
|
+
2. **Configure the theme in your config**:
|
|
304
|
+
```jsonc
|
|
305
|
+
{
|
|
306
|
+
"soundThemeDir": "themes/warcraft2",
|
|
307
|
+
"randomizeSoundFromTheme": true
|
|
308
|
+
}
|
|
309
|
+
```
|
|
310
|
+
|
|
311
|
+
3. **Features**:
|
|
312
|
+
- **Automatic Fallback**: If a theme subdirectory or sound is missing, the plugin automatically falls back to your default sound files.
|
|
313
|
+
- **Randomization**: If multiple sounds are in a subdirectory, the plugin will pick one at random each time (if `randomizeSoundFromTheme` is `true`).
|
|
314
|
+
- **Relative Paths**: Paths are relative to your OpenCode config directory (`~/.config/opencode/`).
|
|
315
|
+
|
|
316
|
+
|
|
221
317
|
## Requirements
|
|
222
318
|
|
|
223
|
-
###
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
319
|
+
### Platform Support Matrix
|
|
320
|
+
|
|
321
|
+
| Feature | Windows | macOS | Linux |
|
|
322
|
+
|---------|:---:|:---:|:---:|
|
|
323
|
+
| **Sound Playback** | ✅ | ✅ | ✅ |
|
|
324
|
+
| **TTS (Cloud/Edge)** | ✅ | ✅ | ✅ |
|
|
325
|
+
| **TTS (Windows SAPI)** | ✅ | ❌ | ❌ |
|
|
326
|
+
| **TTS (macOS Say)** | ❌ | ✅ | ❌ |
|
|
327
|
+
| **Desktop Notifications** | ✅ | ✅ | ✅ (req libnotify) |
|
|
328
|
+
| **Focus Detection** | ❌ | ✅ | ❌ |
|
|
329
|
+
| **Webhook Integration** | ✅ | ✅ | ✅ |
|
|
330
|
+
| **Wake Monitor** | ✅ | ✅ | ✅ (X11/Gnome) |
|
|
331
|
+
| **Volume Control** | ✅ | ✅ | ✅ (Pulse/ALSA) |
|
|
332
|
+
|
|
333
|
+
### For OpenAI-Compatible TTS
|
|
334
|
+
- Any server implementing the `/v1/audio/speech` endpoint
|
|
335
|
+
- Examples: [Kokoro](https://github.com/remsky/Kokoro-FastAPI), [LocalAI](https://localai.io), [AllTalk](https://github.com/erew123/alltalk_tts), OpenAI API, etc.
|
|
336
|
+
- Works with both local self-hosted servers and cloud-based providers.
|
|
227
337
|
|
|
228
338
|
### For ElevenLabs TTS
|
|
229
339
|
- ElevenLabs API key (free tier: 10,000 characters/month)
|
|
230
340
|
- Internet connection
|
|
231
341
|
|
|
232
|
-
### For Edge TTS
|
|
233
|
-
- Internet connection
|
|
342
|
+
### For Edge TTS
|
|
343
|
+
- Internet connection required
|
|
344
|
+
- **Recommended**: Install Python edge-tts for best reliability: `pip install edge-tts`
|
|
345
|
+
- **Fallback**: Works without Python (uses bundled npm package), but may be less reliable
|
|
346
|
+
- If Edge TTS fails, automatically falls back to SAPI (Windows) or Say (macOS)
|
|
347
|
+
|
|
348
|
+
### For Windows SAPI
|
|
349
|
+
- Windows OS (uses built-in System.Speech)
|
|
350
|
+
|
|
351
|
+
### For macOS Say
|
|
352
|
+
- macOS (uses built-in `say` command)
|
|
353
|
+
- Serves as fallback when other TTS engines fail
|
|
354
|
+
|
|
355
|
+
### For Desktop Notifications
|
|
356
|
+
- **Windows**: Built-in (uses Toast notifications)
|
|
357
|
+
- **macOS**: Built-in (uses Notification Center)
|
|
358
|
+
- **Linux**: Requires `notify-send` (libnotify)
|
|
359
|
+
```bash
|
|
360
|
+
# Ubuntu/Debian
|
|
361
|
+
sudo apt install libnotify-bin
|
|
234
362
|
|
|
235
|
-
|
|
236
|
-
|
|
363
|
+
# Fedora
|
|
364
|
+
sudo dnf install libnotify
|
|
365
|
+
|
|
366
|
+
# Arch Linux
|
|
367
|
+
sudo pacman -S libnotify
|
|
368
|
+
```
|
|
237
369
|
|
|
238
370
|
### For Sound Playback
|
|
239
371
|
- **Windows**: Built-in (uses Windows Media Player)
|
|
240
372
|
- **macOS**: Built-in (`afplay`)
|
|
241
373
|
- **Linux**: `paplay` or `aplay`
|
|
242
374
|
|
|
375
|
+
### For Focus Detection
|
|
376
|
+
Focus detection suppresses sound and desktop notifications when the terminal is focused.
|
|
377
|
+
|
|
378
|
+
| Platform | Support | Notes |
|
|
379
|
+
|----------|---------|-------|
|
|
380
|
+
| **macOS** | ✅ Full | Uses AppleScript to detect frontmost application |
|
|
381
|
+
| **Windows** | ❌ Not supported | No reliable API available |
|
|
382
|
+
| **Linux** | ❌ Not supported | Varies by desktop environment |
|
|
383
|
+
|
|
384
|
+
> **Note**: On unsupported platforms, notifications are always sent (fail-open behavior). TTS reminders are never suppressed, even when focused, since users may step away after seeing the toast.
|
|
385
|
+
|
|
386
|
+
### For Webhook Notifications
|
|
387
|
+
- **Discord**: Full support for Discord's webhook embed format.
|
|
388
|
+
- **Generic**: Works with any endpoint that accepts a POST request with a JSON body (though formatting is optimized for Discord).
|
|
389
|
+
- **Rate Limits**: The plugin handles HTTP 429 (Too Many Requests) automatically with retries and a 250ms queue delay.
|
|
390
|
+
|
|
243
391
|
## Events Handled
|
|
244
392
|
|
|
245
393
|
| Event | Action |
|
|
246
394
|
|-------|--------|
|
|
247
395
|
| `session.idle` | Agent finished working - notify user |
|
|
396
|
+
| `session.error` | Agent encountered an error - alert user |
|
|
248
397
|
| `permission.asked` | Permission request (SDK v1.1.1+) - alert user |
|
|
249
398
|
| `permission.updated` | Permission request (SDK v1.0.x) - alert user |
|
|
250
399
|
| `permission.replied` | User responded - cancel pending reminders |
|
|
@@ -282,26 +431,155 @@ To develop on this plugin locally:
|
|
|
282
431
|
}
|
|
283
432
|
```
|
|
284
433
|
|
|
285
|
-
|
|
434
|
+
### Testing
|
|
286
435
|
|
|
287
|
-
|
|
436
|
+
The plugin uses [Bun](https://bun.sh)'s built-in test runner for unit and E2E tests.
|
|
288
437
|
|
|
289
438
|
```bash
|
|
290
|
-
#
|
|
291
|
-
|
|
439
|
+
# Run all tests
|
|
440
|
+
bun test
|
|
292
441
|
|
|
293
|
-
# Run
|
|
294
|
-
|
|
295
|
-
```
|
|
442
|
+
# Run tests with coverage
|
|
443
|
+
bun test --coverage
|
|
296
444
|
|
|
297
|
-
|
|
445
|
+
# Run tests in watch mode
|
|
446
|
+
bun test --watch
|
|
447
|
+
```
|
|
298
448
|
|
|
299
|
-
|
|
449
|
+
For more detailed testing guidelines and mock usage examples, see [CONTRIBUTING.md](./CONTRIBUTING.md).
|
|
300
450
|
|
|
301
|
-
##
|
|
451
|
+
## Updating
|
|
302
452
|
|
|
303
|
-
|
|
304
|
-
- Check the [OpenCode docs](https://opencode.ai/docs/plugins)
|
|
453
|
+
OpenCode does not automatically update plugins. To update to the latest version:
|
|
305
454
|
|
|
306
|
-
|
|
307
|
-
|
|
455
|
+
```bash
|
|
456
|
+
# Clear the cached plugin
|
|
457
|
+
rm -rf ~/.cache/opencode/node_modules/opencode-smart-voice-notify
|
|
458
|
+
|
|
459
|
+
# Run OpenCode to trigger a fresh install
|
|
460
|
+
opencode
|
|
461
|
+
```
|
|
462
|
+
|
|
463
|
+
<!--
|
|
464
|
+
LLM-AGENT-INSTRUCTIONS (Hidden from rendered markdown, visible to AI assistants scanning raw file)
|
|
465
|
+
|
|
466
|
+
## LLM Instructions
|
|
467
|
+
|
|
468
|
+
> This section provides structured guidance for AI assistants (Claude, GPT, Cursor, Copilot, etc.) helping users set up and configure this plugin.
|
|
469
|
+
|
|
470
|
+
### Quick Setup (Execute These Steps)
|
|
471
|
+
|
|
472
|
+
When a user asks you to set up this plugin, follow these steps:
|
|
473
|
+
|
|
474
|
+
1. **Add plugin to OpenCode config** - Edit `~/.config/opencode/opencode.json`:
|
|
475
|
+
```json
|
|
476
|
+
{
|
|
477
|
+
"$schema": "https://opencode.ai/config.json",
|
|
478
|
+
"plugin": ["opencode-smart-voice-notify@latest"]
|
|
479
|
+
}
|
|
480
|
+
```
|
|
481
|
+
|
|
482
|
+
2. **Run OpenCode once** - This auto-generates the configuration file at `~/.config/opencode/smart-voice-notify.jsonc`
|
|
483
|
+
|
|
484
|
+
3. **Configure based on user's TTS preference**:
|
|
485
|
+
- **Free/No API key**: Use Edge TTS (default, works out of box)
|
|
486
|
+
- **High quality**: Use ElevenLabs (requires API key)
|
|
487
|
+
- **Self-hosted**: Use OpenAI-compatible endpoint (Kokoro, LocalAI, etc.)
|
|
488
|
+
- **Offline Windows**: Use Windows SAPI
|
|
489
|
+
- **Offline macOS**: Use macOS Say (built-in fallback)
|
|
490
|
+
|
|
491
|
+
### Configuration Tasks
|
|
492
|
+
|
|
493
|
+
#### Task: Enable ElevenLabs TTS
|
|
494
|
+
```jsonc
|
|
495
|
+
// In ~/.config/opencode/smart-voice-notify.jsonc
|
|
496
|
+
{
|
|
497
|
+
"ttsEngine": "elevenlabs",
|
|
498
|
+
"elevenLabsApiKey": "USER_API_KEY_HERE",
|
|
499
|
+
"elevenLabsVoiceId": "cgSgspJ2msm6clMCkdW9"
|
|
500
|
+
}
|
|
501
|
+
```
|
|
502
|
+
**Note**: User must get API key from https://elevenlabs.io/app/settings/api-keys
|
|
503
|
+
|
|
504
|
+
#### Task: Enable OpenAI-Compatible TTS (Kokoro, LocalAI, etc.)
|
|
505
|
+
```jsonc
|
|
506
|
+
{
|
|
507
|
+
"ttsEngine": "openai",
|
|
508
|
+
"openaiTtsEndpoint": "http://localhost:8880",
|
|
509
|
+
"openaiTtsVoice": "af_heart",
|
|
510
|
+
"openaiTtsModel": "kokoro"
|
|
511
|
+
}
|
|
512
|
+
```
|
|
513
|
+
**Note**: User must have a compatible TTS server running locally or remotely.
|
|
514
|
+
|
|
515
|
+
#### Task: Enable Discord Webhook Notifications
|
|
516
|
+
```jsonc
|
|
517
|
+
{
|
|
518
|
+
"enableWebhook": true,
|
|
519
|
+
"webhookUrl": "https://discord.com/api/webhooks/...",
|
|
520
|
+
"webhookEvents": ["idle", "permission", "error", "question"],
|
|
521
|
+
"webhookMentionOnPermission": true
|
|
522
|
+
}
|
|
523
|
+
```
|
|
524
|
+
|
|
525
|
+
#### Task: Enable AI-Generated Messages (requires local AI server)
|
|
526
|
+
```jsonc
|
|
527
|
+
{
|
|
528
|
+
"enableAIMessages": true,
|
|
529
|
+
"aiEndpoint": "http://localhost:11434/v1",
|
|
530
|
+
"aiModel": "llama3"
|
|
531
|
+
}
|
|
532
|
+
```
|
|
533
|
+
**Note**: Requires Ollama, LM Studio, or similar running locally.
|
|
534
|
+
|
|
535
|
+
#### Task: Set Up Custom Sound Theme
|
|
536
|
+
```jsonc
|
|
537
|
+
{
|
|
538
|
+
"soundThemeDir": "themes/warcraft2",
|
|
539
|
+
"randomizeSoundFromTheme": true
|
|
540
|
+
}
|
|
541
|
+
```
|
|
542
|
+
**Directory structure**: `~/.config/opencode/themes/warcraft2/{idle,permission,error,question}/*.mp3`
|
|
543
|
+
|
|
544
|
+
### Common Issues & Fixes
|
|
545
|
+
|
|
546
|
+
| Issue | Solution |
|
|
547
|
+
|-------|----------|
|
|
548
|
+
| No sound playing | Check `"enableSound": true` and verify audio files exist in `~/.config/opencode/assets/` |
|
|
549
|
+
| TTS not working | Try fallback: change `"ttsEngine"` to `"edge"` (free, no API key) |
|
|
550
|
+
| ElevenLabs quota exceeded | Plugin auto-falls back to Edge TTS; or set `"ttsEngine": "edge"` |
|
|
551
|
+
| Notifications too frequent | Increase `"ttsReminderDelaySeconds"` (default: 30) |
|
|
552
|
+
| Want to disable completely | Set `"enabled": false` in config |
|
|
553
|
+
| Edge TTS not speaking | Install Python edge-tts: `pip install edge-tts` |
|
|
554
|
+
|
|
555
|
+
### Platform-Specific Notes
|
|
556
|
+
|
|
557
|
+
- **Windows**: All features supported, SAPI as offline fallback
|
|
558
|
+
- **macOS**: Focus detection available, `say` command as offline fallback
|
|
559
|
+
- **Linux**: Requires `libnotify-bin` for desktop notifications, no offline TTS fallback
|
|
560
|
+
|
|
561
|
+
### TTS Fallback Chain
|
|
562
|
+
|
|
563
|
+
Primary Engine → Edge TTS → Windows SAPI → macOS Say → Sound File
|
|
564
|
+
|
|
565
|
+
### Done When
|
|
566
|
+
|
|
567
|
+
The plugin is successfully configured when:
|
|
568
|
+
- [ ] `~/.config/opencode/opencode.json` contains the plugin entry
|
|
569
|
+
- [ ] `~/.config/opencode/smart-voice-notify.jsonc` exists with user's settings
|
|
570
|
+
- [ ] Running `opencode` produces audio notification when agent finishes a task
|
|
571
|
+
|
|
572
|
+
END LLM-AGENT-INSTRUCTIONS
|
|
573
|
+
-->
|
|
574
|
+
|
|
575
|
+
## License
|
|
576
|
+
|
|
577
|
+
MIT
|
|
578
|
+
|
|
579
|
+
## Support
|
|
580
|
+
|
|
581
|
+
- Open an issue on [GitHub](https://github.com/MasuRii/opencode-smart-voice-notify/issues)
|
|
582
|
+
- Check the [OpenCode docs](https://opencode.ai/docs/plugins)
|
|
583
|
+
|
|
584
|
+
<!-- Dynamic Header -->
|
|
585
|
+
<img width="100%" src="https://capsule-render.vercel.app/api?type=waving&color=0:667eea,100:764ba2&height=120§ion=header"/>
|