fix: read dvpl files

packages/core/src/blitz/index.ts

@@ -1,32 +1,33 @@
-export * from './canSplash';
-export * from './clans';
-export * from './classes';
-export * from './constants';
-export * from './equipmentPrice';
-export * from './fetchBlitz';
-export * from './fetchGlossary';
-export * from './generateStats';
-export * from './getAccountAchievements';
-export * from './getAccountInfo';
-export * from './getClanAccountInfo';
-export * from './getClanInfo';
-export * from './getLeagueFromScore';
-export * from './getRatingInfo';
-export * from './getRatingLeague';
-export * from './getRatingNeighbors';
-export * from './getTankStats';
-export * from './idToRegion';
-export * from './isOnGoingRatingSeason';
-export * from './isValidBlitzId';
-export * from './nations';
-export * from './normalizeExtra';
-export * from './normalizeIds';
-export * from './permanentSkills';
-export * from './rating';
-export * from './regions';
-export * from './regionSubdomainToRegion';
-export * from './regionToRegionSubdomain';
-export * from './searchClansAcrossRegions';
-export * from './searchCurrentRatingPlayers';
-export * from './searchPlayersAcrossRegions';
-export * from './toUniqueId';
+export * from "./canSplash";
+export * from "./clans";
+export * from "./classes";
+export * from "./constants";
+export * from "./equipmentPrice";
+export * from "./fetchBlitz";
+export * from "./fetchGlossary";
+export * from "./generateStats";
+export * from "./getAccountAchievements";
+export * from "./getAccountInfo";
+export * from "./getClanAccountInfo";
+export * from "./getClanInfo";
+export * from "./getLeagueFromScore";
+export * from "./getRatingInfo";
+export * from "./getRatingLeague";
+export * from "./getRatingNeighbors";
+export * from "./getTankStats";
+export * from "./idToRegion";
+export * from "./isOnGoingRatingSeason";
+export * from "./isValidBlitzId";
+export * from "./nations";
+export * from "./normalizeExtra";
+export * from "./normalizeIds";
+export * from "./permanentSkills";
+export * from "./rating";
+export * from "./readDVPL";
+export * from "./regions";
+export * from "./regionSubdomainToRegion";
+export * from "./regionToRegionSubdomain";
+export * from "./searchClansAcrossRegions";
+export * from "./searchCurrentRatingPlayers";
+export * from "./searchPlayersAcrossRegions";
+export * from "./toUniqueId";

packages/core/src/blitz/readDVPL.ts

@@ -0,0 +1,60 @@
+import { crc32 } from "crc";
+import { decompressBlock } from "lz4js";
+
+/**
+ * Thanks Maddoxkkm! Modified heavily to be modern.
+ * https://github.com/Maddoxkkm/dvpl_converter/
+ */
+export function readDVPL(buffer: Buffer) {
+  const footerBuffer = buffer.subarray(buffer.length - 20, buffer.length);
+
+  if (
+    footerBuffer.toString("utf8", 16, 20) !== "DVPL" ||
+    footerBuffer.length !== 20
+  ) {
+    throw new SyntaxError("Invalid DVPL footer");
+  }
+
+  const footerData = {
+    oSize: footerBuffer.readUInt32LE(0),
+    cSize: footerBuffer.readUInt32LE(4),
+    crc32: footerBuffer.readUInt32LE(8),
+    type: footerBuffer.readUInt32LE(12),
+  };
+  const targetBlock = buffer.subarray(0, buffer.length - 20);
+
+  if (targetBlock.length !== footerData.cSize) {
+    throw new RangeError("DVPL size mismatch");
+  }
+  if (crc32(targetBlock) !== footerData.crc32) {
+    throw new TypeError("DVPL CRC32 mismatch");
+  }
+
+  if (footerData.type === 0) {
+    if (!(footerData.oSize === footerData.cSize && footerData.type === 0)) {
+      throw new RangeError("DVPL type and size mismatch");
+    }
+
+    return targetBlock;
+  } else if (footerData.type === 1 || footerData.type === 2) {
+    const source = new Uint8Array(targetBlock);
+    const destination = new Uint8Array(footerData.oSize);
+    const decompressedSize = decompressBlock(
+      source,
+      destination,
+      0,
+      source.length,
+      0
+    );
+
+    if (decompressedSize !== footerData.oSize) {
+      throw new RangeError(
+        `Decompressed DVPL size mismatch (${decompressedSize} vs ${footerData.oSize})`
+      );
+    }
+
+    return Buffer.from(destination);
+  } else {
+    throw new SyntaxError("Unknown DVPL format");
+  }
+}

packages/core/src/steam/vfs.ts

@@ -1,6 +1,7 @@
 import { XMLParser } from "fast-xml-parser";
 import SteamUser, { EConnectionProtocol } from "steam-user";
 import { parse } from "yaml";
+import { readDVPL } from "../blitz";
 
 interface SteamManifestFile {
   chunks: {
@@ -91,7 +92,7 @@ export class SteamVFS {
   assert(requested: string) {
     const path = this.has(requested);
 
-    if (!path) throw new Error(`File not found: ${path}`);
+    if (!path) throw new Error(`File not found: ${requested}`);
 
     return path;
   }
@@ -120,8 +121,11 @@ export class SteamVFS {
     const downloaded: { type: "complete"; file: Buffer } =
       // @ts-expect-error
       await this.steam.downloadFile(this.app, this.depot, fileManifest);
+    let buffer = downloaded.file;
 
-    return new Uint8Array(downloaded.file);
+    if (path.endsWith(".dvpl")) buffer = readDVPL(downloaded.file);
+
+    return new Uint8Array(buffer);
   }
 
   async text(path: string) {