@vibuca/synth8-phaser-plugin 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Sven Hemmer
+
+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,127 @@
+# @vibuca/synth8-phaser
+
+Phaser integration for Synth8, an MIT-licensed TypeScript music DSL and playback toolkit.
+
+Use Synth8 patterns directly inside Phaser scenes for background music and overlapping sound effects.
+
+## Install
+
+```bash
+npm install @vibuca/synth8-core @vibuca/synth8-player @vibuca/synth8-phaser
+```
+
+You also need Phaser:
+
+```bash
+npm install phaser
+```
+
+## Register the plugin
+
+```ts
+import Phaser from "phaser";
+import { Synth8Plugin } from "@vibuca/synth8-phaser";
+
+const config: Phaser.Types.Core.GameConfig = {
+  type: Phaser.AUTO,
+  width: 800,
+  height: 600,
+  scene: [GameScene],
+  plugins: {
+    scene: [
+      {
+        key: "Synth8Plugin",
+        plugin: Synth8Plugin,
+        mapping: "synth8",
+      },
+    ],
+  },
+};
+```
+
+## TypeScript scene typing
+
+```ts
+declare global {
+  namespace Phaser {
+    interface Scene {
+      synth8: Synth8Plugin;
+    }
+  }
+}
+```
+
+## Play music
+
+```ts
+await this.synth8.startAudio({
+  masterVolume: 1,
+  musicVolume: 0.7,
+  sfxVolume: 1,
+});
+
+await this.synth8.playMusic(
+  `song(
+    melody("c4 e4 g4 c5")
+      .preset("chip-lead")
+      .loop(),
+
+    beat("kick _ snare _")
+      .bank("arcade")
+      .loop()
+  )`,
+  {
+    bpm: 150,
+  }
+);
+```
+
+## Stop music
+
+```ts
+this.synth8.stopMusic();
+```
+
+## Pause and resume music
+
+```ts
+this.synth8.pauseMusic();
+this.synth8.resumeMusic();
+this.synth8.stopMusic();
+```
+
+## Sound effects
+
+Prepare SFX once:
+
+```ts
+await this.synth8.prepareSfx(
+  "laser",
+  `melody("c7/16 g6/16 c6/16")
+    .preset("arcade-pluck")
+    .fast(16)
+    .gain(0.5)`,
+  {
+    bpm: 180,
+    voices: 10,
+  }
+);
+```
+
+Trigger them during gameplay:
+
+```ts
+this.synth8.playSfx("laser");
+```
+
+## Volumes
+
+```ts
+this.synth8.setMasterVolume(1);
+this.synth8.setMusicVolume(0.7);
+this.synth8.setSfxVolume(1);
+```
+
+## License
+
+MIT

package/dist/Synth8Plugin.d.ts

@@ -0,0 +1,27 @@
+import { default as Phaser } from 'phaser';
+import { GameAudio, GameAudioOptions, GameMusicOptions, GameSfxOptions, PlayOptions, PlaySfxOptions, PreparedPlayback, PreparedSfx } from '@vibuca/synth8-player';
+export declare class Synth8Plugin extends Phaser.Plugins.ScenePlugin {
+    private gameAudio?;
+    private playback?;
+    private music?;
+    private sfx;
+    play(source: string, options?: PlayOptions): Promise<PreparedPlayback>;
+    startAudio(options?: GameAudioOptions): Promise<GameAudio>;
+    pause(): void;
+    resume(): void;
+    stop(): void;
+    startGameAudio(options?: GameAudioOptions): Promise<GameAudio>;
+    private getGameAudio;
+    playMusic(source: string, options?: GameMusicOptions): Promise<PreparedPlayback>;
+    pauseMusic(): void;
+    resumeMusic(): void;
+    stopMusic(): void;
+    prepareSfx(key: string, source: string, options?: GameSfxOptions): Promise<PreparedSfx>;
+    playSfx(key: string, options?: PlaySfxOptions): Promise<void>;
+    setMasterVolume(value: number): void;
+    setMusicVolume(value: number): void;
+    setSfxVolume(value: number): void;
+    shutdown(): void;
+    destroy(): void;
+}
+//# sourceMappingURL=Synth8Plugin.d.ts.map

package/dist/Synth8Plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Synth8Plugin.d.ts","sourceRoot":"","sources":["../src/Synth8Plugin.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,QAAQ,CAAC;AAG5B,OAAO,KAAK,EACV,SAAS,EACT,gBAAgB,EAChB,gBAAgB,EAChB,cAAc,EACd,WAAW,EACX,cAAc,EACd,gBAAgB,EAChB,WAAW,EACZ,MAAM,uBAAuB,CAAC;AAE/B,qBAAa,YAAa,SAAQ,MAAM,CAAC,OAAO,CAAC,WAAW;IAC1D,OAAO,CAAC,SAAS,CAAC,CAAY;IAC9B,OAAO,CAAC,QAAQ,CAAC,CAAmB;IACpC,OAAO,CAAC,KAAK,CAAC,CAAmB;IACjC,OAAO,CAAC,GAAG,CAAkC;IAEvC,IAAI,CACR,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,gBAAgB,CAAC;IAStB,UAAU,CAAC,OAAO,CAAC,EAAE,gBAAgB;IAK3C,KAAK;IAIL,MAAM;IAIN,IAAI;IAKE,cAAc,CAAC,OAAO,CAAC,EAAE,gBAAgB;YAIjC,YAAY;IAQpB,SAAS,CACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,gBAAgB,GACzB,OAAO,CAAC,gBAAgB,CAAC;IAW5B,UAAU;IAIV,WAAW;IAIX,SAAS;IAKH,UAAU,CACd,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,cAAmB;IAUxB,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc;IAWnD,eAAe,CAAC,KAAK,EAAE,MAAM;IAI7B,cAAc,CAAC,KAAK,EAAE,MAAM;IAI5B,YAAY,CAAC,KAAK,EAAE,MAAM;IAI1B,QAAQ;IAMR,OAAO;CAIR"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Synth8Plugin';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC"}

package/dist/index.js

@@ -0,0 +1,70 @@
+import e from "phaser";
+import { compile as t } from "@vibuca/synth8-core";
+import { createGameAudio as n, prepare as r } from "@vibuca/synth8-player";
+//#region src/Synth8Plugin.ts
+var i = class extends e.Plugins.ScenePlugin {
+	gameAudio;
+	playback;
+	music;
+	sfx = /* @__PURE__ */ new Map();
+	async play(e, n = {}) {
+		return this.playback?.stop(), this.playback = await r(t(e), n), this.playback.start(), this.playback;
+	}
+	async startAudio(e) {
+		return this.gameAudio = await n(e), this.gameAudio;
+	}
+	pause() {
+		this.playback?.pause();
+	}
+	resume() {
+		this.playback?.resume();
+	}
+	stop() {
+		this.playback?.stop(), this.playback = void 0;
+	}
+	async startGameAudio(e) {
+		return this.startAudio(e);
+	}
+	async getGameAudio() {
+		return this.gameAudio ||= await n(), this.gameAudio;
+	}
+	async playMusic(e, n) {
+		let r = await this.getGameAudio();
+		return this.music?.stop(), this.music = await r.prepareMusic(t(e), n), this.music.start(), this.music;
+	}
+	pauseMusic() {
+		this.music?.pause();
+	}
+	resumeMusic() {
+		this.music?.resume();
+	}
+	stopMusic() {
+		this.music?.stop(), this.music = void 0;
+	}
+	async prepareSfx(e, n, r = {}) {
+		let i = await (await this.getGameAudio()).prepareSfx(t(n), r);
+		return this.sfx.set(e, i), i;
+	}
+	async playSfx(e, t) {
+		let n = await this.getGameAudio(), r = this.sfx.get(e);
+		if (!r) throw Error(`Unknown Synth8 SFX: ${e}`);
+		n.playSfx(r, t);
+	}
+	setMasterVolume(e) {
+		this.gameAudio?.setMasterVolume(e);
+	}
+	setMusicVolume(e) {
+		this.gameAudio?.setMusicVolume(e);
+	}
+	setSfxVolume(e) {
+		this.gameAudio?.setSfxVolume(e);
+	}
+	shutdown() {
+		this.stop(), this.stopMusic(), this.sfx.clear();
+	}
+	destroy() {
+		this.shutdown(), super.destroy();
+	}
+};
+//#endregion
+export { i as Synth8Plugin };

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@vibuca/synth8-phaser-plugin",
+  "version": "0.1.0",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "peerDependencies": {
+    "@vibuca/synth8-core": "^1.0.0",
+    "@vibuca/synth8-player": "^1.0.2",
+    "phaser": "^3.90.0"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "devDependencies": {
+    "unplugin-dts": "^1.0.2"
+  },
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build"
+  }
+}