@ai-rpg-engine/soundpack-core 2.0.0 → 2.0.1

package/README.md

@@ -0,0 +1,103 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/mcp-tool-shop-org/brand/main/logos/ai-rpg-engine/readme.png" width="300" alt="AI RPG Engine">
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@ai-rpg-engine/soundpack-core"><img src="https://img.shields.io/npm/v/@ai-rpg-engine/soundpack-core.svg" alt="npm"></a>
+  <a href="https://github.com/mcp-tool-shop-org/ai-rpg-engine/actions/workflows/ci.yml"><img src="https://github.com/mcp-tool-shop-org/ai-rpg-engine/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
+  <a href="https://github.com/mcp-tool-shop-org/ai-rpg-engine/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT"></a>
+</p>
+
+# @ai-rpg-engine/soundpack-core
+
+Content-addressable sound registry and pack specification for the [AI RPG Engine](https://github.com/mcp-tool-shop-org/ai-rpg-engine).
+
+Part of the **Immersion Runtime** — manages audio assets as tagged, queryable collections.
+
+## Install
+
+```bash
+npm install @ai-rpg-engine/soundpack-core
+```
+
+## What It Does
+
+Sound packs are loadable collections of audio entries (SFX, ambient loops, music, voice) with rich metadata for discovery. The registry supports tag-based queries, intensity filtering, and mood matching.
+
+Ships with a **core sound pack** that maps to [voice-soundboard](https://github.com/mcp-tool-shop-org/original_voice-soundboard) procedural effects.
+
+## Usage
+
+```typescript
+import { SoundRegistry, CORE_SOUND_PACK } from '@ai-rpg-engine/soundpack-core';
+
+const registry = new SoundRegistry();
+registry.load(CORE_SOUND_PACK);
+
+// Query by domain
+const ambient = registry.query({ domain: 'ambient' });
+
+// Query by tags + mood
+const tenseSfx = registry.query({ tags: ['alert'], mood: ['dread'] });
+
+// Get specific entry
+const entry = registry.get('ui_success');
+console.log(entry?.voiceSoundboardEffect); // "chime_success"
+```
+
+## Core Sound Pack
+
+13 entries mapped to voice-soundboard procedural effects:
+
+| ID | Effect | Domain | Tags |
+|----|--------|--------|------|
+| `ui_notification` | `chime_notification` | sfx | ui, alert |
+| `ui_success` | `chime_success` | sfx | ui, positive |
+| `ui_error` | `chime_error` | sfx | ui, negative |
+| `ui_click` | `click` | sfx | ui, input |
+| `ui_pop` | `pop` | sfx | ui, light |
+| `ui_whoosh` | `whoosh` | sfx | ui, transition |
+| `alert_warning` | `warning` | sfx | alert, caution |
+| `alert_critical` | `critical` | sfx | alert, danger |
+| `alert_info` | `info` | sfx | alert, info |
+| `ambient_rain` | `rain` | ambient | weather, calm |
+| `ambient_white_noise` | `white_noise` | ambient | background |
+| `ambient_drone` | `drone` | ambient | dark, tension |
+
+## Custom Sound Packs
+
+Create your own sound pack by providing a `SoundPackManifest`:
+
+```typescript
+import type { SoundPackManifest } from '@ai-rpg-engine/soundpack-core';
+
+const myPack: SoundPackManifest = {
+  name: 'medieval-tavern',
+  version: '1.0.0',
+  description: 'Tavern ambience and interaction sounds',
+  author: 'your-name',
+  entries: [
+    {
+      id: 'tavern_chatter',
+      tags: ['ambient', 'social'],
+      domain: 'ambient',
+      intensity: 'low',
+      mood: ['calm', 'social'],
+      durationClass: 'long-loop',
+      cooldownMs: 0,
+      variants: ['tavern_chatter_01.wav'],
+      source: 'file',
+    },
+  ],
+};
+
+registry.load(myPack);
+```
+
+## Part of AI RPG Engine
+
+This package is part of the [AI RPG Engine](https://github.com/mcp-tool-shop-org/ai-rpg-engine) monorepo. See the root README for the full architecture.
+
+## License
+
+MIT

package/dist/registry.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=registry.test.d.ts.map

package/dist/registry.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"registry.test.d.ts","sourceRoot":"","sources":["../src/registry.test.ts"],"names":[],"mappings":""}

package/dist/registry.test.js

@@ -0,0 +1,49 @@
+import { describe, it, expect } from 'vitest';
+import { SoundRegistry } from './registry.js';
+import { CORE_SOUND_PACK } from './core-pack.js';
+describe('SoundRegistry', () => {
+    it('should load the core sound pack', () => {
+        const registry = new SoundRegistry();
+        registry.load(CORE_SOUND_PACK);
+        expect(registry.size).toBe(CORE_SOUND_PACK.entries.length);
+    });
+    it('should get an entry by ID', () => {
+        const registry = new SoundRegistry();
+        registry.load(CORE_SOUND_PACK);
+        const entry = registry.get('ui_success');
+        expect(entry).toBeDefined();
+        expect(entry.voiceSoundboardEffect).toBe('chime_success');
+    });
+    it('should query by domain', () => {
+        const registry = new SoundRegistry();
+        registry.load(CORE_SOUND_PACK);
+        const ambient = registry.query({ domain: 'ambient' });
+        expect(ambient.length).toBeGreaterThan(0);
+        expect(ambient.every((e) => e.domain === 'ambient')).toBe(true);
+    });
+    it('should query by tags', () => {
+        const registry = new SoundRegistry();
+        registry.load(CORE_SOUND_PACK);
+        const alerts = registry.query({ tags: ['alert'] });
+        expect(alerts.length).toBeGreaterThan(0);
+    });
+    it('should query by mood', () => {
+        const registry = new SoundRegistry();
+        registry.load(CORE_SOUND_PACK);
+        const tense = registry.query({ mood: ['dread'] });
+        expect(tense.length).toBeGreaterThan(0);
+    });
+    it('should return undefined for missing ID', () => {
+        const registry = new SoundRegistry();
+        registry.load(CORE_SOUND_PACK);
+        expect(registry.get('nonexistent')).toBeUndefined();
+    });
+    it('should list all IDs', () => {
+        const registry = new SoundRegistry();
+        registry.load(CORE_SOUND_PACK);
+        const ids = registry.getIds();
+        expect(ids).toContain('ui_success');
+        expect(ids).toContain('ambient_drone');
+    });
+});
+//# sourceMappingURL=registry.test.js.map

package/dist/registry.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"registry.test.js","sourceRoot":"","sources":["../src/registry.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAEjD,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC7B,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;QACzC,MAAM,QAAQ,GAAG,IAAI,aAAa,EAAE,CAAC;QACrC,QAAQ,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAC/B,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;QACnC,MAAM,QAAQ,GAAG,IAAI,aAAa,EAAE,CAAC;QACrC,QAAQ,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAC/B,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QACzC,MAAM,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;QAC5B,MAAM,CAAC,KAAM,CAAC,qBAAqB,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wBAAwB,EAAE,GAAG,EAAE;QAChC,MAAM,QAAQ,GAAG,IAAI,aAAa,EAAE,CAAC;QACrC,QAAQ,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAC/B,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;QACtD,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QAC1C,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sBAAsB,EAAE,GAAG,EAAE;QAC9B,MAAM,QAAQ,GAAG,IAAI,aAAa,EAAE,CAAC;QACrC,QAAQ,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAC/B,MAAM,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACnD,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sBAAsB,EAAE,GAAG,EAAE;QAC9B,MAAM,QAAQ,GAAG,IAAI,aAAa,EAAE,CAAC;QACrC,QAAQ,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAC/B,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAClD,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;QAChD,MAAM,QAAQ,GAAG,IAAI,aAAa,EAAE,CAAC;QACrC,QAAQ,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAC/B,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;IACtD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qBAAqB,EAAE,GAAG,EAAE;QAC7B,MAAM,QAAQ,GAAG,IAAI,aAAa,EAAE,CAAC;QACrC,QAAQ,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAC/B,MAAM,GAAG,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC;QAC9B,MAAM,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;QACpC,MAAM,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-rpg-engine/soundpack-core",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "Sound pack manifest schema and content-addressable audio registry for AI RPG Engine",
   "type": "module",
   "main": "./dist/index.js",