1. Install Band.js:

   npm install @meenie/band.js
   # or
   bun install @meenie/band.js

2. Set up your project to use ES Modules. Then, import Conductor:

   import Conductor from '@meenie/band.js';
   
   // Create a new Conductor instance.
   // Default packs (oscillators, noises, northAmerican & european rhythms, equalTemperament tuning)
   // are loaded automatically when Conductor is imported.
   const conductor = new Conductor();
   // You can also specify tuning and rhythm packs by name:
   // const conductor = new Conductor('equalTemperament', 'northAmerican');
   
   // Set time signature and tempo
   conductor.setTimeSignature(4, 4);
   conductor.setTempo(120);
   
   // Create an instrument using the default oscillators pack
   const piano = conductor.createInstrument('sine', 'oscillators');
   // Or use default pack (oscillators is the default):
   // const piano = conductor.createInstrument('sine');
   
   // Start adding notes using rhythms from the loaded rhythm pack
   piano.note('quarter', 'C4');
   piano.note('quarter', 'D4');
   piano.note('quarter', 'E4');
   piano.note('quarter', 'F4');
   
   // Tell the conductor everything is done
   const player = conductor.finish();
   
   // Start playing the music
   player.play();

• Super Mario Bros Theme - Created by me
• Tetris Theme - Created by rooktakesqueen
• Zelda Main Theme - Created by legosjedi
• Frog's Theme - Chrono Trigger - Created by Me & Jarred Mack
• Modernized examples can also be found in the examples/ directory of the project repository.

• Retro Game Music using Web Audio API and Band.js

The load(json) method expects a JSON object with the following structure:

{
  "timeSignature": [4, 4],
  "tempo": 100,
  "instruments": {
    "rightHand": {
      "name": "square",
      "pack": "oscillators"
    },
    "leftHand": {
      "name": "sawtooth",
      "pack": "oscillators"
    }
  },
  "notes": {
    "rightHand": [
      "quarter|E5, F#4|tie",
      "quarter|rest",
      "quarter|E5, F#4",
      "quarter|rest"
    ],
    "leftHand": [
      {
        "type": "note",
        "pitch": "D3",
        "rhythm": "quarter"
      }
    ]
  }
}

import Conductor from '@meenie/band.js';
import oscillatorsPack from '@meenie/band.js/instrument-packs/oscillators';
import customRhythms from './my-custom-rhythms'; // Assuming a local file

Conductor.loadPack('instrument', 'oscillators', oscillatorsPack);
Conductor.loadPack('rhythm', 'myCustomSet', customRhythms);

Data Format:

• Rhythm Pack (type: 'rhythm'): data should be an object where keys are rhythm names (e.g., 'whole', 'half') and values are their duration multipliers (e.g., 1, 0.5). Example: { whole: 1, half: 0.5 }.
• Tuning Pack (type: 'tuning'): data should be an object where keys are pitch names (e.g., 'A4', 'C#5') and values are their frequencies in Hz (e.g., 440.00, 554.37). Example: {'A4': 440.00, 'A#4': 466.16}.
• Instrument Pack (type: 'instrument'): data is typically an imported module which is a function. This function is called by Band.js with (soundName, audioContext) and should return an object with at least one method: createNote(destination, frequency?). This method is responsible for creating and returning an AudioNode (like OscillatorNode or AudioBufferSourceNode) connected to the provided destination. The frequency is provided for pitched instruments. See src/instrument-packs/ for examples like oscillators.ts or noises.ts.

If you want to contribute or build Band.js from source:

1. Clone the repository:

   git clone https://github.com/meenie/band.js.git
   cd band.js

2. Install dependencies:

   bun install

3. Build the library:

   bun run build

   This will output the bundled files to the dist/ directory.
4. Run tests:

   bun test

Copyright 2013-2025 Cody Lundquist and various contributors. Released under the MIT License (MIT).