@lewismoten/gamemaker-sandbox-tools 3.1.0 → 3.4.0

package/dist/types/web/src/walkthrough/format.d.ts

@@ -1,92 +0,0 @@
-import type { RecordedKey } from '../formats/recording.js';
-export declare const WALKTHROUGH_FPS = 60;
-export interface WalkSegment {
-    /** The scene this segment starts in. */
-    scene: number;
-    /** Key events (scan code, bit 7 = released) and the game ticks before each: encodeKeys(). */
-    keys: string;
-}
-export interface WalkChapterMark {
-    /** A chapter starts the first time play enters this scene. */
-    scene: number;
-    title: string;
-}
-interface WalkChapter {
-    title: string;
-    /** The video frame (at WALKTHROUGH_FPS) where it starts. */
-    frame: number;
-}
-export interface Walkthrough {
-    version: 1;
-    /** The game's id (games/<id>). */
-    game: string;
-    /** Monster random numbers: the seed and whether each scene starts it over, as the bot's simulator does. */
-    rand: {
-        seed: number;
-        per: 'game' | 'scene';
-    };
-    /** Seconds a "hit any key" screen stays up before the walkthrough goes on (shorter waits run out by themselves). */
-    hold?: number;
-    /** Read the storyline from the menu first (default true). */
-    story?: boolean;
-    segments: WalkSegment[];
-    chapters: WalkChapterMark[];
-    /** Made by the editor's walkthrough bot (not the game's own), for any Game-Maker game. */
-    bot?: boolean;
-    /** The bot got only partway: play stops at timeline.frames, where it got to. */
-    partial?: boolean;
-    /** A partial walkthrough's closing card: where the bot stopped and why ("It found no way through Cave."). */
-    ending?: string;
-    /** Some scenes are a person's own play (the editor's Play and record), the rest the bot's. */
-    byHand?: boolean;
-    /** Written by the tool from a run through the real engine. */
-    timeline: {
-        fps: number;
-        frames: number;
-        chapters: WalkChapter[];
-    };
-}
-export declare const DEFAULT_HOLD = 8;
-/** Key events as base64: each is the tick delta as an unsigned LEB128 number, then the scan code byte. */
-export declare function encodeKeys(keys: RecordedKey[]): string;
-export declare function decodeKeys(text: string): RecordedKey[];
-/** Key events that come at absolute ticks (t = ticks since the segment began), as deltas. */
-export declare function keysAt(events: {
-    tick: number;
-    key: number;
-}[]): RecordedKey[];
-/** m:ss or h:mm:ss, as YouTube writes chapter times. */
-export declare function clock(seconds: number): string;
-/**
- * Chapters YouTube will take: the first at 0:00, each at least 10 s long, at least three.
- * Shorter chapters are folded into the one before (the first keeps 0:00). Returns them
- * with their start in seconds; fewer than three means the video gets no chapter list.
- */
-export declare function youtubeChapters(chapters: WalkChapter[], fps: number, totalFrames: number): {
-    title: string;
-    start: number;
-}[];
-interface YoutubeText {
-    title: string;
-    description: string;
-}
-interface YoutubeInfo {
-    gameTitle: string;
-    year?: number;
-    company?: string;
-    blurb?: string;
-    /** The web app's address for this game. */
-    url: string;
-    chapters: WalkChapter[];
-    fps: number;
-    frames: number;
-    /** Made by the walkthrough bot for a game that isn't a Sandbox game: no Sandbox credits. */
-    bot?: boolean;
-    /** The bot got only partway (and where it stopped, the closing card's words). */
-    partial?: boolean;
-    ending?: string;
-    /** Some scenes were played by a person. */
-    byHand?: boolean;
-}
-export declare function youtubeText(o: YoutubeInfo): YoutubeText;
-export {};

package/dist/types/web/src/walkthrough/madeUpScores.d.ts

@@ -1,6 +0,0 @@
-import type { HighScore } from '../formats/highscore.js';
-/**
- * The table with its blank places filled: scores from a little above `score` (the
- * walkthrough's own) down to about a sixth of it, sorted best first with the real ones.
- */
-export declare function fillBlankScores(table: HighScore[], score: number, seed: number): HighScore[];

package/dist/types/web/src/walkthrough/runtime.d.ts

@@ -1,134 +0,0 @@
-import { Machine } from '../engine/machine.js';
-import { Recorder } from '../engine/recorder.js';
-import { type Session } from '../engine/scene.js';
-import type { PlayerPatches } from '../dosPlayer/patchRules.js';
-import { AudioEngine } from '../audio/engine.js';
-import type { GameFiles } from '../project/files.js';
-import { type Walkthrough } from './format.js';
-/** The walkthroughs' generator (Mulberry32), by the name the games' tools use for it. */
-export { mulberry32 as seeded } from '../seededRandom.js';
-export type AudioEvent = {
-    t: number;
-    kind: 'song';
-    bytes?: Uint8Array;
-} | {
-    t: number;
-    kind: 'stopSong';
-} | {
-    t: number;
-    kind: 'pause';
-    paused: boolean;
-} | {
-    t: number;
-    kind: 'speaker';
-    freqs: ArrayLike<number>;
-} | {
-    t: number;
-    kind: 'stopSpeaker';
-} | {
-    t: number;
-    kind: 'voc';
-    bytes?: Uint8Array;
-} | {
-    t: number;
-    kind: 'stopVoc';
-};
-/**
- * The game's sound, also written down with the walkthrough clock's time (for the video's
- * soundtrack, audioRender.ts). It plays out loud only once resume() has been called.
- */
-export declare class WalkAudio extends AudioEngine {
-    readonly events: AudioEvent[];
-    /** Keep the events (a video being made); a player that only listens leaves this off. */
-    logging: boolean;
-    now: () => number;
-    private song?;
-    private muted;
-    /** False: a PC without a Sound Blaster (PLAYGAME's SoundCard() found none): no songs, every effect on the speaker. */
-    card: boolean;
-    private log;
-    playSong(bytes: Uint8Array | undefined): Promise<boolean>;
-    stopSong(): void;
-    pauseMusic(paused: boolean): void;
-    playSpeaker(freqs: ArrayLike<number>): void;
-    stopSpeaker(): void;
-    playVoc(bytes: Uint8Array | undefined): boolean;
-    stopVoc(): void;
-    /** Starts the sound (from a click): the song playing now starts over, as it can't be joined midway. */
-    start(): Promise<void>;
-    /** Takes the Sound Blaster out or puts it back while the game plays (`session` is the game's, for its speakerOnly). */
-    setCard(on: boolean, session?: Session): void;
-    /** Silences the music and effects (the music waits where it is). */
-    setMuted(muted: boolean): void;
-}
-/** The PC the walkthrough plays on: its own clock, no live input, "hit any key" screens held `hold` seconds. */
-declare class WalkMachine extends Machine {
-    readonly hold: number;
-    time: number;
-    /** Called when the game asks for the next frame (it is idle until then). */
-    asked?: () => void;
-    private keys;
-    constructor(canvas: HTMLCanvasElement, files: GameFiles, audio: AudioEngine, hold: number);
-    now(): number;
-    frame(): Promise<void>;
-    pauseTimeKey(seconds?: number): Promise<import("../input/keyboard.js").TypedKey | undefined>;
-    /** Presses (and lets go of) a key `ms` from now, as someone at the menu would. */
-    pressIn(ms: number, scan: number): void;
-    /** Sends the keys whose time has come. */
-    typeDue(): void;
-}
-/** Plays each segment's keys from the tick its scene is entered (format.ts). */
-export declare class SegmentRecorder extends Recorder {
-    private segments;
-    private nextSegment;
-    private segKeys;
-    private segIndex;
-    private segTicks;
-    private segLast;
-    constructor(walk: Walkthrough);
-    /** Play starts: a demo playing (no high score is asked for). */
-    begin(): void;
-    enterScene(scene: number): void;
-    /** Keys still to come in all (0 once the walkthrough has played every key). */
-    get keysLeft(): number;
-    doPlayback(): number[];
-}
-/**
- * Steps a walkthrough frame by frame. Each step moves the clock one frame (1/60 s, or more
- * for a fast skip ahead) and lets the game run until it waits for the next frame.
- */
-export declare class WalkRun {
-    readonly gam: string;
-    readonly walk: Walkthrough;
-    readonly m: WalkMachine;
-    readonly audio: WalkAudio;
-    frame: number;
-    done: boolean;
-    error?: unknown;
-    session?: Session;
-    /** Chapters reached so far, with the frame each began on. */
-    readonly chapters: {
-        title: string;
-        frame: number;
-    }[];
-    onChapter?: (title: string, index: number) => void;
-    private ended;
-    private started?;
-    constructor(canvas: HTMLCanvasElement, files: GameFiles, gam: string, walk: Walkthrough, audio?: WalkAudio, 
-    /** The project's DOS player patches (dosPlayer/): the menu's words and the player's screens as its .EXE shows them. */
-    player?: PlayerPatches);
-    private run;
-    /** Waits until the game asks for a frame (or ends). */
-    private idle;
-    /** Starts the game; resolves once it waits for its first frame. */
-    start(): Promise<void>;
-    /** One frame: `ms` of game time (1000/60 by default); `show` paints the screen's canvas. */
-    step(show?: boolean, ms?: number): Promise<boolean>;
-    /** The time the game has played, in ms. */
-    get time(): number;
-    stop(): void;
-}
-/** One frame of the screen as RGBA (for the video). */
-export declare function screenRgba(m: Machine, out?: Uint8ClampedArray<ArrayBuffer>): Uint8ClampedArray;
-/** A stand-in canvas for running without a page (Node checks): the screen only needs a 2D context to put pixels in. */
-export declare function headlessCanvas(): HTMLCanvasElement;