rw-parser-ng 2.0.0

package/README.md

@@ -0,0 +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 npm:
+
+```bash
+npm 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: `npm install`
+3.  Build the project: `npm run build`
+4.  Run tests: `npm test`
+
+To watch for changes during development, use `npm 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/index.d.ts

@@ -0,0 +1,6 @@
+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/dff/DffModelType';

package/lib/index.js

@@ -0,0 +1,26 @@
+"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 });
+exports.RwSections = exports.RwFile = exports.ByteStream = void 0;
+var ByteStream_1 = require("./utils/ByteStream");
+Object.defineProperty(exports, "ByteStream", { enumerable: true, get: function () { return ByteStream_1.ByteStream; } });
+var RwFile_1 = require("./renderware/RwFile");
+Object.defineProperty(exports, "RwFile", { enumerable: true, get: function () { return RwFile_1.RwFile; } });
+var RwSections_1 = require("./renderware/RwSections");
+Object.defineProperty(exports, "RwSections", { enumerable: true, get: function () { return RwSections_1.RwSections; } });
+__exportStar(require("./renderware/dff/DffParser"), exports);
+__exportStar(require("./renderware/txd/TxdParser"), exports);
+__exportStar(require("./renderware/dff/DffModelType"), exports);

package/lib/renderware/RwFile.d.ts

@@ -0,0 +1,10 @@
+import { ByteStream } from "../utils/ByteStream";
+export interface RwSectionHeader {
+    sectionType: number;
+    sectionSize: number;
+    versionNumber: number;
+}
+export declare class RwFile extends ByteStream {
+    constructor(stream: Buffer);
+    readSectionHeader(): RwSectionHeader;
+}

package/lib/renderware/RwFile.js

@@ -0,0 +1,33 @@
+"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.RwFile = void 0;
+var ByteStream_1 = require("../utils/ByteStream");
+var RwFile = /** @class */ (function (_super) {
+    __extends(RwFile, _super);
+    function RwFile(stream) {
+        return _super.call(this, stream) || this;
+    }
+    RwFile.prototype.readSectionHeader = function () {
+        var sectionType = this.readUint32();
+        var sectionSize = this.readUint32();
+        var versionNumber = this.readUint32();
+        return { sectionType: sectionType, sectionSize: sectionSize, versionNumber: versionNumber };
+    };
+    return RwFile;
+}(ByteStream_1.ByteStream));
+exports.RwFile = RwFile;

package/lib/renderware/RwSections.d.ts

@@ -0,0 +1,20 @@
+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,
+    RwSkin = 278,
+    RwAnim = 286,
+    RwMaterialEffectsPLG = 288,
+    RwReflectionMaterial = 39056124,
+    RwNodeName = 39056126
+}

package/lib/renderware/RwSections.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RwSections = void 0;
+var RwSections;
+(function (RwSections) {
+    // Core
+    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["RwSkin"] = 278] = "RwSkin";
+    RwSections[RwSections["RwAnim"] = 286] = "RwAnim";
+    // Toolkit
+    RwSections[RwSections["RwMaterialEffectsPLG"] = 288] = "RwMaterialEffectsPLG";
+    // R* specific RW plugins
+    RwSections[RwSections["RwReflectionMaterial"] = 39056124] = "RwReflectionMaterial";
+    // This was renamed to RwNodeName from RwFrame to prevent confusion.
+    // https://gtamods.com/wiki/Node_Name_(RW_Section)
+    RwSections[RwSections["RwNodeName"] = 39056126] = "RwNodeName";
+})(RwSections || (exports.RwSections = RwSections = {}));

package/lib/renderware/dff/DffModelType.d.ts

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

package/lib/renderware/dff/DffModelType.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/renderware/dff/DffParser.d.ts

@@ -0,0 +1,155 @@
+import { RwFile } from '../RwFile';
+import { DffModelType } from './DffModelType';
+export interface RwDff {
+    modelType: DffModelType;
+    version: string;
+    versionNumber: number;
+    geometryList: RwGeometryList | null;
+    frameList: RwFrameList | null;
+    atomics: number[];
+    dummies: string[];
+    animNodes: RwAnimNode[];
+}
+export interface RwClump {
+    atomicCount: number;
+    lightCount?: number;
+    cameraCount?: number;
+}
+export interface RwAnimNode {
+    boneId: number;
+    bonesCount: number;
+    bones: RwBone[];
+}
+export interface RwBone {
+    boneId: number;
+    boneIndex: number;
+    flags: number;
+}
+export interface RwFrame {
+    rotationMatrix: RwMatrix3;
+    coordinatesOffset: RwVector3;
+    parentFrame: number;
+}
+export interface RwFrameList {
+    frameCount: number;
+    frames: RwFrame[];
+}
+export interface RwTexture {
+    textureFiltering: number;
+    uAddressing: number;
+    vAddressing: number;
+    usesMipLevels: boolean;
+    textureName: string;
+}
+export interface RwMaterial {
+    color: RwColor;
+    isTextured: boolean;
+    ambient?: number;
+    specular?: number;
+    diffuse?: number;
+    texture?: RwTexture;
+}
+export interface RwMaterialList {
+    materialInstanceCount: number;
+    materialData: RwMaterial[];
+}
+export interface RwGeometry {
+    vertexColorInformation: RwColor[];
+    textureCoordinatesCount: number;
+    textureMappingInformation: RwTextureCoordinate[][];
+    hasVertices: boolean;
+    hasNormals: boolean;
+    triangleInformation: RwTriangle[];
+    vertexInformation: RwVector3[];
+    normalInformation: RwVector3[];
+    boundingSphere?: RwSphere;
+    materialList: RwMaterialList;
+    binMesh: RwBinMesh;
+    skin?: RwSkin;
+}
+export interface RwGeometryList {
+    geometricObjectCount: number;
+    geometries: RwGeometry[];
+}
+export interface RwAtomic {
+    frameIndex: number;
+    geometryIndex: number;
+    flags: number;
+}
+export interface RwBinMesh {
+    meshCount: number;
+    meshes: RwMesh[];
+}
+export interface RwSkin {
+    boneCount: number;
+    usedBoneCount: number;
+    maxWeightsPerVertex: number;
+    boneVertexIndices: number[][];
+    vertexWeights: number[][];
+    inverseBoneMatrices: RwMatrix4[];
+}
+export interface RwMesh {
+    materialIndex: number;
+    indexCount: number;
+    indices: 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 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 RwTextureCoordinate {
+    u: number;
+    v: number;
+}
+export interface RwTriangle {
+    vector: RwVector3;
+    materialId: number;
+}
+export interface RwSphere {
+    vector: RwVector3;
+    radius: number;
+}
+export declare class DffParser extends RwFile {
+    constructor(buffer: Buffer);
+    parse(): RwDff;
+    readClump(): RwClump;
+    readFrameList(): RwFrameList;
+    readGeometryList(): RwGeometryList;
+    readGeometry(versionNumber: number): RwGeometry;
+    readBinMesh(): RwBinMesh;
+    readSkin(vertexCount: number): RwSkin;
+    readAnimNode(): RwAnimNode;
+    readMesh(): RwMesh;
+    readMaterialList(): RwMaterialList;
+    readMaterial(): RwMaterial;
+    readTexture(): RwTexture;
+    readAtomic(): RwAtomic;
+}