rw-parser-ng 2.0.0

package/lib/src/utils/ByteStream.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ByteStream = void 0;
+var ByteStream = /** @class */ (function () {
+    function ByteStream(stream) {
+        this._cursor = 0;
+        this._stream = stream;
+    }
+    ByteStream.prototype.readUint8 = function () {
+        var uint8 = this._stream.readUInt8(this._cursor);
+        this._cursor++;
+        return uint8;
+    };
+    ByteStream.prototype.readUint16 = function () {
+        var uint16 = this._stream.readUInt16LE(this._cursor);
+        this._cursor += 2;
+        return uint16;
+    };
+    ByteStream.prototype.readUint32 = function () {
+        var uint32 = this._stream.readUInt32LE(this._cursor);
+        this._cursor += 4;
+        return uint32;
+    };
+    ByteStream.prototype.readInt16 = function () {
+        var int16 = this._stream.readInt16LE(this._cursor);
+        this._cursor += 2;
+        return int16;
+    };
+    ByteStream.prototype.readInt32 = function () {
+        var int32 = this._stream.readInt32LE(this._cursor);
+        this._cursor += 4;
+        return int32;
+    };
+    ByteStream.prototype.readFloat = function () {
+        var float = this._stream.readFloatLE(this._cursor);
+        this._cursor += 4;
+        return float;
+    };
+    ByteStream.prototype.readString = function (size) {
+        var string = this._stream.toString('ascii', this._cursor, this._cursor + size);
+        this._cursor += size;
+        return string.split(/\0/g).shift() || '';
+    };
+    ByteStream.prototype.read = function (size) {
+        var data = new Uint8Array(size);
+        for (var i = 0; i < size; i++) {
+            data[i] = this.readUint8();
+        }
+        return data;
+    };
+    ByteStream.prototype.getSize = function () {
+        return this._stream.byteLength;
+    };
+    ByteStream.prototype.getPosition = function () {
+        return this._cursor;
+    };
+    ByteStream.prototype.setPosition = function (position) {
+        this._cursor = position;
+    };
+    ByteStream.prototype.skip = function (size) {
+        this._cursor += size;
+    };
+    return ByteStream;
+}());
+exports.ByteStream = ByteStream;

package/lib/utils/ByteStream.d.ts

@@ -0,0 +1,16 @@
+export declare class ByteStream {
+    private _cursor;
+    private _stream;
+    constructor(stream: Buffer);
+    readUint8(): number;
+    readUint16(): number;
+    readUint32(): number;
+    readInt32(): number;
+    readFloat(): number;
+    readString(size: number): string;
+    read(size: number): Uint8Array<ArrayBuffer>;
+    getSize(): number;
+    getPosition(): number;
+    setPosition(position: number): void;
+    skip(size: number): void;
+}

package/lib/utils/ByteStream.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ByteStream = void 0;
+var ByteStream = /** @class */ (function () {
+    function ByteStream(stream) {
+        this._cursor = 0;
+        this._stream = stream;
+    }
+    ByteStream.prototype.readUint8 = function () {
+        var uint8 = this._stream.readUInt8(this._cursor);
+        this._cursor++;
+        return uint8;
+    };
+    ByteStream.prototype.readUint16 = function () {
+        var uint16 = this._stream.readUInt16LE(this._cursor);
+        this._cursor += 2;
+        return uint16;
+    };
+    ByteStream.prototype.readUint32 = function () {
+        var uint32 = this._stream.readUInt32LE(this._cursor);
+        this._cursor += 4;
+        return uint32;
+    };
+    ByteStream.prototype.readInt32 = function () {
+        var int32 = this._stream.readInt32LE(this._cursor);
+        this._cursor += 4;
+        return int32;
+    };
+    ByteStream.prototype.readFloat = function () {
+        var float = this._stream.readFloatLE(this._cursor);
+        this._cursor += 4;
+        return float;
+    };
+    ByteStream.prototype.readString = function (size) {
+        var string = this._stream.toString('ascii', this._cursor, this._cursor + size);
+        this._cursor += size;
+        return string.split(/\0/g).shift() || '';
+    };
+    ByteStream.prototype.read = function (size) {
+        var data = new Uint8Array(size);
+        for (var i = 0; i < size; i++) {
+            data[i] = this.readUint8();
+        }
+        return data;
+    };
+    ByteStream.prototype.getSize = function () {
+        return this._stream.byteLength;
+    };
+    ByteStream.prototype.getPosition = function () {
+        return this._cursor;
+    };
+    ByteStream.prototype.setPosition = function (position) {
+        this._cursor = position;
+    };
+    ByteStream.prototype.skip = function (size) {
+        this._cursor += size;
+    };
+    return ByteStream;
+}());
+exports.ByteStream = ByteStream;

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "rw-parser-ng",
+  "version": "2.0.0",
+  "description": "Parses RenderWare DFF, TXD and IFP files into usable format!",
+  "author": {
+    "name": "DepsCian",
+    "url": "https://github.com/DepsCian"
+  },
+  "contributors": [
+    {
+      "name": "Timic3",
+      "url": "https://github.com/Timic3"
+    },
+    {
+      "name": "MegadreamsBE",
+      "url": "https://github.com/MegadreamsBE"
+    }
+  ],
+  "license": "GPL-3.0",
+  "homepage": "https://github.com/DepsCian/rw-parser-ng#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/DepsCian/rw-parser-ng.git"
+  },
+  "keywords": [
+    "gta",
+    "gtasa",
+    "gtavc",
+    "gtaiii",
+    "san andreas",
+    "vice city",
+    "iii",
+    "renderware",
+    "parser",
+    "rw-parser",
+    "dff",
+    "txd",
+    "ifp"
+  ],
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "devDependencies": {
+    "@types/jest": "^30.0.0",
+    "@types/node": "^24.0.3",
+    "jest": "^30.0.0",
+    "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",
+    "LICENSE",
+    "README.md",
+    "package.json",
+    "tsconfig.json"
+  ]
+}

package/src/index.ts

@@ -0,0 +1,10 @@
+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';

package/src/renderware/RwFile.ts

@@ -0,0 +1,22 @@
+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 };
+    }
+}

package/src/renderware/RwSections.ts

@@ -0,0 +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,
+}

package/src/renderware/common/types.ts

@@ -0,0 +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,
+}

package/src/renderware/dff/DffModelType.ts

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