rw-parser-ng 2.1.1 → 2.3.0

package/lib/core/rw-sections.d.ts

@@ -0,0 +1,24 @@
+export declare enum RwSections {
+    RwStruct = 1,
+    RwString = 2,
+    RwExtension = 3,
+    RwTexture = 6,
+    RwMaterial = 7,
+    RwMaterialList = 8,
+    RwFrameList = 14,
+    RwGeometry = 15,
+    RwClump = 16,
+    RwAtomic = 20,
+    RwTextureNative = 21,
+    RwTextureDictionary = 22,
+    RwGeometryList = 26,
+    RwBinMesh = 1294,
+    RwSkin = 278,
+    RwAnim = 286,
+    RwMaterialEffectsPLG = 288,
+    RwExtraVertColour = 39056121,
+    RwBreakable = 39056125,
+    RwReflectionMaterial = 39056124,
+    Rw2dEffect = 39056120,
+    RwNodeName = 39056126
+}

package/lib/core/rw-sections.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RwSections = void 0;
+var RwSections;
+(function (RwSections) {
+    RwSections[RwSections["RwStruct"] = 1] = "RwStruct";
+    RwSections[RwSections["RwString"] = 2] = "RwString";
+    RwSections[RwSections["RwExtension"] = 3] = "RwExtension";
+    RwSections[RwSections["RwTexture"] = 6] = "RwTexture";
+    RwSections[RwSections["RwMaterial"] = 7] = "RwMaterial";
+    RwSections[RwSections["RwMaterialList"] = 8] = "RwMaterialList";
+    RwSections[RwSections["RwFrameList"] = 14] = "RwFrameList";
+    RwSections[RwSections["RwGeometry"] = 15] = "RwGeometry";
+    RwSections[RwSections["RwClump"] = 16] = "RwClump";
+    RwSections[RwSections["RwAtomic"] = 20] = "RwAtomic";
+    RwSections[RwSections["RwTextureNative"] = 21] = "RwTextureNative";
+    RwSections[RwSections["RwTextureDictionary"] = 22] = "RwTextureDictionary";
+    RwSections[RwSections["RwGeometryList"] = 26] = "RwGeometryList";
+    RwSections[RwSections["RwBinMesh"] = 1294] = "RwBinMesh";
+    RwSections[RwSections["RwSkin"] = 278] = "RwSkin";
+    RwSections[RwSections["RwAnim"] = 286] = "RwAnim";
+    RwSections[RwSections["RwMaterialEffectsPLG"] = 288] = "RwMaterialEffectsPLG";
+    RwSections[RwSections["RwExtraVertColour"] = 39056121] = "RwExtraVertColour";
+    RwSections[RwSections["RwBreakable"] = 39056125] = "RwBreakable";
+    RwSections[RwSections["RwReflectionMaterial"] = 39056124] = "RwReflectionMaterial";
+    RwSections[RwSections["Rw2dEffect"] = 39056120] = "Rw2dEffect";
+    RwSections[RwSections["RwNodeName"] = 39056126] = "RwNodeName";
+})(RwSections || (exports.RwSections = RwSections = {}));

package/lib/core/rw-version.d.ts

@@ -0,0 +1,3 @@
+export declare function getVersionString(version: number): string;
+export declare function unpackVersion(version: number): number;
+export declare function unpackBuild(version: number): number;

package/lib/core/rw-version.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getVersionString = getVersionString;
+exports.unpackVersion = unpackVersion;
+exports.unpackBuild = unpackBuild;
+var VERSIONS = {
+    200704: "RenderWare 3.1.0.0 (III on PS2)",
+    204800: "RenderWare 3.2.0.0 (III on PC)",
+    208898: "RenderWare 3.3.0.2 (III on PC, VC on PS2)",
+    212995: "RenderWare 3.4.0.3 (VC on PC)",
+    212997: "RenderWare 3.4.0.5 (III on PS2, VC on Android/PC)",
+    217088: "RenderWare 3.5.0.0 (III/VC on Xbox)",
+    221187: "RenderWare 3.6.0.3 (SA)",
+};
+function getVersionString(version) {
+    var _a;
+    return (_a = VERSIONS[version]) !== null && _a !== void 0 ? _a : "";
+}
+function unpackVersion(version) {
+    if (version & 0xffff0000) {
+        return (((version >> 14) & 0x3ff00) + 0x30000) | ((version >> 16) & 0x3f);
+    }
+    return version;
+}
+function unpackBuild(version) {
+    return version & 0xffff0000 ? version & 0xffff : 0;
+}

package/lib/dff/dff-model-type.d.ts

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

package/lib/dff/dff-model-type.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DffModelType = void 0;
+var DffModelType;
+(function (DffModelType) {
+    DffModelType[DffModelType["GENERIC"] = 0] = "GENERIC";
+    DffModelType[DffModelType["SKIN"] = 1] = "SKIN";
+    DffModelType[DffModelType["VEHICLE"] = 2] = "VEHICLE";
+})(DffModelType || (exports.DffModelType = DffModelType = {}));

package/lib/dff/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./dff-model-type";
+export * from "./parser";
+export * from "./readers";
+export * from "./types";

package/lib/dff/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./dff-model-type"), exports);
+__exportStar(require("./parser"), exports);
+__exportStar(require("./readers"), exports);
+__exportStar(require("./types"), exports);

package/lib/dff/parser.d.ts

@@ -0,0 +1,5 @@
+import { RwFile } from "../core/rw-file";
+import type { RwDff } from "./types";
+export declare class DffParser extends RwFile {
+    parse(): RwDff;
+}

package/lib/dff/parser.js

@@ -0,0 +1,154 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DffParser = void 0;
+var errors_1 = require("../core/errors");
+var rw_file_1 = require("../core/rw-file");
+var rw_sections_1 = require("../core/rw-sections");
+var rw_version_1 = require("../core/rw-version");
+var dff_model_type_1 = require("./dff-model-type");
+var readers_1 = require("./readers");
+var DffParser = /** @class */ (function (_super) {
+    __extends(DffParser, _super);
+    function DffParser() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    DffParser.prototype.parse = function () {
+        var _a;
+        var version;
+        var versionNumber;
+        var atomics = [];
+        var dummies = [];
+        var animNodes = [];
+        var geometryList = null;
+        var frameList = null;
+        while (this.getPosition() < this.getSize()) {
+            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 rw_sections_1.RwSections.RwClump:
+                    versionNumber = (0, rw_version_1.unpackVersion)(header.versionNumber);
+                    version = (0, rw_version_1.getVersionString)(versionNumber);
+                    break;
+                case rw_sections_1.RwSections.RwFrameList:
+                    frameList = (0, readers_1.readFrameList)(this);
+                    break;
+                case rw_sections_1.RwSections.RwExtension: {
+                    var extHeader = this.readSectionHeader();
+                    switch (extHeader.sectionType) {
+                        case rw_sections_1.RwSections.RwNodeName:
+                            dummies.push(this.readString(extHeader.sectionSize));
+                            break;
+                        case rw_sections_1.RwSections.RwAnim:
+                            animNodes.push((0, readers_1.readAnimNode)(this));
+                            break;
+                        default:
+                            this.skip(extHeader.sectionSize);
+                            break;
+                    }
+                    break;
+                }
+                case rw_sections_1.RwSections.RwGeometryList:
+                    geometryList = (0, readers_1.readGeometryList)(this, header);
+                    break;
+                case rw_sections_1.RwSections.RwAtomic: {
+                    var atomic = (0, readers_1.readAtomic)(this);
+                    atomics[atomic.geometryIndex] = atomic.frameIndex;
+                    break;
+                }
+                case rw_sections_1.RwSections.RwNodeName:
+                    dummies.push(this.readString(header.sectionSize));
+                    break;
+                case rw_sections_1.RwSections.RwAnim:
+                    animNodes.push((0, readers_1.readAnimNode)(this));
+                    break;
+                default:
+                    this.skip(header.sectionSize);
+                    break;
+            }
+        }
+        if (!version || !versionNumber) {
+            throw new errors_1.RwParseStructureNotFoundError("version");
+        }
+        if (!((_a = geometryList === null || geometryList === void 0 ? void 0 : geometryList.geometries) === null || _a === void 0 ? void 0 : _a.length)) {
+            throw new errors_1.RwParseStructureNotFoundError("geometry list");
+        }
+        // Heuristic model type detection (not authoritative - GTA uses IDE/DAT files)
+        // Based on gta-reversed: eCarNodes.h, AtomicModelInfo.cpp, VehicleModelInfo.cpp
+        var vehiclePrefixes = [
+            "chassis",
+            "wheel_rf",
+            "wheel_lf",
+            "wheel_rb",
+            "wheel_lb",
+            "wheel_rm",
+            "wheel_lm",
+            "door_lf",
+            "door_rf",
+            "door_lr",
+            "door_rr",
+            "bonnet",
+            "boot",
+            "bump_front",
+            "bump_rear",
+            "wing_lf",
+            "wing_rf",
+            "windscreen",
+            "exhaust",
+            "boat_hi",
+            "toprotor",
+            "rearrotor",
+            "moving_rotor",
+        ];
+        var modelType = dff_model_type_1.DffModelType.GENERIC;
+        if (geometryList.geometries.some(function (g) { return g.skin; })) {
+            modelType = dff_model_type_1.DffModelType.SKIN;
+        }
+        else if (dummies.some(function (d) {
+            var lower = d.toLowerCase();
+            return vehiclePrefixes.some(function (p) { return lower.startsWith(p) || lower.includes("_".concat(p)); });
+        })) {
+            modelType = dff_model_type_1.DffModelType.VEHICLE;
+        }
+        return {
+            modelType: modelType,
+            version: version,
+            versionNumber: versionNumber,
+            geometryList: geometryList,
+            frameList: frameList,
+            atomics: atomics,
+            dummies: dummies,
+            animNodes: animNodes,
+        };
+    };
+    return DffParser;
+}(rw_file_1.RwFile));
+exports.DffParser = DffParser;

package/lib/dff/readers/2d-effect.d.ts

@@ -0,0 +1,3 @@
+import type { RwFile } from "../../core/rw-file";
+import { type Rw2dEffect } from "../types";
+export declare function read2dEffects(file: RwFile, sectionSize: number): Rw2dEffect[];

package/lib/dff/readers/2d-effect.js

@@ -0,0 +1,211 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.read2dEffects = read2dEffects;
+var types_1 = require("../types");
+function read2dEffects(file, sectionSize) {
+    var effects = [];
+    var endPosition = file.getPosition() + sectionSize;
+    var effectCount = file.readUint32();
+    for (var i = 0; i < effectCount && file.getPosition() < endPosition; i++) {
+        var effect = read2dEffect(file);
+        if (effect)
+            effects.push(effect);
+    }
+    file.setPosition(endPosition);
+    return effects;
+}
+function read2dEffect(file) {
+    var position = {
+        x: file.readFloat(),
+        y: file.readFloat(),
+        z: file.readFloat(),
+    };
+    var type = file.readUint32();
+    var dataSize = file.readUint32();
+    var dataStart = file.getPosition();
+    var effect = null;
+    switch (type) {
+        case types_1.Rw2dEffectType.LIGHT:
+            effect = readLight(file, position);
+            break;
+        case types_1.Rw2dEffectType.PARTICLE:
+            effect = readParticle(file, position);
+            break;
+        case types_1.Rw2dEffectType.ATTRACTOR:
+            effect = readAttractor(file, position);
+            break;
+        case types_1.Rw2dEffectType.ENEX:
+            effect = readEnEx(file, position);
+            break;
+        case types_1.Rw2dEffectType.ROADSIGN:
+            effect = readRoadsign(file, position);
+            break;
+        case types_1.Rw2dEffectType.COVER_POINT:
+            effect = readCoverPoint(file, position);
+            break;
+        case types_1.Rw2dEffectType.ESCALATOR:
+            effect = readEscalator(file, position);
+            break;
+        default:
+            effect = readGeneric(file, position, type, dataSize);
+            break;
+    }
+    file.setPosition(dataStart + dataSize);
+    return effect;
+}
+function readLight(file, position) {
+    var color = {
+        r: file.readUint8(),
+        g: file.readUint8(),
+        b: file.readUint8(),
+        a: file.readUint8(),
+    };
+    var coronaFarClip = file.readFloat();
+    var pointlightRange = file.readFloat();
+    var coronaSize = file.readFloat();
+    var shadowSize = file.readFloat();
+    var coronaShowMode = file.readUint8();
+    var coronaEnableReflection = file.readUint8() !== 0;
+    var coronaFlareType = file.readUint8();
+    var shadowColorMultiplier = file.readUint8();
+    var flags1 = file.readUint8();
+    var coronaTexName = file.readString(24);
+    var shadowTexName = file.readString(24);
+    var shadowZDistance = file.readUint8();
+    var flags2 = file.readUint8();
+    return {
+        type: types_1.Rw2dEffectType.LIGHT,
+        position: position,
+        color: color,
+        coronaFarClip: coronaFarClip,
+        pointlightRange: pointlightRange,
+        coronaSize: coronaSize,
+        shadowSize: shadowSize,
+        coronaShowMode: coronaShowMode,
+        coronaEnableReflection: coronaEnableReflection,
+        coronaFlareType: coronaFlareType,
+        shadowColorMultiplier: shadowColorMultiplier,
+        flags1: flags1,
+        coronaTexName: coronaTexName,
+        shadowTexName: shadowTexName,
+        shadowZDistance: shadowZDistance,
+        flags2: flags2,
+    };
+}
+function readParticle(file, position) {
+    var effectName = file.readString(24).replace(/\0+$/, "");
+    return { type: types_1.Rw2dEffectType.PARTICLE, position: position, effectName: effectName };
+}
+function readAttractor(file, position) {
+    var queueDir = {
+        x: file.readFloat(),
+        y: file.readFloat(),
+        z: file.readFloat(),
+    };
+    var useDir = {
+        x: file.readFloat(),
+        y: file.readFloat(),
+        z: file.readFloat(),
+    };
+    var forwardDir = {
+        x: file.readFloat(),
+        y: file.readFloat(),
+        z: file.readFloat(),
+    };
+    var attractorType = file.readInt8();
+    var pedExistingProbability = file.readUint8();
+    file.skip(1);
+    var flags = file.readUint8();
+    var scriptName = file.readString(8).replace(/\0+$/, "");
+    return {
+        type: types_1.Rw2dEffectType.ATTRACTOR,
+        position: position,
+        queueDir: queueDir,
+        useDir: useDir,
+        forwardDir: forwardDir,
+        attractorType: attractorType,
+        pedExistingProbability: pedExistingProbability,
+        flags: flags,
+        scriptName: scriptName,
+    };
+}
+function readEnEx(file, position) {
+    var enterAngle = file.readFloat();
+    var radiusX = file.readFloat();
+    var radiusY = file.readFloat();
+    var exitPos = {
+        x: file.readFloat(),
+        y: file.readFloat(),
+        z: file.readFloat(),
+    };
+    var exitAngle = file.readFloat();
+    var interiorId = file.readInt16();
+    var flags1 = file.readUint8();
+    var skyColor = file.readUint8();
+    var interiorName = file.readString(8).replace(/\0+$/, "");
+    var timeOn = file.readUint8();
+    var timeOff = file.readUint8();
+    var flags2 = file.readUint8();
+    return {
+        type: types_1.Rw2dEffectType.ENEX,
+        position: position,
+        enterAngle: enterAngle,
+        radiusX: radiusX,
+        radiusY: radiusY,
+        exitPos: exitPos,
+        exitAngle: exitAngle,
+        interiorId: interiorId,
+        flags1: flags1,
+        skyColor: skyColor,
+        interiorName: interiorName,
+        timeOn: timeOn,
+        timeOff: timeOff,
+        flags2: flags2,
+    };
+}
+function readRoadsign(file, position) {
+    var size = { x: file.readFloat(), y: file.readFloat() };
+    var rotation = {
+        x: file.readFloat(),
+        y: file.readFloat(),
+        z: file.readFloat(),
+    };
+    var flags = file.readUint16();
+    file.skip(2);
+    file.skip(8);
+    return {
+        type: types_1.Rw2dEffectType.ROADSIGN,
+        position: position,
+        size: size,
+        rotation: rotation,
+        flags: flags,
+        text: "",
+    };
+}
+function readCoverPoint(file, position) {
+    var coverDir = { x: file.readFloat(), y: file.readFloat() };
+    var usage = file.readUint32();
+    return { type: types_1.Rw2dEffectType.COVER_POINT, position: position, coverDir: coverDir, usage: usage };
+}
+function readEscalator(file, position) {
+    var bottom = {
+        x: file.readFloat(),
+        y: file.readFloat(),
+        z: file.readFloat(),
+    };
+    var top = { x: file.readFloat(), y: file.readFloat(), z: file.readFloat() };
+    var end = { x: file.readFloat(), y: file.readFloat(), z: file.readFloat() };
+    var direction = file.readUint8();
+    return {
+        type: types_1.Rw2dEffectType.ESCALATOR,
+        position: position,
+        bottom: bottom,
+        top: top,
+        end: end,
+        direction: direction,
+    };
+}
+function readGeneric(file, position, type, dataSize) {
+    var data = file.readBytes(dataSize);
+    return { type: type, position: position, data: data };
+}

package/lib/dff/readers/geometry.d.ts

@@ -0,0 +1,4 @@
+import type { RwFile, RwSectionHeader } from "../../core/rw-file";
+import type { RwGeometry, RwGeometryList } from "../types";
+export declare function readGeometryList(file: RwFile, header: RwSectionHeader): RwGeometryList;
+export declare function readGeometry(file: RwFile, versionNumber: number): RwGeometry;