wadlrr v0.3.1

wadlrr

A Node.js interface for creating, extracting, modifying, and reading LRR WAD files.

API

indexOf

This function finds the index of a given path in a WAD file.

Parameters

• wadMeta Object any valid WAD metadata object
• filePath string the relative or absolute path of a file contained in the WAD

Returns Number the index that the file was found at

exists

This function checks if a file exists given path in a WAD file.

Parameters

• wadMeta Object any valid WAD metadata object
• filePath string the relative path of the file in question

Returns Boolean

getObjectFromFile

This function reads data for a given object from an open WAD file.

Parameters

• fd Number file descriptor for the open WAD file
• object Object the object's metadata

Returns Promise<Buffer> resolves to a buffer containing the object data

getObjectMeta

This function returns the object metadata at a given path in a WAD file or throws an error if the file doesn't exist.

Parameters

• wadMeta Object any valid WAD metadata object
• filePath string the relative path of a file contained in the WAD

Returns Object resolves to the object metadata

getObject

This function reads a buffer from a given WAD that represents the actual object data.

Parameters

• wadMeta Object any valid WAD metadata object
• object Object the object's metadata

Returns Promise<Buffer> resolves to a buffer containing the object data

getObjectAtPath

This function reads a buffer that represents object data at a given path.

Parameters

• wadMeta Object any valid WAD metadata object
• filePath string the object's internal path

Returns Promise<Buffer> a buffer containing the object data

getObjectStream

This function gets a read stream for a given object

Parameters

• wadMeta Object any valid WAD metadata object
• object Object the object's metadata

Returns ReadStream a read stream for the object

getObjectStreamAtPath

This function gets a stream for object data at a given path.

Parameters

• wadMeta Object any valid WAD metadata object
• filePath string the object's internal path

Returns ReadStream a read stream for the object

extract

This function extracts all files from a given WAD.

Parameters

• wadMeta Object any valid WAD metadata object
• outputPath string the base output path (optional, default path.basename(wadMeta.source,'.wad'))

Returns Promise resolves when all files have been extracted

parse

This function parses a WAD file's metadata.

Parameters

• filename string the filename of the wad (actual or artificial)
• data Buffer the raw file data buffer

Returns Object metadata describing the WAD

load

This function loads data from a file and parses it.

Parameters

• wadPath string path to the WAD file itself

Returns Object metadata describing the WAD