@wowserhq/stormjs

StormJS

StormJS is StormLib for Javascript, powered by Emscripten.

StormLib is copyright © Ladislav Zezula. It is licensed under the MIT license. See src/vendor/StormLib/LICENSE for more information.

Usage

To install StormJS:

npm install @wowserhq/stormjs

To use StormJS in an ES2015 module environment:

import { FS, MPQ } from '@wowserhq/stormjs';

// Mount the local filesystem path /home/wowserhq/example as /stormjs
// This approach is suitable for cases where StormJS is running under Node
FS.mkdir('/stormjs');
FS.mount(FS.filesystems.NODEFS, { root: '/home/wowserhq/example' }, '/stormjs');

const mpq = await MPQ.open('/stormjs/example.mpq', 'r');
const file = base.openFile('example.txt');
const data = file.read();

// Clean up
file.close();
mpq.close();

Note that StormJS loads in production mode if NODE_ENV is set to production. In all other cases, StormJS loads in debug mode.

Compatibility

StormJS is tested against Node 10, 12, and 14.

Additionally, StormJS should work well in browsers with support for WASM. Note that use in browsers will require configuring an Emscripten filesystem type appropriate for the browser.

Development

Development of StormJS requires git, CMake, and an Emscripten environment.

emsdk is the simplest way to get an Emscripten environment up and running.

StormJS is currently built using Emscripten 1.39.15.

After cloning the StormJS repo, ensure all submodules are also pulled down from remote by running:

git submodule update --init --recursive

To build StormJS after making changes locally, run:

npm run build

The test suites for StormJS can be run using:

npm run test