nbs.js
Robust API for reading, manipulating, and writing OpenNBS files, inspired by NBSEditor and NBS4j.
It's cleanroom, too! No required dependencies!
🔧 Including
[!TIP] When using
jsdelivrlinks, it's recommended to use versioned links! (e.g.@encode42/nbs.js@3.0.0)
[!WARNING]
3.0.0 is not the latest version of nbs.js! The above is just an example.
🌐 Browser
<script src="https://cdn.jsdelivr.net/npm/@encode42/nbs.js"></script>Minified: https://cdn.jsdelivr.net/npm/@encode42/nbs.js/dist/umd.min.js
🦕 Module & Deno
import { Song } from "https://cdn.jsdelivr.net/npm/@encode42/nbs.js/dist/esm.js";Minified: https://cdn.jsdelivr.net/npm/@encode42/nbs.js/dist/esm.min.js
🟢 Node.js
Add the @encode42/nbs.js package from NPM using the package manager of your choice.
import { Song } from "@encode42/nbs.js"; // ESM (TypeScript, Vite, etc.)
const { Song } = require("@encode42/nbs.js"); // CJS (vanilla Node.js)❔ FAQ
How do I use this?
Install nbs.js for your platform, then refer to the documentation and examples below.
There are more examples designed for use with Node.js in the examples directory!
🌐 Browser
[!WARNING]
This likely does not currently work!
<input type="file" id="file-input">
<script src="https://cdn.jsdelivr.net/npm/@encode42/nbs.js"></script> <!-- Import nbs.js -->
<script>
window.addEventListener("load", () => {
const input = document.getElementById("file-input");
// Initialize file input
input.addEventListener("change", () => {
const songFile = input.files[0]; // Read the selected NBS file
songFile.arrayBuffer().then(buffer => { // Convert it into an ArrayBuffer
const song = NBSjs.fromArrayBuffer(buffer); // Parse the buffer
console.dir(song);
});
});
});
</script>🌐 Module
<input type="file" id="file-input">
<script src="index.js" type="module">import { fromArrayBuffer } from "https://cdn.jsdelivr.net/npm/@encode42/nbs.js/dist/esm.js"
window.addEventListener("load", () => {
const input = document.getElementById("file-input");
// Initialize file input
input.addEventListener("change", () => {
const songFile = input.files[0]; // Read the selected NBS file
songFile.arrayBuffer().then(buffer => { // Convert it into an ArrayBuffer
const song = fromArrayBuffer(buffer); // Parse the buffer
console.dir(song);
});
});
});🟢 Node.js
// ESM (TypeScript, Vite, etc.)
import { readFileSync } from "node:fs";
import { fromArrayBuffer } from "@encode42/nbs.js";
// CJS (vanilla Node.js)
const { readFileSync } = require("fs");
const { fromArrayBuffer } = require("@encode42/nbs.js");
const songFile = readFileSync("song.nbs"); // Read the selected NBS file
const buffer = new Uint8Array(songFile).buffer; // Convert it into an ArrayBuffer
const song = fromArrayBuffer(buffer); // Parse the buffer
console.dir(song);🦕 Deno
import { fromArrayBuffer } from "https://cdn.jsdelivr.net/npm/@encode42/nbs.js/dist/esm.js";
const songFile = await Deno.readFile("song.nbs"); // Read the selected NBS file
const buffer = new Uint8Array(songFile).buffer; // Convert it into an ArrayBuffer
const song = fromArrayBuffer(buffer); // Parse the buffer
console.dir(song);Is there a demo?
Yes! A demo site is located here. It serves as an example of how to read NBS files, allows you to edit the song structure, and plays the result through the browser.
This repository also contains tests that could be used as examples, and examples designed for Node.js.
Where's the changelog?
I don't create GitHub releases, but I do keep a changelog here!
🔨 Building
Ensure PNPM and Node.js are installed.
- Enter the directory containing the nbs.js source code in your terminal.
- Install the build dependencies via
pnpm install. - Run
pnpm run buildto generate the ESM and browser modules.
Generated files:
-
dist/*.js: ESM bundle files for Node.js and related -
dist/*.global.js: UMD bundle files for browser scripts -
build/: Built ES2020 files.