opencube 0.1.0 → 0.1.1

package/README.md

@@ -1,10 +1,10 @@
 <p align="center">
-  <img src="assets/opencode-icon.png" width="96" height="96" alt="OpenCub icon" />
+  <img src="assets/opencode-icon.png" width="96" height="96" alt="OpenCube icon" />
 </p>
 
-# OpenCub
+# OpenCube
 
-OpenCub is a tiny desktop pet for [opencode](https://opencode.ai/).
+OpenCube is a tiny desktop pet for [opencode](https://opencode.ai/).
 
 It watches opencode session activity and renders a small Three.js cube on your desktop:
 
@@ -13,16 +13,14 @@ It watches opencode session activity and renders a small Three.js cube on your d
 - `/pet_say_hello` flashes one free face
 - `/pet_fancy_say_hello` plays a randomized light show on free faces
 
-OpenCub is packaged as an opencode plugin plus an Electron desktop process.
+OpenCube is packaged as an opencode plugin plus an Electron desktop process.
 
 ## Install
 
-> OpenCub is not published yet. These are the intended install commands once published.
-
 Install globally through opencode:
 
 ```sh
-opencode plugin opencub --global
+opencode plugin opencube --global
 ```
 
 Then restart opencode and run:
@@ -35,7 +33,7 @@ You can also add it manually to `~/.config/opencode/opencode.json`:
 
 ```json
 {
-  "plugin": ["opencub"]
+  "plugin": ["opencube"]
 }
 ```
 
@@ -43,8 +41,8 @@ You can also add it manually to `~/.config/opencode/opencode.json`:
 
 | Command | Description |
 | --- | --- |
-| `/pet` | Show or start OpenCub. |
-| `/pet_stop` | Quit OpenCub. |
+| `/pet` | Show or start OpenCube. |
+| `/pet_stop` | Quit OpenCube. |
 | `/pet_say_hello` | Flash one currently free face three times with a random color. |
 | `/pet_fancy_say_hello` | Run a denser randomized light show across currently free faces. |
 
@@ -52,7 +50,7 @@ These commands are handled by the plugin and do not get sent to the model.
 
 ## How it works
 
-OpenCub has two parts in one npm package:
+OpenCube has two parts in one npm package:
 
 1. `src/plugin-server.cjs` — the opencode plugin entrypoint.
 2. `src/main.js` — the Electron desktop pet.
@@ -60,7 +58,7 @@ OpenCub has two parts in one npm package:
 The plugin registers slash commands, listens for opencode `session.status` events, and sends events to the desktop pet over a local HTTP API:
 
 ```text
-opencode plugin -> http://127.0.0.1:47832 -> Electron OpenCub
+opencode plugin -> http://127.0.0.1:47832 -> Electron OpenCube
 ```
 
 The Electron process owns the window, Three.js renderer, cube rotation, face glow state, and inbox/debug endpoints.
@@ -77,7 +75,7 @@ Users do not need to run `npm install` manually when installing via `opencode pl
 
 - The first install may take a while because Electron is downloaded as a runtime dependency.
 - If commands do not appear after installation, restart opencode.
-- OpenCub uses a local-only HTTP server on `127.0.0.1:47832`.
+- OpenCube uses a local-only HTTP server on `127.0.0.1:47832`.
 - If that port is already in use, set `OPENCODE_PET_PORT` before starting opencode.
 
 ## Local development
@@ -93,7 +91,7 @@ For local opencode plugin testing, point your opencode config at the package dir
 
 ```json
 {
-  "plugin": ["/path/to/opencub"]
+  "plugin": ["/path/to/opencube"]
 }
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "opencube",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "A tiny Three.js desktop pet for opencode session activity.",
   "main": "src/main.js",
   "exports": {

package/src/main.js

@@ -9,7 +9,7 @@ const { DEFAULT_SESSION_COLORS, pixelPetSvg } = require("./pixel-pet-reference.c
 const APP_NAME = "opencode pet"
 const HOST = "127.0.0.1"
 const PORT = Number(process.env.OPENCODE_PET_PORT || 47832)
-const DATA_DIR = path.join(os.homedir(), ".local", "share", "opencode-pet")
+const DATA_DIR = path.join(os.homedir(), ".local", "share", "opencube")
 const STATE_FILE = path.join(DATA_DIR, "state.json")
 const PET_HTML_FILE = path.join(DATA_DIR, "pet.html")
 const ICON_PATH = process.env.OPENCODE_PET_ICON || path.join(__dirname, "..", "assets", "opencode-icon.png")
@@ -1169,7 +1169,7 @@ function startServer() {
           pid: process.pid,
           port: PORT,
           events: events.length,
-          pet: "pixel-opencode-pet",
+          pet: "opencube",
           sessions: getPetState().sessions.map(({ sessionID, state, busyIndex, idleIndex, color }) => ({
             sessionID,
             state,

package/src/plugin-server.cjs

@@ -48,7 +48,7 @@ function cubNotice(text, icon = CUB_ICON) {
 }
 
 module.exports = {
-  id: "opencode-pet",
+  id: "opencube",
   server: async ({ client }) => {
     const sessionStatus = new Map()
 
@@ -68,11 +68,11 @@ module.exports = {
         }
         cfg.command.pet_say_hello = {
           template: "/pet_say_hello",
-          description: "Send a hello test event to OpenCub.",
+          description: "Send a hello test event to OpenCube.",
         }
         cfg.command.pet_fancy_say_hello = {
           template: "/pet_fancy_say_hello",
-          description: "Trigger a randomized light show on OpenCub's free faces.",
+          description: "Trigger a randomized light show on OpenCube's free faces.",
         }
       },
 
@@ -87,7 +87,7 @@ module.exports = {
 
         if (shouldQuit(input)) {
           await quitPet()
-          await injectNotice(client, input.sessionID, cubNotice("OpenCub is going to sleep 🐾", "◌"))
+          await injectNotice(client, input.sessionID, cubNotice("OpenCube is going to sleep 🐾", "◌"))
         } else if (isSayHello(input)) {
           const result = await sendEvent({
             type: "hello",
@@ -95,12 +95,12 @@ module.exports = {
             command: input.command,
             arguments: input.arguments,
             sessionID: input.sessionID,
-            source: "opencode-pet-plugin",
+            source: "opencube-plugin",
           })
           await injectNotice(
             client,
             input.sessionID,
-            result ? cubNotice("OpenCub got your hello 🐾", "✦") : cubNotice("OpenCub is sleeping... zzz  Use /pet to wake it.", "☾"),
+            result ? cubNotice("OpenCube got your hello 🐾", "✦") : cubNotice("OpenCube is sleeping... zzz  Use /pet to wake it.", "☾"),
           )
         } else if (isFancySayHello(input)) {
           const result = await sendEvent({
@@ -109,14 +109,14 @@ module.exports = {
             command: input.command,
             arguments: input.arguments,
             sessionID: input.sessionID,
-            source: "opencode-pet-plugin",
+            source: "opencube-plugin",
           })
           await injectNotice(
             client,
             input.sessionID,
             result
-              ? cubNotice("OpenCub is putting on a light show ✨", "✺")
-              : cubNotice("OpenCub is sleeping... zzz  Start it with /pet before the light show.", "☾"),
+              ? cubNotice("OpenCube is putting on a light show ✨", "✺")
+              : cubNotice("OpenCube is sleeping... zzz  Start it with /pet before the light show.", "☾"),
           )
         } else {
           await showPet({
@@ -146,7 +146,7 @@ module.exports = {
             sessionID,
             status,
             previousStatus: previous,
-            source: "opencode-pet-plugin",
+            source: "opencube-plugin",
           })
           return
         }
@@ -161,7 +161,7 @@ module.exports = {
           sessionID,
           status,
           previousStatus: previous,
-          source: "opencode-pet-plugin",
+          source: "opencube-plugin",
         })
       },
     }

package/src/plugin-shared.cjs

@@ -30,7 +30,7 @@ async function emitProgress(onProgress, message) {
   try {
     await onProgress(message)
   } catch {
-    // Progress is best-effort; never block OpenCub startup on UI notices.
+    // Progress is best-effort; never block OpenCube startup on UI notices.
   }
 }
 
@@ -76,11 +76,11 @@ async function installElectronBinary(electronDir, options = {}) {
   const executablePath = path.join(distPath, platformPath)
 
   if (fs.existsSync(executablePath)) {
-    await emitProgress(options.onProgress, "OpenCub: Electron binary is ready ✅")
+    await emitProgress(options.onProgress, "OpenCube: Electron binary is ready ✅")
     return executablePath
   }
 
-  await emitProgress(options.onProgress, `OpenCub: downloading Electron ${version} for ${platform}/${arch}...`)
+  await emitProgress(options.onProgress, `OpenCube: downloading Electron ${version} for ${platform}/${arch}...`)
   const zipPath = await downloadArtifact({
     version,
     artifactName: "electron",
@@ -89,19 +89,19 @@ async function installElectronBinary(electronDir, options = {}) {
     platform,
     arch,
   })
-  await emitProgress(options.onProgress, "OpenCub: extracting Electron binary...")
+  await emitProgress(options.onProgress, "OpenCube: extracting Electron binary...")
   await extractElectronZip(zipPath, distPath)
   await fs.promises.writeFile(path.join(electronDir, "path.txt"), platformPath)
-  await emitProgress(options.onProgress, "OpenCub: Electron binary installed ✅")
+  await emitProgress(options.onProgress, "OpenCube: Electron binary installed ✅")
   return executablePath
 }
 
 async function resolveElectronPath(options = {}) {
-  await emitProgress(options.onProgress, "OpenCub: checking Electron runtime...")
+  await emitProgress(options.onProgress, "OpenCube: checking Electron runtime...")
   try {
     const electronPath = require("electron")
     if (typeof electronPath === "string") {
-      await emitProgress(options.onProgress, "OpenCub: Electron runtime is ready ✅")
+      await emitProgress(options.onProgress, "OpenCube: Electron runtime is ready ✅")
       return electronPath
     }
 
@@ -109,12 +109,12 @@ async function resolveElectronPath(options = {}) {
     // environment require("electron") can resolve to Electron's built-in API
     // object instead of the npm package's executable path string. Fall through
     // to the npm package directory and resolve/repair the packaged binary.
-    await emitProgress(options.onProgress, "OpenCub: locating packaged Electron binary...")
+    await emitProgress(options.onProgress, "OpenCube: locating packaged Electron binary...")
     const electronPackage = require.resolve("electron/package.json")
     const electronDir = path.dirname(electronPackage)
     return await installElectronBinary(electronDir, options)
   } catch (error) {
-    await emitProgress(options.onProgress, "OpenCub: Electron runtime is incomplete; repairing...")
+    await emitProgress(options.onProgress, "OpenCube: Electron runtime is incomplete; repairing...")
     const electronPackage = require.resolve("electron/package.json")
     const electronDir = path.dirname(electronPackage)
     return await installElectronBinary(electronDir, options)
@@ -123,7 +123,7 @@ async function resolveElectronPath(options = {}) {
 
 async function launchPet(args = [], options = {}) {
   const electronPath = await resolveElectronPath(options)
-  await emitProgress(options.onProgress, "OpenCub: launching desktop pet...")
+  await emitProgress(options.onProgress, "OpenCube: launching desktop pet...")
   const child = spawn(electronPath, [PET_APP_DIR, ...args], {
     cwd: PET_APP_DIR,
     detached: true,
@@ -134,7 +134,7 @@ async function launchPet(args = [], options = {}) {
     },
   })
   child.unref()
-  await emitProgress(options.onProgress, "OpenCub: launch request sent 🐾")
+  await emitProgress(options.onProgress, "OpenCube: launch request sent 🐾")
 }
 
 async function requestPet(pathname, options = {}) {
@@ -165,28 +165,28 @@ async function healthPet() {
 }
 
 async function waitForPet(timeoutMs = 3500, options = {}) {
-  await emitProgress(options.onProgress, "OpenCub: waiting for local server...")
+  await emitProgress(options.onProgress, "OpenCube: waiting for local server...")
   const startedAt = Date.now()
   while (Date.now() - startedAt < timeoutMs) {
     const health = await healthPet()
     if (health) {
-      await emitProgress(options.onProgress, "OpenCub: local server is ready ✅")
+      await emitProgress(options.onProgress, "OpenCube: local server is ready ✅")
       return health
     }
     await new Promise((resolve) => setTimeout(resolve, 150))
   }
-  await emitProgress(options.onProgress, "OpenCub: local server did not answer yet")
+  await emitProgress(options.onProgress, "OpenCube: local server did not answer yet")
   return undefined
 }
 
 async function ensurePet(options = {}) {
-  await emitProgress(options.onProgress, "OpenCub: checking whether it is already running...")
+  await emitProgress(options.onProgress, "OpenCube: checking whether it is already running...")
   const existing = await healthPet()
   if (existing) {
-    await emitProgress(options.onProgress, "OpenCub: already running; showing window...")
+    await emitProgress(options.onProgress, "OpenCube: already running; showing window...")
     return existing
   }
-  await emitProgress(options.onProgress, "OpenCub: not running; starting now...")
+  await emitProgress(options.onProgress, "OpenCube: not running; starting now...")
   await launchPet(["--show"], options)
   return await waitForPet(3500, options)
 }
@@ -194,7 +194,7 @@ async function ensurePet(options = {}) {
 async function showPet(options = {}) {
   const health = await ensurePet(options)
   await requestPet("/show", { method: "POST", timeoutMs: 800 })
-  await emitProgress(options.onProgress, health ? "OpenCub: shown ✨" : "OpenCub: start requested, still warming up...")
+  await emitProgress(options.onProgress, health ? "OpenCube: shown ✨" : "OpenCube: start requested, still warming up...")
   return health
 }
 
@@ -208,7 +208,7 @@ async function quitPet() {
 }
 
 async function sendEvent(event) {
-  // Only /pet is allowed to start OpenCub. Session lifecycle events and hello
+  // Only /pet is allowed to start OpenCube. Session lifecycle events and hello
   // commands should talk to the desktop pet only if it is already running.
   const health = await healthPet()
   if (!health) return undefined

package/src/plugin-tui.cjs

@@ -1,5 +1,5 @@
 module.exports = {
-  id: "opencode-pet",
+  id: "opencube",
   // Slash commands are registered from the server plugin via cfg.command, using
   // the same command.execute.before abort trick as @slkiser/opencode-quota.
   // Keep a no-op TUI entry so opencode can load ./tui without duplicate /pet rows.