opencode-plugin-boops 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 towc
+
+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 DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,118 @@
+# opencode-plugin-boops 🔊
+
+Sound notifications for OpenCode - plays pleasant "boop" sounds when tasks complete or input is needed.
+
+## Features
+
+- 🎵 Pleasant glass chime when AI completes a response
+- 📡 Sonar ping when AI needs your permission or input
+- 🔄 Automatic fallback to alternative sounds if preferred sounds aren't available
+- 🐧 Works on Linux (with `paplay` or `aplay`)
+- 🍎 Works on macOS (requires custom sound configuration)
+
+## Installation
+
+### Using OpenCode config
+
+Add to your `opencode.json` or `~/.config/opencode/opencode.json`:
+
+```json
+{
+  "$schema": "https://opencode.ai/config.json",
+  "plugin": ["opencode-plugin-boops"]
+}
+```
+
+### Manual installation
+
+Place the plugin file in your OpenCode plugins directory:
+
+```bash
+# Global
+mkdir -p ~/.config/opencode/plugins
+cp index.ts ~/.config/opencode/plugins/boops.ts
+
+# Per-project
+mkdir -p .opencode/plugins
+cp index.ts .opencode/plugins/boops.ts
+```
+
+## How it works
+
+The plugin listens to OpenCode events:
+
+- **`session.idle`** - Fires when the AI finishes responding → plays completion sound (glass.ogg)
+- **`permission.asked`** - Fires when the AI needs permission → plays attention sound (sonar.ogg)
+
+## Customization
+
+### Custom sounds
+
+To use your own sounds, modify the sound file paths in `index.ts`:
+
+```typescript
+const inputSound = '/path/to/your/input-sound.ogg'
+const completeSound = '/path/to/your/complete-sound.ogg'
+```
+
+### macOS
+
+On macOS, you can use system sounds:
+
+```typescript
+const inputSound = '/System/Library/Sounds/Ping.aiff'
+const completeSound = '/System/Library/Sounds/Glass.aiff'
+```
+
+And update the `playSound` function to use `afplay`:
+
+```typescript
+await Bun.$`afplay ${primaryFile}`.quiet()
+```
+
+## Requirements
+
+- OpenCode 1.0+
+- Linux: `paplay` (PulseAudio) or `aplay` (ALSA)
+- macOS: `afplay` (built-in)
+- Sound files at specified paths (or system sounds)
+
+## Troubleshooting
+
+### No sound playing
+
+1. Check if sound files exist:
+```bash
+ls /usr/share/sounds/gnome/default/alerts/glass.ogg
+ls /usr/share/sounds/gnome/default/alerts/sonar.ogg
+```
+
+2. Test sound manually:
+```bash
+paplay /usr/share/sounds/gnome/default/alerts/glass.ogg
+```
+
+3. Check OpenCode logs:
+```bash
+tail -f ~/.local/share/opencode/log/*.log | grep boops
+```
+
+### Sounds too loud/quiet
+
+Adjust your system volume or use different sound files.
+
+## Contributing
+
+Contributions welcome! Feel free to:
+- Add support for Windows
+- Add configurable sound options
+- Improve cross-platform compatibility
+- Add more event triggers
+
+## License
+
+MIT
+
+## Author
+
+Created by [towc](https://github.com/towc)

package/index.ts

@@ -0,0 +1,65 @@
+import type { Plugin } from "@opencode-ai/plugin"
+
+export const BoopsPlugin: Plugin = async ({ client }) => {
+  // Default sounds - users can customize via config
+  const inputSound = '/usr/share/sounds/gnome/default/alerts/sonar.ogg'
+  const completeSound = '/usr/share/sounds/gnome/default/alerts/glass.ogg'
+  
+  // Fallback sounds for systems without GNOME sounds
+  const fallbackInputSound = '/usr/share/sounds/alsa/Front_Left.wav'
+  const fallbackCompleteSound = '/usr/share/sounds/alsa/Front_Right.wav'
+  
+  const log = async (message: string, extra?: any) => {
+    await client.app.log({
+      service: "opencode-plugin-boops",
+      level: "info",
+      message,
+      extra
+    })
+  }
+  
+  // Try multiple sound players and files
+  const playSound = async (primaryFile: string, fallbackFile: string, label: string) => {
+    try {
+      // Try primary sound with paplay
+      await Bun.$`paplay ${primaryFile}`.quiet()
+      return
+    } catch {
+      try {
+        // Try fallback sound with paplay
+        await Bun.$`paplay ${fallbackFile}`.quiet()
+        return
+      } catch {
+        try {
+          // Try primary with aplay
+          await Bun.$`aplay ${primaryFile}`.quiet()
+          return
+        } catch {
+          try {
+            // Try fallback with aplay
+            await Bun.$`aplay ${fallbackFile}`.quiet()
+            return
+          } catch {
+            // Last resort: terminal bell
+            await log(`All sound attempts failed for ${label}, using terminal bell`)
+            await Bun.$`echo -e "\a"`.quiet()
+          }
+        }
+      }
+    }
+  }
+  
+  await log("Boops plugin initialized - sound notifications enabled")
+  
+  return {
+    event: async ({ event }) => {
+      if (event.type === "session.idle") {
+        await playSound(completeSound, fallbackCompleteSound, "completion")
+      }
+      
+      if (event.type === "permission.asked") {
+        await playSound(inputSound, fallbackInputSound, "input-needed")
+      }
+    }
+  }
+}

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "opencode-plugin-boops",
+  "version": "1.0.0",
+  "description": "Sound notifications for OpenCode - plays pleasant sounds when tasks complete or input is needed",
+  "main": "index.ts",
+  "type": "module",
+  "keywords": [
+    "opencode",
+    "plugin",
+    "notifications",
+    "sound",
+    "audio",
+    "alerts"
+  ],
+  "author": "towc",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/towc/opencode-plugin-boops.git"
+  },
+  "bugs": {
+    "url": "https://github.com/towc/opencode-plugin-boops/issues"
+  },
+  "homepage": "https://github.com/towc/opencode-plugin-boops#readme",
+  "peerDependencies": {
+    "@opencode-ai/plugin": "^1.0.0"
+  },
+  "files": [
+    "index.ts",
+    "README.md",
+    "LICENSE"
+  ]
+}