@modplayjs/fmt-fc 0.0.0-stage → 0.2.1

package/README.md

@@ -1,3 +1,42 @@
-# Temporary Holding Version
+# @modplayjs/fmt-fc
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+**Future Composer 1.0–1.4 (.fc13/.fc14, SMOD) plugin** for
+`@modplayjs/core`. The loader is a 1:1 port of OpenMPT's
+`Load_fc.cpp` (header validation, playlist, pattern decode with
+per-channel transposes, E0–EA script translation with the
+volume-underflow quirk, built-in waveforms, SSMP sub-samples).
+
+Playback drives the **InstrumentSynth engine port** (`synth.ts`) — the
+same synth OpenMPT uses for FC/MED/GT2 scripts — through the core's
+EffectPlugin hooks. Pitch mapping is exact (the FC pitch block reads the
+loader NoteMap exactly like C) and all 20 test-corpus files load.
+
+Known synth-engine deltas vs OpenMPT (swapSampleIndex bookkeeping,
+MED_JumpScript sibling-state access) are tracked in
+[docs/REMAINING-PARITY.md](../../docs/REMAINING-PARITY.md).
+
+## Install
+
+```sh
+npm install @modplayjs/fmt-fc
+```
+
+## Usage
+
+```ts
+import { CorePlayer } from '@modplayjs/core';
+import { plugin as fcPlugin, fcEffect } from '@modplayjs/fmt-fc';
+
+const core = new CorePlayer();
+core.registries.registerFormat(fcPlugin);
+core.registries.registerEffect(fcEffect);
+core.loadModule(bytes);   // .fc13 / .fc14
+```
+
+## Also exports
+
+`fcTest` / `fcLoad`, `setModEventReader`, and the full synth-event
+surface (`SynthState`, `ev*` command handlers) for reuse by other
+script-driven formats.
+
+Part of the [modplayjs monorepo](../../README.md). BSD-3-Clause.

package/dist/fc.d.ts

@@ -0,0 +1,15 @@
+import type { Core, EffectPlugin, FormatPlugin, LoadCtx, ModuleData } from '@modplayjs/core';
+export declare function fcTest(bytes: Uint8Array): boolean;
+export declare function fcLoad(bytes: Uint8Array, ctx: LoadCtx): ModuleData;
+declare module './fc.js' { }
+/** OpenMPT Sndmix.cpp:2197 (NextTick before volume) + :2371
+ *  (ApplyChannelState after volume) — the plugin's onTick/onTickPost run at
+ *  exactly those points in our per-channel loop. */
+export declare const fcEffect: EffectPlugin;
+/** The plugin the demo/core registers. Also wires the channel extras reset
+ *  on module start (C: new_channel_extras). */
+export declare const plugin: FormatPlugin;
+/** Wire the shared MOD event reader (called by the host after registering
+ *  both plugins — C: MOD_TYPE_MOD shares read_event_mod). */
+export declare function setModEventReader(fn: (core: Core, chn: number, row: number) => void): void;
+//# sourceMappingURL=fc.d.ts.map

package/dist/fc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fc.d.ts","sourceRoot":"","sources":["../src/fc.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAEV,IAAI,EAEJ,YAAY,EAEZ,YAAY,EAEZ,OAAO,EACP,UAAU,EAIX,MAAM,iBAAiB,CAAC;AAqazB,wBAAgB,MAAM,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAEjD;AAgDD,wBAAgB,MAAM,CAAC,KAAK,EAAE,UAAU,EAAE,GAAG,EAAE,OAAO,GAAG,UAAU,CAuWlE;AAuBD,OAAO,QAAQ,SAAS,CAAC,GAAE;AA+D3B;;oDAEoD;AACpD,eAAO,MAAM,QAAQ,EAAE,YAuLtB,CAAC;AAsHF;+CAC+C;AAC/C,eAAO,MAAM,MAAM,EAAE,YAsBpB,CAAC;AAOF;6DAC6D;AAC7D,wBAAgB,iBAAiB,CAAC,EAAE,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI,CAE1F"}