@drincs/pixi-vn 1.8.25 → 1.9.1

package/README.md

@@ -1,6 +1,6 @@
 # Pixi’VN - PixiJS Game Engine
 
-![pixi-vn-cover](https://github.com/user-attachments/assets/28c41fe1-c539-4ebb-b7d4-8cb9f79e089e)
+![pixi-vn-cover](https://github.com/user-attachments/assets/6a4951d3-459f-4f8d-ae3d-1342a55570e9)
 
 <p align="center">
   <a href="https://www.npmjs.com/package/@drincs/pixi-vn" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/npm/v/@drincs/pixi-vn?label=version" alt="npm version"></a>
@@ -10,37 +10,59 @@
   <a target="_blank" href="https://discord.gg/E95FZWakzp" rel="noopener noreferrer nofollow"><img alt="Discord" src="https://img.shields.io/discord/1263071210011496501?color=7289da&label=discord"></a>
 </p>
 
-Pixi’VN is a very versatile and powerful 2D game engine. It is based on JavaScript/TypeScript and [PixiJS](https://pixijs.com/).
+Pixi’VN is a very versatile and powerful story-driven engine. It is based on JavaScript/TypeScript and [PixiJS](https://pixijs.com/), and supports animated characters through [Spine 2D](https://esotericsoftware.com/) and [Live2D](https://www.live2d.com/).
 
-It provides the following features:
+Pixi’VN aims to be an innovative and fast engine, and puts a strong emphasis on AI-assisted development: an AI agent can start your game, gain all the knowledge it needs about your project through [Agent Skills](#agent-skills), and test the game by launching it in a browser — with the ability to keep driving it from the outside while it plays.
 
-- narrative management
-- provides a 2D canvas
-- providing functionality to play sounds and music
-- storage to set and get game variables.
-- saves the current state of the entire game at each "story step" giving the possibility to go back
-- functionality to save and load the current state of the game.
+You can use narrative languages that are able to take full advantage of the engine's features, as well as any custom features you add to your project. Currently supported:
 
-For a quick start, various [project templates](#project-initialization) are available. Less experienced developers can use these templates without much knowledge of JavaScript/TypeScript.
+- [_ink_](https://pixi-vn.com/ink/ink)
 
-You have the option to use various types of narrative languages ​​(in addition to JavaScript/TypeScript). Currently you can use the following:
+## Templates
 
-- [_ink_](https://pixi-vn.com/ink/ink)
+For a quick start, various project templates are available, built with React. Less experienced developers can use these templates without much knowledge of JavaScript/TypeScript.
+
+- **[Visual Novel](https://pixi-vn.com/start/make-visual-novel)**: a classic dialogue-driven experience, with characters, backgrounds, and choices.
+- **[Point & Click Adventure](https://pixi-vn.com/nqtr/make-point-and-click)**: an adventure game where the player explores scenes and interacts with objects and characters.
+- **Interactive Fiction**: feels like reading a book. Unlike a visual novel, images are shown as vignettes, just as illustrations would appear on a page.
+
+To create a new project from a template, run:
+
+```npm
+npm create pixi-vn@latest
+```
+
+### Distribution
 
-Pixi’VN does not provide built-in components to create the game UI. Instead, you should use external JavaScript frameworks to build your UI. This allows you to leverage systems such as React, Vue, etc., to create complex and high-performance **UI screens**.
+Pixi’VN is independent of any distribution technology, but strong emphasis is being placed on [Roves](https://roves.pixi-vn.com/), built by the same team behind Pixi’VN.
+
+| Platform | [Roves](https://roves.pixi-vn.com/) | [Tauri](https://v2.tauri.app/) | [Electron](https://www.electronjs.org/) |
+| -------- | -- | -- | -- |
+| Windows | ✅ | ✅ | ✅ |
+| macOS | ✅ | ✅ | ✅ |
+| Linux | ✅ | ✅ | ✅ |
+| Android | ✅ | ✅ | ❌ |
+| iOS | 🚧 | ✅ | ❌ |
+| Nintendo | 🚧 | ❌ | ❌ |
+| PlayStation | 🚧 | ❌ | ❌ |
+| Xbox | 🚧 | ❌ | ❌ |
 
 ## Wiki
 
-- [Why Pixi’VN?](https://pixi-vn.com/start/why)
-  - [Ren'Py vs Pixi’VN](https://pixi-vn.com/start/versus-renpy)
 - [Quick Start](https://pixi-vn.com/start/getting-started)
   - [Templates](https://pixi-vn.com/start/templates)
-- Make your first:
-  - [Visual Novel](https://pixi-vn.com/start/make-visual-novel)
-  - [Point & Click Adventure](https://pixi-vn.com/nqtr/make-point-and-click)
-  - [RPG game](https://pixi-vn.com/start/make-rpg)
-  - [IDE or graphical editor](https://pixi-vn.com/start/make-ide)
-  - [Game engine](https://pixi-vn.com/start/make-game-engine)
+- Features:
+  - [Characters](https://pixi-vn.com/start/character)
+  - [Narration](https://pixi-vn.com/start/narration)
+  - [Assets](https://pixi-vn.com/start/assets)
+  - [Canvas WebGL/WebGPU](https://pixi-vn.com/start/canvas)
+  - [Sounds and music](https://pixi-vn.com/start/sound)
+  - [Storage](https://pixi-vn.com/start/storage)
+  - [User Interface (UI)](https://pixi-vn.com/start/interface)
+  - [Minigames](https://pixi-vn.com/start/minigames)
+  - [AI-Generated Content](https://pixi-vn.com/start/ai-generated-content)
+  - [Save and load](https://pixi-vn.com/start/save)
+  - [Distribution](https://pixi-vn.com/start/distribution)
 
 ## Prerequisites
 
@@ -52,18 +74,6 @@ Before starting, you must have the following tools installed:
   - [Cursor](https://www.cursor.com/)
   - [VSCodium](https://vscodium.com/)
 
-## Project Initialization
-
-If you want to start from a new project, you can use the following command to initialize a new project with the Pixi’VN templates:
-
-```npm
-npm create pixi-vn@latest
-```
-
-You can see the list of available templates and interactive demos <DynamicLink href="/start/templates">here</DynamicLink>.
-
-After the project is initialized, open the project directory with your text editor (VSCode is recommended) and start developing your project.
-
 ## Installation
 
 To install the Pixi’VN package in an existing JavaScript project, use one of the following commands:
@@ -135,3 +145,26 @@ body {
   overflow: hidden;
 }
 ```
+
+## Agent Skills
+
+Pixi'VN ships a set of [Agent Skills](https://www.skills.sh/) that teach AI coding assistants (like Claude Code) how to correctly use each part of the engine. If you use Claude Code, you can install all of them into your project with:
+
+```npm
+npx skills add DRincs-Productions/pixi-vn --all
+```
+
+This installs every skill below and prompts you to pick which ones to keep. To install only specific ones, add `--skill <name>` (repeat the flag to install several, e.g. `--skill canvas --skill sound`). Use `--list` instead of installing to just see what's available. Available skills:
+
+- `getting-started` — installing the package and initializing the `Game`
+- `assets` — local vs. online assets, the manifest/bundle/alias system, and loading strategy
+- `canvas` — images, sprites, text, video, transitions and effects
+- `characters` — defining and registering characters
+- `history` — going back/rewinding and reading the narration backlog
+- `narration` — labels, dialogue and choices
+- `saves` — exporting/restoring game state and persisting save files
+- `sound` — music, sound effects and audio channels
+- `storage` — game variables, flags and stored classes
+- `testing` — driving/inspecting a running game from an AI agent or script via `Game.testing`, for automated play-testing
+- `ui` — mounting HTML/PixiJS UI layers over the canvas, screen navigation, theming, and connecting UI to storage
+- `migration` — upgrading an existing project to the current version

package/dist/{ContainerMemory-D2HtgX7w.d.cts → ContainerMemory-BpDgacyr.d.cts}

@@ -82,19 +82,6 @@ interface TickerHistory<TArgs extends TickerArgs> {
     paused?: boolean;
 }
 
-type PauseType = {
-    /**
-     * The type of the value
-     */
-    type: "pause";
-    /**
-     * Duration in seconds
-     */
-    duration: number;
-};
-
-type RepeatType = "repeat";
-
 interface TickersStep<TArgs extends TickerArgs> {
     /**
      * Ticker class name
@@ -124,7 +111,7 @@ interface TickersSequence {
     /**
      * The steps of the tickers
      */
-    steps: (TickersStep<any> | RepeatType | PauseType)[];
+    steps: TickersStep<any>[];
 }
 
 /**
@@ -389,4 +376,4 @@ interface ContainerMemory<C extends ContainerChild = ContainerChild> extends Con
     elements: CanvasBaseItemMemory[];
 }
 
-export { type AdditionalPositionsExtensionProps as A, type CanvasBaseItemMemory as C, type ListenerExtensionMemory as L, type OnEventsHandlers as O, type PauseType as P, type RepeatType as R, type TickerArgs as T, type Ticker as a, CanvasBaseItem as b, type TickerInfo as c, type TickersSequence as d, type CanvasGameState as e, type ContainerChild as f, type ListenerExtension as g, type AdditionalPositionsExtension as h, type ContainerMemory as i, type TickerHistory as j, addListenerHandler as k, analizePositionsExtensionProps as l };
+export { type AdditionalPositionsExtensionProps as A, type CanvasBaseItemMemory as C, type ListenerExtensionMemory as L, type OnEventsHandlers as O, type TickerArgs as T, type Ticker as a, CanvasBaseItem as b, type TickerInfo as c, type TickersSequence as d, type CanvasGameState as e, type ContainerChild as f, type ListenerExtension as g, type AdditionalPositionsExtension as h, type ContainerMemory as i, type TickerHistory as j, addListenerHandler as k, analizePositionsExtensionProps as l };

package/dist/{ContainerMemory-D2HtgX7w.d.ts → ContainerMemory-BpDgacyr.d.ts}

@@ -82,19 +82,6 @@ interface TickerHistory<TArgs extends TickerArgs> {
     paused?: boolean;
 }
 
-type PauseType = {
-    /**
-     * The type of the value
-     */
-    type: "pause";
-    /**
-     * Duration in seconds
-     */
-    duration: number;
-};
-
-type RepeatType = "repeat";
-
 interface TickersStep<TArgs extends TickerArgs> {
     /**
      * Ticker class name
@@ -124,7 +111,7 @@ interface TickersSequence {
     /**
      * The steps of the tickers
      */
-    steps: (TickersStep<any> | RepeatType | PauseType)[];
+    steps: TickersStep<any>[];
 }
 
 /**
@@ -389,4 +376,4 @@ interface ContainerMemory<C extends ContainerChild = ContainerChild> extends Con
     elements: CanvasBaseItemMemory[];
 }
 
-export { type AdditionalPositionsExtensionProps as A, type CanvasBaseItemMemory as C, type ListenerExtensionMemory as L, type OnEventsHandlers as O, type PauseType as P, type RepeatType as R, type TickerArgs as T, type Ticker as a, CanvasBaseItem as b, type TickerInfo as c, type TickersSequence as d, type CanvasGameState as e, type ContainerChild as f, type ListenerExtension as g, type AdditionalPositionsExtension as h, type ContainerMemory as i, type TickerHistory as j, addListenerHandler as k, analizePositionsExtensionProps as l };
+export { type AdditionalPositionsExtensionProps as A, type CanvasBaseItemMemory as C, type ListenerExtensionMemory as L, type OnEventsHandlers as O, type TickerArgs as T, type Ticker as a, CanvasBaseItem as b, type TickerInfo as c, type TickersSequence as d, type CanvasGameState as e, type ContainerChild as f, type ListenerExtension as g, type AdditionalPositionsExtension as h, type ContainerMemory as i, type TickerHistory as j, addListenerHandler as k, analizePositionsExtensionProps as l };

package/dist/{HistoryChoiceMenuOption-DVMD78W7.d.cts → HistoryChoiceMenuOption-BxMSXnyI.d.cts}

@@ -1,5 +1,5 @@
 import { S as StorageElementType } from './StorageElementType-C7ETezlL.cjs';
-import { D as DialogueInterface } from './HistoryStep-G9dUn0Lf.cjs';
+import { D as DialogueInterface } from './HistoryStep-WGB6nA4N.cjs';
 
 type CloseType = "close";
 

package/dist/{HistoryChoiceMenuOption-B8RfQz5H.d.ts → HistoryChoiceMenuOption-hSI4SHV-.d.ts}

@@ -1,5 +1,5 @@
 import { S as StorageElementType } from './StorageElementType-C7ETezlL.js';
-import { D as DialogueInterface } from './HistoryStep-G9dUn0Lf.js';
+import { D as DialogueInterface } from './HistoryStep-WGB6nA4N.js';
 
 type CloseType = "close";
 

package/dist/{HistoryGameState-CmjUtlkV.d.ts → HistoryGameState-C8ATx9K6.d.ts}

@@ -1,5 +1,5 @@
 import { GameStepState } from '@drincs/pixi-vn';
-import { H as HistoryStep } from './HistoryStep-G9dUn0Lf.js';
+import { H as HistoryStep } from './HistoryStep-WGB6nA4N.js';
 
 /**
  * Interface exported step data

package/dist/{HistoryGameState-C28NcKKl.d.cts → HistoryGameState-CGfvq5iL.d.cts}

@@ -1,5 +1,5 @@
 import { GameStepState } from '@drincs/pixi-vn';
-import { H as HistoryStep } from './HistoryStep-G9dUn0Lf.cjs';
+import { H as HistoryStep } from './HistoryStep-WGB6nA4N.cjs';
 
 /**
  * Interface exported step data

package/dist/{HistoryStep-G9dUn0Lf.d.cts → HistoryStep-WGB6nA4N.d.cts}

@@ -91,6 +91,11 @@ interface HistoryStep {
      * The input value of the player
      */
     inputValue?: StorageElementType;
+    /**
+     * Whether this step requested an input from the player (regardless of whether a
+     * default value was provided, unlike {@link inputValue} which is only set when one is).
+     */
+    isRequiredInput?: boolean;
     /**
      * The choice made by the player
      */

package/dist/{HistoryStep-G9dUn0Lf.d.ts → HistoryStep-WGB6nA4N.d.ts}

@@ -91,6 +91,11 @@ interface HistoryStep {
      * The input value of the player
      */
     inputValue?: StorageElementType;
+    /**
+     * Whether this step requested an input from the player (regardless of whether a
+     * default value was provided, unlike {@link inputValue} which is only set when one is).
+     */
+    isRequiredInput?: boolean;
     /**
      * The choice made by the player
      */

package/dist/{OpenedLabel-DLfFuZgk.d.ts → OpenedLabel-CmRdzTXP.d.ts}

@@ -1,4 +1,4 @@
-import { L as LabelIdType } from './HistoryStep-G9dUn0Lf.js';
+import { L as LabelIdType } from './HistoryStep-WGB6nA4N.js';
 
 interface OpenedLabel {
     label: LabelIdType;

package/dist/{OpenedLabel-BxfL31aQ.d.cts → OpenedLabel-Cmd675NI.d.cts}

@@ -1,4 +1,4 @@
-import { L as LabelIdType } from './HistoryStep-G9dUn0Lf.cjs';
+import { L as LabelIdType } from './HistoryStep-WGB6nA4N.cjs';
 
 interface OpenedLabel {
     label: LabelIdType;

package/dist/SoundGameState-C_6ZsQX6.d.cts

@@ -0,0 +1,186 @@
+import { PlayerOptions, Player, ToneAudioNode, ReverbOptions, FeedbackDelayOptions, FreeverbOptions, DelayOptions, PingPongDelayOptions, GateOptions, AutoFilterOptions, BiquadFilterOptions, OnePoleFilterOptions, FeedbackCombFilterOptions, FilterOptions, ChorusOptions, PhaserOptions, TremoloOptions, VibratoOptions, CompressorOptions, MidSideCompressorOptions, MultibandCompressorOptions, LimiterOptions, GreaterThanOptions, GreaterThanZeroOptions, DistortionOptions, BitCrusherOptions, Panner3DOptions, AutoPannerOptions, StereoWidenerOptions } from 'tone';
+
+interface MediaInterface extends Pick<Player, "blockTime" | "disposed" | "loaded" | "loop" | "loopEnd" | "loopStart" | "mute" | "now" | "playbackRate" | "reverse" | "restart" | "start" | "stop" | "chain" | "disconnect" | "volume" | "state"> {
+    /**
+     * Whether the sound is currently paused.
+     */
+    paused: boolean;
+    /**
+     * @deprecated Use {@link mute} instead.
+     */
+    muted: boolean;
+    /**
+     * @deprecated Use {@link playbackRate} instead.
+     */
+    speed: number;
+}
+interface MediaMemory extends Partial<Omit<PlayerOptions, "url" | "volume">> {
+    /**
+     * The volume of this sound in the linear range [0, 1], where 0 is silence
+     * and 1 is full volume. Stored and restored in linear form; converted
+     * to/from Tone.js decibels internally.
+     */
+    volume?: number;
+    elapsed: number | undefined;
+    paused: boolean;
+    delay?: number;
+}
+
+interface SoundOptions extends Pick<Partial<PlayerOptions>, "loop" | "autostart" | "fadeIn" | "fadeOut" | "mute" | "loopEnd" | "loopStart" | "reverse" | "playbackRate"> {
+    /**
+     * The volume of this sound in the linear range [0, 1], where 0 is silence
+     * and 1 is full volume.  This is converted to decibels internally before
+     * being passed to the Tone.js Player.
+     */
+    volume?: number;
+    /**
+     * A collection of audio filters/effects to apply to this sound.
+     *
+     * Install "tone" for the full list of available filters.
+     *
+     * @example
+     * ```ts
+     * import * as Tone from "tone";
+     *
+     * const filters = [new Tone.FeedbackDelay("8n", 0.5)];
+     * ```
+     */
+    filters?: ToneAudioNode[];
+    /**
+     * @deprecated Use {@link playbackRate} instead.
+     */
+    speed?: number;
+    /**
+     * @deprecated Use {@link mute} instead.
+     */
+    muted?: boolean;
+}
+interface SoundPlayOptions extends SoundOptions {
+    /**
+     * The delay in seconds before playback starts. If specified, playback is
+     * scheduled to begin after the delay has elapsed rather than starting
+     * immediately in a paused state.
+     */
+    delay?: number;
+    /**
+     * The offset in seconds from the start of the sound at which to begin playback.
+     */
+    elapsed?: number;
+}
+interface SoundPlayOptionsWithChannel extends SoundPlayOptions {
+    /**
+     * The alias of the audio channel to play the sound on. If the channel does
+     * not exist it will be created automatically.
+     * Defaults to `SoundManagerInterface.defaultChannelAlias` ("general").
+     */
+    channel?: string;
+}
+interface ChannelOptions extends Pick<SoundPlayOptions, "filters" | "muted" | "volume"> {
+    /**
+     * Whether this channel is a background channel.
+     * Background channels are special: media playing on them is not stopped
+     * when a scene changes, but continues in the background.
+     */
+    background?: boolean;
+    /**
+     * The stereo pan position for this channel in the range [-1, 1].
+     * -1 is full left, 0 is centre, 1 is full right.
+     * Defaults to 0.
+     */
+    pan?: number;
+}
+
+type SoundFilterMemory = ({
+    filterType: "ReverbFilter";
+} & Omit<Partial<ReverbOptions>, "context">) | ({
+    filterType: "FeedbackDelayFilter";
+} & Omit<Partial<FeedbackDelayOptions>, "context">) | ({
+    filterType: "FreeverbFilter";
+} & Omit<Partial<FreeverbOptions>, "context">) | ({
+    filterType: "DelayFilter";
+} & Omit<Partial<DelayOptions>, "context">) | ({
+    filterType: "PingPongDelayFilter";
+} & Omit<Partial<PingPongDelayOptions>, "context">) | ({
+    filterType: "GateFilter";
+} & Omit<Partial<GateOptions>, "context">) | ({
+    filterType: "AutoFilterFilter";
+} & Omit<Partial<AutoFilterOptions>, "context">) | ({
+    filterType: "BiquadFilterFilter";
+} & Omit<Partial<BiquadFilterOptions>, "context">) | ({
+    filterType: "OnePoleFilterFilter";
+} & Omit<Partial<OnePoleFilterOptions>, "context" | "frequency">) | ({
+    filterType: "FeedbackCombFilterFilter";
+} & Omit<Partial<FeedbackCombFilterOptions>, "context">) | ({
+    filterType: "CustomFilter";
+} & Omit<Partial<FilterOptions>, "context">) | ({
+    filterType: "ChorusFilter";
+} & Omit<Partial<ChorusOptions>, "context">) | ({
+    filterType: "PhaserFilter";
+} & Omit<Partial<PhaserOptions>, "context">) | ({
+    filterType: "TremoloFilter";
+} & Omit<Partial<TremoloOptions>, "context">) | ({
+    filterType: "VibratoFilter";
+} & Omit<Partial<VibratoOptions>, "context">) | ({
+    filterType: "CompressorFilter";
+} & Omit<Partial<CompressorOptions>, "context">) | ({
+    filterType: "MidSideCompressorFilter";
+} & Omit<Partial<MidSideCompressorOptions>, "context">) | ({
+    filterType: "MultibandCompressorFilter";
+} & Omit<Partial<MultibandCompressorOptions>, "context">) | ({
+    filterType: "LimiterFilter";
+} & Omit<Partial<LimiterOptions>, "context">) | ({
+    filterType: "GreaterThanFilter";
+} & Omit<Partial<GreaterThanOptions>, "context">) | ({
+    filterType: "GreaterThanZeroFilter";
+} & Omit<Partial<GreaterThanZeroOptions>, "context">) | ({
+    filterType: "DistortionFilter";
+} & Omit<Partial<DistortionOptions>, "context">) | ({
+    filterType: "BitCrusherFilter";
+} & Omit<Partial<BitCrusherOptions>, "context">) | ({
+    filterType: "Panner3DFilter";
+} & Omit<Partial<Panner3DOptions>, "context">) | ({
+    filterType: "AutoPannerFilter";
+} & Omit<Partial<AutoPannerOptions>, "context">) | ({
+    filterType: "StereoWidenerFilter";
+} & Omit<Partial<StereoWidenerOptions>, "context">);
+
+interface ExportedSound {
+    options: SoundOptions;
+    filters?: SoundFilterMemory[];
+}
+interface SoundPlay {
+    stepIndex: number;
+    paused: boolean;
+    options?: SoundPlayOptions | string;
+}
+interface ExportedSoundPlay extends SoundPlay {
+    sound: ExportedSound;
+}
+/**
+ * Interface exported sounds
+ */
+interface SoundGameState {
+    /**
+     * @deprecated
+     */
+    soundsPlaying?: {
+        [key: string]: ExportedSoundPlay;
+    };
+    mediaInstances: {
+        [key: string]: {
+            channelAlias: string;
+            soundAlias: string;
+            stepCounter: number;
+            options: MediaMemory & {
+                filters?: SoundFilterMemory[];
+                delay?: number;
+            };
+            /**
+             * @deprecated Use options.paused instead.
+             */
+            paused?: boolean;
+        };
+    };
+}
+
+export type { ChannelOptions as C, ExportedSound as E, MediaInterface as M, SoundGameState as S, SoundPlayOptions as a, SoundPlayOptionsWithChannel as b, MediaMemory as c, ExportedSoundPlay as d, SoundOptions as e, SoundPlay as f };

package/dist/SoundGameState-C_6ZsQX6.d.ts

@@ -0,0 +1,186 @@
+import { PlayerOptions, Player, ToneAudioNode, ReverbOptions, FeedbackDelayOptions, FreeverbOptions, DelayOptions, PingPongDelayOptions, GateOptions, AutoFilterOptions, BiquadFilterOptions, OnePoleFilterOptions, FeedbackCombFilterOptions, FilterOptions, ChorusOptions, PhaserOptions, TremoloOptions, VibratoOptions, CompressorOptions, MidSideCompressorOptions, MultibandCompressorOptions, LimiterOptions, GreaterThanOptions, GreaterThanZeroOptions, DistortionOptions, BitCrusherOptions, Panner3DOptions, AutoPannerOptions, StereoWidenerOptions } from 'tone';
+
+interface MediaInterface extends Pick<Player, "blockTime" | "disposed" | "loaded" | "loop" | "loopEnd" | "loopStart" | "mute" | "now" | "playbackRate" | "reverse" | "restart" | "start" | "stop" | "chain" | "disconnect" | "volume" | "state"> {
+    /**
+     * Whether the sound is currently paused.
+     */
+    paused: boolean;
+    /**
+     * @deprecated Use {@link mute} instead.
+     */
+    muted: boolean;
+    /**
+     * @deprecated Use {@link playbackRate} instead.
+     */
+    speed: number;
+}
+interface MediaMemory extends Partial<Omit<PlayerOptions, "url" | "volume">> {
+    /**
+     * The volume of this sound in the linear range [0, 1], where 0 is silence
+     * and 1 is full volume. Stored and restored in linear form; converted
+     * to/from Tone.js decibels internally.
+     */
+    volume?: number;
+    elapsed: number | undefined;
+    paused: boolean;
+    delay?: number;
+}
+
+interface SoundOptions extends Pick<Partial<PlayerOptions>, "loop" | "autostart" | "fadeIn" | "fadeOut" | "mute" | "loopEnd" | "loopStart" | "reverse" | "playbackRate"> {
+    /**
+     * The volume of this sound in the linear range [0, 1], where 0 is silence
+     * and 1 is full volume.  This is converted to decibels internally before
+     * being passed to the Tone.js Player.
+     */
+    volume?: number;
+    /**
+     * A collection of audio filters/effects to apply to this sound.
+     *
+     * Install "tone" for the full list of available filters.
+     *
+     * @example
+     * ```ts
+     * import * as Tone from "tone";
+     *
+     * const filters = [new Tone.FeedbackDelay("8n", 0.5)];
+     * ```
+     */
+    filters?: ToneAudioNode[];
+    /**
+     * @deprecated Use {@link playbackRate} instead.
+     */
+    speed?: number;
+    /**
+     * @deprecated Use {@link mute} instead.
+     */
+    muted?: boolean;
+}
+interface SoundPlayOptions extends SoundOptions {
+    /**
+     * The delay in seconds before playback starts. If specified, playback is
+     * scheduled to begin after the delay has elapsed rather than starting
+     * immediately in a paused state.
+     */
+    delay?: number;
+    /**
+     * The offset in seconds from the start of the sound at which to begin playback.
+     */
+    elapsed?: number;
+}
+interface SoundPlayOptionsWithChannel extends SoundPlayOptions {
+    /**
+     * The alias of the audio channel to play the sound on. If the channel does
+     * not exist it will be created automatically.
+     * Defaults to `SoundManagerInterface.defaultChannelAlias` ("general").
+     */
+    channel?: string;
+}
+interface ChannelOptions extends Pick<SoundPlayOptions, "filters" | "muted" | "volume"> {
+    /**
+     * Whether this channel is a background channel.
+     * Background channels are special: media playing on them is not stopped
+     * when a scene changes, but continues in the background.
+     */
+    background?: boolean;
+    /**
+     * The stereo pan position for this channel in the range [-1, 1].
+     * -1 is full left, 0 is centre, 1 is full right.
+     * Defaults to 0.
+     */
+    pan?: number;
+}
+
+type SoundFilterMemory = ({
+    filterType: "ReverbFilter";
+} & Omit<Partial<ReverbOptions>, "context">) | ({
+    filterType: "FeedbackDelayFilter";
+} & Omit<Partial<FeedbackDelayOptions>, "context">) | ({
+    filterType: "FreeverbFilter";
+} & Omit<Partial<FreeverbOptions>, "context">) | ({
+    filterType: "DelayFilter";
+} & Omit<Partial<DelayOptions>, "context">) | ({
+    filterType: "PingPongDelayFilter";
+} & Omit<Partial<PingPongDelayOptions>, "context">) | ({
+    filterType: "GateFilter";
+} & Omit<Partial<GateOptions>, "context">) | ({
+    filterType: "AutoFilterFilter";
+} & Omit<Partial<AutoFilterOptions>, "context">) | ({
+    filterType: "BiquadFilterFilter";
+} & Omit<Partial<BiquadFilterOptions>, "context">) | ({
+    filterType: "OnePoleFilterFilter";
+} & Omit<Partial<OnePoleFilterOptions>, "context" | "frequency">) | ({
+    filterType: "FeedbackCombFilterFilter";
+} & Omit<Partial<FeedbackCombFilterOptions>, "context">) | ({
+    filterType: "CustomFilter";
+} & Omit<Partial<FilterOptions>, "context">) | ({
+    filterType: "ChorusFilter";
+} & Omit<Partial<ChorusOptions>, "context">) | ({
+    filterType: "PhaserFilter";
+} & Omit<Partial<PhaserOptions>, "context">) | ({
+    filterType: "TremoloFilter";
+} & Omit<Partial<TremoloOptions>, "context">) | ({
+    filterType: "VibratoFilter";
+} & Omit<Partial<VibratoOptions>, "context">) | ({
+    filterType: "CompressorFilter";
+} & Omit<Partial<CompressorOptions>, "context">) | ({
+    filterType: "MidSideCompressorFilter";
+} & Omit<Partial<MidSideCompressorOptions>, "context">) | ({
+    filterType: "MultibandCompressorFilter";
+} & Omit<Partial<MultibandCompressorOptions>, "context">) | ({
+    filterType: "LimiterFilter";
+} & Omit<Partial<LimiterOptions>, "context">) | ({
+    filterType: "GreaterThanFilter";
+} & Omit<Partial<GreaterThanOptions>, "context">) | ({
+    filterType: "GreaterThanZeroFilter";
+} & Omit<Partial<GreaterThanZeroOptions>, "context">) | ({
+    filterType: "DistortionFilter";
+} & Omit<Partial<DistortionOptions>, "context">) | ({
+    filterType: "BitCrusherFilter";
+} & Omit<Partial<BitCrusherOptions>, "context">) | ({
+    filterType: "Panner3DFilter";
+} & Omit<Partial<Panner3DOptions>, "context">) | ({
+    filterType: "AutoPannerFilter";
+} & Omit<Partial<AutoPannerOptions>, "context">) | ({
+    filterType: "StereoWidenerFilter";
+} & Omit<Partial<StereoWidenerOptions>, "context">);
+
+interface ExportedSound {
+    options: SoundOptions;
+    filters?: SoundFilterMemory[];
+}
+interface SoundPlay {
+    stepIndex: number;
+    paused: boolean;
+    options?: SoundPlayOptions | string;
+}
+interface ExportedSoundPlay extends SoundPlay {
+    sound: ExportedSound;
+}
+/**
+ * Interface exported sounds
+ */
+interface SoundGameState {
+    /**
+     * @deprecated
+     */
+    soundsPlaying?: {
+        [key: string]: ExportedSoundPlay;
+    };
+    mediaInstances: {
+        [key: string]: {
+            channelAlias: string;
+            soundAlias: string;
+            stepCounter: number;
+            options: MediaMemory & {
+                filters?: SoundFilterMemory[];
+                delay?: number;
+            };
+            /**
+             * @deprecated Use options.paused instead.
+             */
+            paused?: boolean;
+        };
+    };
+}
+
+export type { ChannelOptions as C, ExportedSound as E, MediaInterface as M, SoundGameState as S, SoundPlayOptions as a, SoundPlayOptionsWithChannel as b, MediaMemory as c, ExportedSoundPlay as d, SoundOptions as e, SoundPlay as f };

package/dist/{StorageGameState-CtjNJpvE.d.cts → StorageGameState-C3PGrFPr.d.cts}

@@ -7,7 +7,7 @@ interface StorageGameStateItem<T = StorageElementType> {
 /**
  * Interface exported storage data
  */
-type StorageGameState = {
+interface StorageGameState {
     /**
      * @deprecated
      */
@@ -22,6 +22,6 @@ type StorageGameState = {
      */
     flags?: string[];
     main: StorageGameStateItem[];
-};
+}
 
 export type { StorageGameState as S };