rw-parser-ng 2.0.5 → 2.1.1

package/README.md

@@ -1,88 +1,88 @@
-# RenderWare Binary Stream Parser NG
-
-[![npm](https://img.shields.io/npm/v/rw-parser-ng.svg)](https://www.npmjs.com/package/rw-parser-ng)
-[![NPM](https://img.shields.io/npm/l/rw-parser-ng.svg)](https://github.com/DepsCian/rw-parser-ng/blob/master/LICENSE)
-
-Parses RenderWare files (`.dff`, `.txd`, `.ifp`) into a usable format.
-
-This is a fork of the original [rw-parser](https://github.com/Timic3/rw-parser) by Timic3, which is no longer active maintained. This version aims to continue development, fix bugs, and add new features.
-
-## Features
-
-*   **DFF (Model) Parsing:** Extracts geometry, materials, frames, and skinning data.
-*   **TXD (Texture Dictionary) Parsing:** Extracts texture information, including name, resolution and pixel data.
-*   **IFP (Animation) Parsing:** Extracts animation data, including bone names, keyframes, and timings.
-*   **Cross-Platform:** Works in both Node.js and modern web browsers.
-*   **TypeScript Support:** Fully typed for a better development experience.
-
-## Installation
-
-Install `rw-parser-ng` using pnpm:
-
-```bash
-pnpm install --save rw-parser-ng
-```
-
-## Usage
-
-### ES6 Module
-
-```javascript
-import { DffParser, TxdParser, IfpParser } from 'rw-parser-ng';
-import { readFileSync } from 'fs';
-
-// DFF
-const dffBuffer = readFileSync('path/to/your/model.dff');
-const dffParser = new DffParser(dffBuffer);
-const dffData = dffParser.parse();
-console.log(dffData);
-
-// TXD
-const txdBuffer = readFileSync('path/to/your/textures.txd');
-const txdParser = new TxdParser(txdBuffer);
-const txdData = txdParser.parse();
-console.log(txdData);
-
-// IFP
-const ifpBuffer = readFileSync('path/to/your/animation.ifp');
-const ifpParser = new IfpParser(ifpBuffer);
-const ifpData = ifpParser.parse();
-console.log(ifpData);
-```
-
-### Browser Usage
-
-This library can also be used in the browser. You will need a bundler like Webpack or Rollup to handle the Node.js `Buffer` dependency.
-
-```javascript
-import { DffParser } from 'rw-parser-ng';
-
-async function parseDffFromUrl(url) {
-    const response = await fetch(url);
-    const arrayBuffer = await response.arrayBuffer();
-    const buffer = Buffer.from(arrayBuffer); // Requires Buffer polyfill
-
-    const dffParser = new DffParser(buffer);
-    const dffData = dffParser.parse();
-    console.log(dffData);
-}
-
-parseDffFromUrl('path/to/your/model.dff');
-```
-
-## Development
-
-1.  Clone the repository: `git clone https://github.com/DepsCian/rw-parser-ng.git`
-2.  Install dependencies: `pnpm install`
-3.  Build the project: `pnpm run build`
-4.  Run tests: `pnpm test`
-
-To watch for changes during development, use `pnpm run dev`.
-
-## Contributing
-
-Contributions are welcome! Please feel free to open an issue or submit a pull request.
-
-## License
-
-This project is licensed under the GPL-3.0 License. See the [LICENSE](LICENSE) file for details.
+# RenderWare Binary Stream Parser NG
+
+[![npm](https://img.shields.io/npm/v/rw-parser-ng.svg)](https://www.npmjs.com/package/rw-parser-ng)
+[![NPM](https://img.shields.io/npm/l/rw-parser-ng.svg)](https://github.com/DepsCian/rw-parser-ng/blob/master/LICENSE)
+
+Parses RenderWare files (`.dff`, `.txd`, `.ifp`) into a usable format.
+
+This is a fork of the original [rw-parser](https://github.com/Timic3/rw-parser) by Timic3, which is no longer active maintained. This version aims to continue development, fix bugs, and add new features.
+
+## Features
+
+*   **DFF (Model) Parsing:** Extracts geometry, materials, frames, and skinning data.
+*   **TXD (Texture Dictionary) Parsing:** Extracts texture information, including name, resolution and pixel data.
+*   **IFP (Animation) Parsing:** Extracts animation data, including bone names, keyframes, and timings.
+*   **Cross-Platform:** Works in both Node.js and modern web browsers.
+*   **TypeScript Support:** Fully typed for a better development experience.
+
+## Installation
+
+Install `rw-parser-ng` using pnpm:
+
+```bash
+pnpm install --save rw-parser-ng
+```
+
+## Usage
+
+### ES6 Module
+
+```javascript
+import { DffParser, TxdParser, IfpParser } from 'rw-parser-ng';
+import { readFileSync } from 'fs';
+
+// DFF
+const dffBuffer = readFileSync('path/to/your/model.dff');
+const dffParser = new DffParser(dffBuffer);
+const dffData = dffParser.parse();
+console.log(dffData);
+
+// TXD
+const txdBuffer = readFileSync('path/to/your/textures.txd');
+const txdParser = new TxdParser(txdBuffer);
+const txdData = txdParser.parse();
+console.log(txdData);
+
+// IFP
+const ifpBuffer = readFileSync('path/to/your/animation.ifp');
+const ifpParser = new IfpParser(ifpBuffer);
+const ifpData = ifpParser.parse();
+console.log(ifpData);
+```
+
+### Browser Usage
+
+This library can also be used in the browser. You will need a bundler like Webpack or Rollup to handle the Node.js `Buffer` dependency.
+
+```javascript
+import { DffParser } from 'rw-parser-ng';
+
+async function parseDffFromUrl(url) {
+    const response = await fetch(url);
+    const arrayBuffer = await response.arrayBuffer();
+    const buffer = Buffer.from(arrayBuffer); // Requires Buffer polyfill
+
+    const dffParser = new DffParser(buffer);
+    const dffData = dffParser.parse();
+    console.log(dffData);
+}
+
+parseDffFromUrl('path/to/your/model.dff');
+```
+
+## Development
+
+1.  Clone the repository: `git clone https://github.com/DepsCian/rw-parser-ng.git`
+2.  Install dependencies: `pnpm install`
+3.  Build the project: `pnpm run build`
+4.  Run tests: `pnpm test`
+
+To watch for changes during development, use `pnpm run dev`.
+
+## Contributing
+
+Contributions are welcome! Please feel free to open an issue or submit a pull request.
+
+## License
+
+This project is licensed under the GPL-3.0 License. See the [LICENSE](LICENSE) file for details.

package/lib/renderware/RwFile.js

@@ -23,6 +23,9 @@ var RwFile = /** @class */ (function (_super) {
         return _super.call(this, stream) || this;
     }
     RwFile.prototype.readSectionHeader = function () {
+        if (this.getPosition() + 12 > this.getSize()) {
+            throw new Error("Cannot read section header at offset ".concat(this.getPosition().toString(16), ": need 12 bytes but only ").concat(this.getSize() - this.getPosition(), " bytes remaining"));
+        }
         var sectionType = this.readUint32();
         var sectionSize = this.readUint32();
         var versionNumber = this.readUint32();

package/lib/renderware/dff/DffParser.js

@@ -38,13 +38,24 @@ var DffParser = /** @class */ (function (_super) {
         var geometryList = null;
         var frameList = null;
         while (this.getPosition() < this.getSize()) {
-            var header = this.readSectionHeader();
+            var header = void 0;
+            try {
+                header = this.readSectionHeader();
+            }
+            catch (error) {
+                console.warn("Failed to read section header at offset ".concat(this.getPosition().toString(16), ": ").concat(error instanceof Error ? error.message : error, ". Truncating file."));
+                break;
+            }
             if (header.sectionType === 0) {
                 break;
             }
             if (header.sectionSize == 0) {
                 continue;
             }
+            if (this.getPosition() + header.sectionSize > this.getSize()) {
+                console.warn("Section at offset ".concat(this.getPosition().toString(16), " claims size ").concat(header.sectionSize, " but only ").concat(this.getSize() - this.getPosition(), " bytes remaining. Truncating file."));
+                break;
+            }
             switch (header.sectionType) {
                 case RwSections_1.RwSections.RwClump:
                     // Multiple clumps are used in SA player models, so we should eventually support it
@@ -93,8 +104,11 @@ var DffParser = /** @class */ (function (_super) {
         if (!version || !versionNumber) {
             throw new RwParseError_1.RwParseStructureNotFoundError('version');
         }
+        if (!geometryList || !geometryList.geometries || geometryList.geometries.length === 0) {
+            throw new RwParseError_1.RwParseStructureNotFoundError('geometry list');
+        }
         var modelType = DffModelType_1.DffModelType.GENERIC;
-        if (geometryList === null || geometryList === void 0 ? void 0 : geometryList.geometries.some(function (g) { return g.skin; })) {
+        if (geometryList.geometries.some(function (g) { return g.skin; })) {
             modelType = DffModelType_1.DffModelType.SKIN;
         }
         else if (dummies.some(function (d) { return d.toLowerCase().includes('wheel') || d.toLowerCase().includes('chassis'); })) {

package/lib/renderware/txd/TxdParser.js

@@ -71,6 +71,7 @@ var TxdParser = /** @class */ (function (_super) {
         var compressed = (compressionFlags & (1 << 3)) !== 0;
         var paletteType = (rasterFormat >> 13) & 3;
         var mipWidth = width;
+        var pixelFormat = rasterFormat & 0x0F00;
         var mipHeight = height;
         var mipmaps = [];
         var palette = (paletteType !== ImageFormatEnums_1.PaletteType.PALETTE_NONE ? this.readPalette(paletteType, depth) : new Uint8Array(0));
@@ -87,7 +88,7 @@ var TxdParser = /** @class */ (function (_super) {
                         ImageFormatEnums_1.RasterFormat.RASTER_888,
                         ImageFormatEnums_1.RasterFormat.RASTER_555
                     ];
-                    var hasAlpha = ((platformId === ImageFormatEnums_1.PlatformType.D3D9 && alpha) || (platformId == ImageFormatEnums_1.PlatformType.D3D8 && !rasterFormatsWithoutAlpha.includes(rasterFormat)));
+                    var hasAlpha = ((platformId === ImageFormatEnums_1.PlatformType.D3D9 && alpha) || (platformId == ImageFormatEnums_1.PlatformType.D3D8 && !rasterFormatsWithoutAlpha.includes(pixelFormat)));
                     bitmap = Array.from(this.getBitmapWithPalette(paletteType, depth, hasAlpha, raster, palette, width, height));
                 }
                 else if (platformId === ImageFormatEnums_1.PlatformType.D3D8 && compressionFlags !== 0) {
@@ -97,7 +98,7 @@ var TxdParser = /** @class */ (function (_super) {
                     bitmap = Array.from(this.getBitmapWithDXT(d3dFormat, raster, width, height));
                 }
                 else {
-                    bitmap = Array.from(this.getBitmapWithRasterFormat(rasterFormat, raster, width, height));
+                    bitmap = Array.from(this.getBitmapWithRasterFormat(pixelFormat, raster, width, height));
                 }
                 mipmaps.push(bitmap);
             }

package/lib/utils/ByteStream.d.ts

@@ -14,4 +14,5 @@ export declare class ByteStream {
     getPosition(): number;
     setPosition(position: number): void;
     skip(size: number): void;
+    dispose(): void;
 }

package/lib/utils/ByteStream.js

@@ -60,6 +60,10 @@ var ByteStream = /** @class */ (function () {
     ByteStream.prototype.skip = function (size) {
         this._cursor += size;
     };
+    ByteStream.prototype.dispose = function () {
+        this._stream = Buffer.alloc(0);
+        this._cursor = 0;
+    };
     return ByteStream;
 }());
 exports.ByteStream = ByteStream;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rw-parser-ng",
-  "version": "2.0.5",
+  "version": "2.1.1",
   "description": "Parses RenderWare DFF, TXD and IFP files into usable format!",
   "author": {
     "name": "DepsCian",
@@ -46,6 +46,13 @@
     "ts-jest": "^29.4.0",
     "typescript": "^5.8.3"
   },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "dev": "tsc -p tsconfig.json --watch",
+    "prepare": "npm run build",
+    "test": "jest",
+    "sort:models": "tsc && node lib/scripts/sort_models.js"
+  },
   "files": [
     "lib",
     "src",
@@ -53,11 +60,5 @@
     "README.md",
     "package.json",
     "tsconfig.json"
-  ],
-  "scripts": {
-    "build": "tsc -p tsconfig.json",
-    "dev": "tsc -p tsconfig.json --watch",
-    "test": "jest",
-    "sort:models": "tsc && node lib/scripts/sort_models.js"
-  }
-}
+  ]
+}

package/src/index.ts

@@ -1,12 +1,12 @@
-export { ByteStream } from './utils/ByteStream';
-export { RwFile } from './renderware/RwFile';
-export { RwSections } from './renderware/RwSections';
-
-export * from './renderware/dff/DffParser';
-export * from './renderware/txd/TxdParser';
-export * from './renderware/ifp/IfpParser';
-
-export * from './renderware/dff/DffModelType';
-export * from './renderware/ifp/IfpData';
-
-export * from './renderware/common/types';
+export { ByteStream } from './utils/ByteStream';
+export { RwFile } from './renderware/RwFile';
+export { RwSections } from './renderware/RwSections';
+
+export * from './renderware/dff/DffParser';
+export * from './renderware/txd/TxdParser';
+export * from './renderware/ifp/IfpParser';
+
+export * from './renderware/dff/DffModelType';
+export * from './renderware/ifp/IfpData';
+
+export * from './renderware/common/types';

package/src/renderware/RwFile.ts

@@ -1,22 +1,26 @@
-import { ByteStream } from "../utils/ByteStream";
-
-export interface RwSectionHeader {
-    sectionType: number,
-    sectionSize: number,
-    versionNumber: number
-}
-
-export class RwFile extends ByteStream {
-
-    constructor(stream: Buffer) {
-        super(stream);
-    }
-
-    public readSectionHeader(): RwSectionHeader {
-        const sectionType = this.readUint32();
-        const sectionSize = this.readUint32();
-        const versionNumber = this.readUint32();
-
-        return { sectionType, sectionSize, versionNumber };
-    }
-}
+import { ByteStream } from "../utils/ByteStream";
+
+export interface RwSectionHeader {
+    sectionType: number,
+    sectionSize: number,
+    versionNumber: number
+}
+
+export class RwFile extends ByteStream {
+
+    constructor(stream: Buffer) {
+        super(stream);
+    }
+
+    public readSectionHeader(): RwSectionHeader {
+        if (this.getPosition() + 12 > this.getSize()) {
+            throw new Error(`Cannot read section header at offset ${this.getPosition().toString(16)}: need 12 bytes but only ${this.getSize() - this.getPosition()} bytes remaining`);
+        }
+        
+        const sectionType = this.readUint32();
+        const sectionSize = this.readUint32();
+        const versionNumber = this.readUint32();
+
+        return { sectionType, sectionSize, versionNumber };
+    }
+}

package/src/renderware/RwSections.ts

@@ -1,27 +1,27 @@
-export enum RwSections {
-    // Core
-    RwStruct = 0x0001,
-    RwString = 0x0002,
-    RwExtension = 0x0003,
-    RwTexture = 0x0006,
-    RwMaterial = 0x0007,
-    RwMaterialList = 0x0008,
-    RwFrameList = 0x000E,
-    RwGeometry = 0x000F,
-    RwClump = 0x0010,
-    RwAtomic = 0x0014,
-    RwTextureNative = 0x0015,
-    RwTextureDictionary = 0x0016,
-    RwGeometryList = 0x001A,
-    RwSkin = 0x116,  
-    RwAnim = 0x11E,
-
-    // Toolkit
-    RwMaterialEffectsPLG = 0x0120,
-
-    // R* specific RW plugins
-    RwReflectionMaterial = 0x0253F2FC,
-    // This was renamed to RwNodeName from RwFrame to prevent confusion.
-    // https://gtamods.com/wiki/Node_Name_(RW_Section)
-    RwNodeName = 0x0253F2FE,
-}
+export enum RwSections {
+    // Core
+    RwStruct = 0x0001,
+    RwString = 0x0002,
+    RwExtension = 0x0003,
+    RwTexture = 0x0006,
+    RwMaterial = 0x0007,
+    RwMaterialList = 0x0008,
+    RwFrameList = 0x000E,
+    RwGeometry = 0x000F,
+    RwClump = 0x0010,
+    RwAtomic = 0x0014,
+    RwTextureNative = 0x0015,
+    RwTextureDictionary = 0x0016,
+    RwGeometryList = 0x001A,
+    RwSkin = 0x116,  
+    RwAnim = 0x11E,
+
+    // Toolkit
+    RwMaterialEffectsPLG = 0x0120,
+
+    // R* specific RW plugins
+    RwReflectionMaterial = 0x0253F2FC,
+    // This was renamed to RwNodeName from RwFrame to prevent confusion.
+    // https://gtamods.com/wiki/Node_Name_(RW_Section)
+    RwNodeName = 0x0253F2FE,
+}

package/src/renderware/common/types.ts

@@ -1,59 +1,59 @@
-export interface RwVector2 {
-    x: number,
-    y: number,
-}
-
-export interface RwVector3 {
-    x: number,
-    y: number,
-    z: number,
-}
-
-export interface RwVector4 {
-    x: number,
-    y: number,
-    z: number,
-    t: number,
-}
-
-export interface RwQuaternion {
-    x: number,
-    y: number,
-    z: number,
-    w: number,
-}
-
-export interface RwMatrix3 {
-    right: RwVector3,
-    up: RwVector3,
-    at: RwVector3,
-}
-
-export interface RwMatrix4 {
-    right: RwVector4,
-    up: RwVector4,
-    at: RwVector4,
-    transform: RwVector4,
-}
-
-export interface RwColor {
-    r: number,
-    g: number,
-    b: number,
-    a: number,
-}
-
-export interface RwTextureCoordinate {
-    u: number,
-    v: number,
-}
-
-export interface RwTriangle {
-    vector: RwVector3,
-    materialId: number,
-}
-
-export interface RwSphere {
-    vector: RwVector3,
-    radius: number,
+export interface RwVector2 {
+    x: number,
+    y: number,
+}
+
+export interface RwVector3 {
+    x: number,
+    y: number,
+    z: number,
+}
+
+export interface RwVector4 {
+    x: number,
+    y: number,
+    z: number,
+    t: number,
+}
+
+export interface RwQuaternion {
+    x: number,
+    y: number,
+    z: number,
+    w: number,
+}
+
+export interface RwMatrix3 {
+    right: RwVector3,
+    up: RwVector3,
+    at: RwVector3,
+}
+
+export interface RwMatrix4 {
+    right: RwVector4,
+    up: RwVector4,
+    at: RwVector4,
+    transform: RwVector4,
+}
+
+export interface RwColor {
+    r: number,
+    g: number,
+    b: number,
+    a: number,
+}
+
+export interface RwTextureCoordinate {
+    u: number,
+    v: number,
+}
+
+export interface RwTriangle {
+    vector: RwVector3,
+    materialId: number,
+}
+
+export interface RwSphere {
+    vector: RwVector3,
+    radius: number,
 }

package/src/renderware/dff/DffModelType.ts

@@ -1,5 +1,5 @@
-export enum DffModelType {
-    GENERIC,
-    SKIN,
-    VEHICLE,
+export enum DffModelType {
+    GENERIC,
+    SKIN,
+    VEHICLE,
 }