[#29] Add support for sprite diffs

.changeset/heavy-rings-lie.md

@@ -0,0 +1,5 @@
+---
+"@osrs-wiki/cache-mediawiki": minor
+---
+
+Add support for Sprite diffs

.gitignore

@@ -148,4 +148,5 @@ node_modules
 .vscode/settings.json
 .vscode/
 
-./**/.DS_Store
+./**/.DS_Store
+.DS_Store

src/scripts/differences/builder/builder.types.ts

@@ -7,6 +7,7 @@ import {
   NPC,
   Obj,
   Param,
+  Sprites,
   Struct,
 } from "../../../utils/cache2";
 import { PerFileLoadable } from "../../../utils/cache2/Loadable";
@@ -30,6 +31,7 @@ export type IndexFeatures =
   | IndexFeature<NPC, "Npcs">
   | IndexFeature<Obj, "Objects">
   | IndexFeature<Param, "Params">
+  | IndexFeature<Sprites, "Sprites">
   | IndexFeature<Struct, "Structs">;
 
 export const resultNameMap: { [key in Difference]: string } = {
@@ -118,4 +120,13 @@ export const indexNameMap: {
       },
     },
   },
+  [IndexType.Sprites]: {
+    name: "Sprites",
+    identifiers: ["id"],
+    fields: ["width", "height"],
+    urls: {
+      chisel: "",
+      abex: "https://abextm.github.io/cache2/#/viewer/sprite/",
+    },
+  },
 };

src/scripts/differences/differences.ts

@@ -1,6 +1,7 @@
 import { mkdir, writeFile } from "fs/promises";
 
 import differencesBuilder from "./builder";
+import { indexNameMap } from "./builder/builder.types";
 import {
   ArchiveDifferences,
   CacheDifferences,
@@ -13,12 +14,7 @@ import {
   getCacheProviderGithub,
   getCacheProviderLocal,
 } from "../../utils/cache";
-import {
-  FlatIndexData,
-  ArchiveData,
-  IndexType,
-  DiskIndexData,
-} from "../../utils/cache2";
+import { FlatIndexData, ArchiveData, DiskIndexData } from "../../utils/cache2";
 import { LazyPromise } from "../../utils/cache2/LazyPromise";
 
 /**
@@ -44,19 +40,22 @@ const differencesCache = async ({
   ).asPromise();
 
   const cacheDifferences: CacheDifferences = {};
-  // TODO: Support more than index 2
-  for (let index = 0; index <= IndexType.Configs; index++) {
-    const oldIndex = await oldCache.getIndex(index);
-    const newIndex = await newCache.getIndex(index);
-    if (oldIndex.crc !== newIndex.crc) {
-      console.log(
-        `[Index=${index}] ${oldIndex.revision} -> ${newIndex.revision}`
-      );
-      cacheDifferences[index] = differencesIndex(oldIndex, newIndex);
-    } else {
-      console.log(`No changes in index ${index}.`);
-    }
-  }
+  await Promise.all(
+    Object.keys(indexNameMap).map(async (indexString) => {
+      const index = parseInt(indexString);
+      console.log(`Checking index ${index} differences`);
+      const oldIndex = await oldCache.getIndex(index);
+      const newIndex = await newCache.getIndex(index);
+      if (oldIndex.crc !== newIndex.crc) {
+        console.log(
+          `[Index=${index}] ${oldIndex.revision} -> ${newIndex.revision}`
+        );
+        cacheDifferences[index] = differencesIndex(oldIndex, newIndex);
+      } else {
+        console.log(`No changes in index ${index}.`);
+      }
+    })
+  );
 
   const builder = differencesBuilder(cacheDifferences);
   const dir = `./out/differences`;

src/scripts/differences/file/content/sprites.ts

@@ -0,0 +1,31 @@
+import _ from "underscore";
+
+import { Reader, SpriteID, Sprites } from "../../../../utils/cache2";
+import { CompareFn } from "../../differences.types";
+import { getFileDifferences } from "../file.utils";
+
+const compareSprites: CompareFn = ({ oldFile, newFile }) => {
+  const oldEntry = oldFile
+    ? Sprites.decode(
+        new Reader(oldFile.file.data, {
+          era: "osrs",
+          indexRevision: oldFile.index.revision,
+        }),
+        <SpriteID>oldFile.archive.archive
+      )
+    : undefined;
+
+  const newEntry = newFile
+    ? Sprites.decode(
+        new Reader(newFile.file.data, {
+          era: "osrs",
+          indexRevision: newFile.index.revision,
+        }),
+        <SpriteID>newFile.archive.archive
+      )
+    : undefined;
+
+  return getFileDifferences(oldEntry, newEntry);
+};
+
+export default compareSprites;

src/scripts/differences/file/file.ts

@@ -4,6 +4,7 @@ import compareItems from "./content/items";
 import compareNpcs from "./content/npcs";
 import compareObjects from "./content/objects";
 import compareParams from "./content/params";
+import compareSprites from "./content/sprites";
 import compareStructs from "./content/struct";
 import { ConfigType, IndexType } from "../../../utils/cache2";
 import { CompareFn, FileDifferences } from "../differences.types";
@@ -23,6 +24,7 @@ const indexMap: {
     [ConfigType.Params]: compareParams,
     [ConfigType.Struct]: compareStructs,
   },
+  [IndexType.Sprites]: compareSprites,
 };
 
 /**