stormlib v0.0.3

JStormLib

NodeJS wrapper for StormLib. see(https://github.com/ladislav-zezula/StormLib).

I just use it to generate StarCraft1 maps, so no more options. Currently, just only working on windows.

Installation

You need to compile StormLib(ReleaseAS|x64) first.

You also need to install node-gyp(https://github.com/nodejs/node-gyp)

install Nan(https://github.com/nodejs/nan)

npm install

Build

node-gyp build

TODO

Support MacOSX, Linux

API

JStormLib.open

Open a MPQ archive, return a Promise.

JStormLib.open(filepath).then(arcive => {
    //archive.
}, err => {
    console.log(err)
});

JStormLib.create

Create a new MPQ archive.

JStormLib.create(filepath, flags, maxFileCount).then(arcive => {
    //archive.
}, err => {
    console.log(err)
});

CreateArchiveFlags

Specifies additional flags for MPQ creation process. This parameter can be combination of the following flags:

StormArchive.getLocale

JStormLib.open(filepath).then(arcive => {
    archive.getLocale();
}, err => {
    console.log(err)
});

Returns current locale ID for adding new files

StormArchive.setLocale

archive.setLocale(lcid);

Changes default locale ID for adding new files

what is LCID?

StormArchive.getFileList

archive.getFileList();
// ['a.txt', 'b.txt]

get a list of all files in the current archive

StormArchive.readFile

archive.readFile(filename).then(fileBuffer => {
    //save the buffer;
}, err => {
    console.log(err);
})

read file data by the specified file name.

StormArchive.writeFile

archive.writeFile(buffer, filename, lcid, flags, compression).then(fileBuffer => {
    //save the buffer;
}, err => {
    console.log(err);
})

writes data to the archive.

WriteFileFlags

Specifies additional options about how to add the file to the MPQ. The value of this parameter can be a combination of the following values:

StarCraft1 Map(.scx, .scm) use 0x00010200

WriteFileCompression

Compression method of the first file block. This parameter is ignored if MPQ_FILE_COMPRESS is not specified in dwFlags. This parameter can be a combination of the following values:

StarCraft1 Map(.scx, .scm) use 0x08