8bit-sfx

8bit-sfx

Version: 1.0.0

8888 chip sound effects across 44 categories — synthesized on demand, not downloaded. There are no audio files in this package. Every effect is a deterministic function of its name, so render('kick_003') produces the same samples in a browser, in Node, today and in five years. Game SFX and musical sound design, every effect carrying a catalog description so you can find what you need by reading instead of auditioning. MIT licensed — use them in anything.

Try them: https://cportka.github.io/8bit-sfx/ — the whole library, synthesized live in your browser as you click.

Install & use

npm install 8bit-sfx

import { SfxPlayer, render, renderWav, describe, effectNames } from '8bit-sfx';

// Play — no preloading, no fetching, nothing to bundle
const sfx = new SfxPlayer();
button.addEventListener('click', () => {
  sfx.resume();              // browsers gate audio on a user gesture
  sfx.play('kick_003');      // synthesized on first use, then cached
  sfx.play('bass_120', { volume: 0.8, rate: 1.0 });
});

describe('bass_120');        // "wobble bass — ramp LFO on amp gate, 8.6 Hz at A1"
render('snare_012');         // Float32Array, 22050 Hz mono — feed it anywhere
renderWav('rpg_levelup');    // Uint8Array: a complete .wav file, if you want a file
effectNames();               // all 8888 names, no synthesis

Dependency-free and build-free — pure ES modules, no bundler required, no assets to copy. The package is a 377 kB download (3.0 MB unpacked): ~940 KB of engine plus the 2 MB catalog. No audio ships — 8888 sounds cost kilobytes of code instead of ~130 MB of WAVs.

API

Categories

Each category holds 202 effects, named <category>_000 … <category>_201. (The one exception is rpg: rpg_000–rpg_173 plus the 28 ported sounds under their event names.)

Game sounds

Musical sound design

The rpg category also contains the complete sound set of pixel-rpg — 28 sounds ported exactly from that game's Web Audio engine, keeping their event names (rpg_levelup, rpg_menu-open, …) and the game's intended relative loudness in the catalog's gain field.

Exporting WAV files (optional)

The library never needs files, but you can have them:

npm run generate                       # every effect -> sfx/<category>/<name>.wav
npm run catalog                        # just rebuild sfx/manifest.json
node scripts/generate.mjs --only kick_003 rpg_levelup

sfx/*.wav is git-ignored — it's an export, not a source. The testing page also has a ⬇ button on every row that exports that one effect. Only sfx/manifest.json (the catalog) is committed and shipped.

How it works

src/dsp.js holds the chip-synth primitives: a seeded xorshift PRNG, NES-style 15-bit LFSR noise, square/triangle/sawtooth oscillators, and a 16-level amplitude quantizer that gives the library its 4-bit-DAC voice. Each category in src/generators/ is a small module that draws its parameters from the PRNG, renders samples, and records what it chose — which is where the descriptions come from, so they always describe the actual synthesis rather than an intention. Because the PRNG is seeded from the effect's name, the whole library is reproducible from under a megabyte of code.

Stability

1.0.0 is a stable API commitment: the exported functions, the manifest entry shape, and effect naming are covered by SemVer. Effects only ever get appended — existing names keep their sound.

License

MIT — free for commercial and non-commercial use, attribution appreciated but not required.