@mohak34/opencode-notifier 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Mohak S
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,118 @@
+# @mohak34/opencode-notifier
+
+OpenCode plugin that plays sounds and sends system notifications when permission is needed, generation completes, or errors occur. Works on macOS, Linux, and Windows.
+
+## Installation
+
+Add the plugin to your `opencode.json` or `opencode.jsonc`:
+
+```json
+{
+  "plugin": ["@mohak34/opencode-notifier"]
+}
+```
+
+Restart OpenCode. The plugin will be automatically installed and loaded.
+
+## Platform Notes
+
+The plugin works out of the box on all platforms. For best results:
+
+- **macOS**: No additional setup required
+- **Windows**: No additional setup required
+- **Linux**: For sounds, one of these should be installed: `paplay`, `aplay`, `mpv`, or `ffplay`. For notifications, `notify-send` is recommended.
+
+## Configuration
+
+To customize the plugin, create `~/.config/opencode/opencode-notifier.json`:
+
+```json
+{
+  "sound": true,
+  "notification": true,
+  "timeout": 5,
+  "events": {
+    "permission": { "sound": true, "notification": true },
+    "complete": { "sound": true, "notification": true },
+    "error": { "sound": true, "notification": true }
+  },
+  "messages": {
+    "permission": "OpenCode needs permission",
+    "complete": "OpenCode has finished",
+    "error": "OpenCode encountered an error"
+  },
+  "sounds": {
+    "permission": "/path/to/custom/sound.wav",
+    "complete": "/path/to/custom/sound.wav",
+    "error": "/path/to/custom/sound.wav"
+  }
+}
+```
+
+### Options
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `sound` | boolean | `true` | Global toggle for all sounds |
+| `notification` | boolean | `true` | Global toggle for all notifications |
+| `timeout` | number | `5` | Notification duration in seconds (Linux only) |
+
+### Events
+
+Control sound and notification separately for each event:
+
+```json
+{
+  "events": {
+    "permission": { "sound": true, "notification": true },
+    "complete": { "sound": false, "notification": true },
+    "error": { "sound": true, "notification": false }
+  }
+}
+```
+
+Or use a boolean to toggle both:
+
+```json
+{
+  "events": {
+    "permission": true,
+    "complete": false,
+    "error": true
+  }
+}
+```
+
+### Messages
+
+Customize notification text:
+
+```json
+{
+  "messages": {
+    "permission": "Action required",
+    "complete": "Done!",
+    "error": "Something went wrong"
+  }
+}
+```
+
+### Custom Sounds
+
+Use your own sound files:
+
+```json
+{
+  "sounds": {
+    "permission": "/home/user/sounds/alert.wav",
+    "complete": "/home/user/sounds/done.wav",
+    "error": "/home/user/sounds/error.wav"
+  }
+}
+```
+
+If a custom sound file path is provided but the file doesn't exist, the plugin will fall back to the bundled sound.
+
+## License
+
+MIT