@zebbedaja/er-save-parser 0.0.6 → 0.0.7

package/README.md

@@ -62,7 +62,7 @@ async function parseFromFile(file: File): Promise<Save> {
 ### `Save` (root)
 | Field | Type | Description |
 |---|---|---|
-| `magicBytes` | `string` | Hex string, always `424e4434` (`BND4`) |
+| `magicBytes` | `string` | Hex string, e.g. `424e4434` (`BND4`) |
 | `checksum` | `string` | Save file checksum |
 | `version` | `number` | Save file version |
 | `steamId` | `string` | Associated Steam64 ID |
@@ -155,7 +155,7 @@ try {
 ```
 
 The parser will throw if:
-- The file magic bytes don't match `BND4`
+- The file magic bytes don't match `BND4` or `SL2\x00`
 - Event flags reference blocks not found in the BST map
 - Calculated byte positions exceed save data bounds
 

package/dist/index.d.mts

@@ -139,7 +139,6 @@ interface EventFlag {
 }
 //#endregion
 //#region src/parser.d.ts
-declare function fn(): string;
 declare function parse(buffer: ArrayBuffer): Save;
 //#endregion
-export { Character, EventFlag, ProfileSummary, Save, Settings, Slot, fn, parse };
+export { type Character, type EventFlag, type ProfileSummary, type Save, type Settings, type Slot, parse };

package/dist/index.mjs

@@ -1,4 +1,11 @@
 //#region src/util.ts
+/**
+* Compare two ArrayBuffers for byte-by-byte equality.
+*
+* @param buf1 - The first ArrayBuffer to compare
+* @param buf2 - The second ArrayBuffer to compare
+* @returns True if both buffers have identical byte content
+*/
 function arrayBuffersEqual(buf1, buf2) {
 	if (buf1.byteLength !== buf2.byteLength) return false;
 	const view1 = new Uint8Array(buf1);
@@ -6,25 +13,58 @@ function arrayBuffersEqual(buf1, buf2) {
 	for (let i = 0; i < view1.length; i++) if (view1[i] !== view2[i]) return false;
 	return true;
 }
+/**
+* Convert a string into an array of byte values.
+*
+* @param string - The string to convert
+* @returns An array of ASCII/Unicode byte values for each character
+*/
 function stringToBytes(string) {
 	return [...string].map((character) => character.charCodeAt(0));
 }
+/**
+* Convert an ArrayBuffer to a lowercase hexadecimal string.
+*
+* @param buffer - The ArrayBuffer to convert
+* @returns A lowercase hexadecimal string representation of the buffer
+*/
 function toHexString(buffer) {
 	const bytes = new Uint8Array(buffer);
 	return Array.from(bytes).map((b) => b.toString(16).padStart(2, "0")).join("");
 }
+/**
+* Remove all null ('\x00') characters from a string.
+*
+* @param text - The string to clean
+* @returns The input string with all null ('\x00') characters removed
+*/
 const trim = (text) => {
 	return text?.replaceAll("\0", "");
 };
-const parseToMap = (text) => {
+/**
+* Parse a string of delimiter-separated "key,value" pairs into a Map.
+*
+* @param text - A string of delimiter-separated pairs, one per line
+* @param delimiter - The character separating key and value (default: ",")
+* @returns A Map with numeric keys and values parsed from the input
+*/
+const parseToMap = (text, delimiter = ",") => {
 	const map = /* @__PURE__ */ new Map();
 	const lines = text.trim().split("\n");
 	for (const line of lines) {
-		const [key, value] = line.trim().split(",");
+		const [key, value] = line.trim().split(delimiter);
 		if (key && value !== void 0) map.set(Number(key), Number(value));
 	}
 	return map;
 };
+/**
+* Determine whether a specific event flag is set.
+*
+* @param bstMap - A map of block IDs to their binary offsets
+* @param eventFlags - The raw event_flags byte array from the save data
+* @param eventId - The event ID to check
+* @returns True if the event flag is set (active), false otherwise
+*/
 const getEventFlagState = (bstMap, eventFlags, eventId) => {
 	const FLAG_DIVISOR = 1e3;
 	const BLOCK_SIZE = 125;
@@ -42,6 +82,11 @@ const getEventFlagState = (bstMap, eventFlags, eventId) => {
 //#endregion
 //#region src/event-flags.ts
 const eventFlags = [
+	{
+		name: "Playthrough Complete: Age of Fracture",
+		id: 20,
+		category: "ending"
+	},
 	{
 		name: "Playthrough Complete: Age of Stars",
 		id: 21,
@@ -52,6 +97,111 @@ const eventFlags = [
 		id: 22,
 		category: "ending"
 	},
+	{
+		name: "Story: Start",
+		id: 100,
+		category: "story"
+	},
+	{
+		name: "Story: Reached Tutorial",
+		id: 101,
+		category: "story"
+	},
+	{
+		name: "Story: Reached Limgrave",
+		id: 102,
+		category: "story"
+	},
+	{
+		name: "Story: Reached Roundtable Hold",
+		id: 104,
+		category: "story"
+	},
+	{
+		name: "Story: Roundtable Hold Introduction",
+		id: 105,
+		category: "story"
+	},
+	{
+		name: "Story: Received the Frenzied Flame",
+		id: 108,
+		category: "story"
+	},
+	{
+		name: "Story: Received the Frenzied Flame (back)",
+		id: 109,
+		category: "story"
+	},
+	{
+		name: "Story: Reached Forge of the Giants",
+		id: 110,
+		category: "story"
+	},
+	{
+		name: "Story: Forge of the Giants - Melina A",
+		id: 111,
+		category: "story"
+	},
+	{
+		name: "Story: Forge of the Giants - Melina B",
+		id: 112,
+		category: "story"
+	},
+	{
+		name: "Story: Ranni",
+		id: 114,
+		category: "story"
+	},
+	{
+		name: "Story: Frenzied Flame Nullified",
+		id: 116,
+		category: "story"
+	},
+	{
+		name: "Story: Erdtree on Fire",
+		id: 118,
+		category: "story"
+	},
+	{
+		name: "Story: Watched Ending",
+		id: 120,
+		category: "story"
+	},
+	{
+		name: "Acquired Godrick's Great Rune",
+		id: 191,
+		category: "great-rune"
+	},
+	{
+		name: "Acquired Radahn's Great Rune",
+		id: 192,
+		category: "great-rune"
+	},
+	{
+		name: "Acquired Morgott's Great Rune",
+		id: 193,
+		category: "great-rune"
+	},
+	{
+		name: "Acquired Rykard's Great Rune",
+		id: 194,
+		category: "great-rune"
+	},
+	{
+		name: "Acquired Mohg's Great Rune",
+		id: 195,
+		category: "great-rune"
+	},
+	{
+		name: "Acquired Malenia's Great Rune",
+		id: 196,
+		category: "great-rune"
+	},
+	{
+		name: "Acquired Great Rune of the Unborn",
+		id: 197,
+		category: "great-rune"
+	},
 	{
 		id: 10000800,
 		name: "Godrick the Grafted",
@@ -13222,9 +13372,6 @@ const bstFile = `1045540,6223
 const USER_10_DATA_START = 26215328;
 const ACTIVE_PROFILES_START = 26221828;
 const SLOT_COUNT = 10;
-function fn() {
-	return "Hello, tsdown!";
-}
 function parse(buffer) {
 	const dataView = new DataView(buffer);
 	const utf16leDecoder = new TextDecoder("utf-16le");
@@ -13233,7 +13380,7 @@ function parse(buffer) {
 	const save = {};
 	const magicBytes = buffer.slice(offset, offset + 4);
 	offset += 4;
-	if (!arrayBuffersEqual(magicBytes, new Uint8Array(stringToBytes("BND4")).buffer)) throw new Error(`File type not supported, magic bytes: ${toHexString(magicBytes)} (${utf8Decoder.decode(magicBytes)})`);
+	if (!arrayBuffersEqual(magicBytes, new Uint8Array(stringToBytes("BND4")).buffer) && !arrayBuffersEqual(magicBytes, new Uint8Array(stringToBytes("SL2\0")).buffer)) throw new Error(`File type not supported, magic bytes: ${toHexString(magicBytes)} (${utf8Decoder.decode(magicBytes)})`);
 	save.magicBytes = toHexString(magicBytes);
 	offset += 764;
 	save.slots = [];
@@ -13378,6 +13525,7 @@ function parse(buffer) {
 		}
 		slot.regions = {};
 		slot.regions.regionCount = regionCount;
+		slot.regions.regionIds = regionIds;
 		offset += 40;
 		offset += 1;
 		offset += 68;
@@ -13494,4 +13642,4 @@ function parse(buffer) {
 	return save;
 }
 //#endregion
-export { fn, parse };
+export { parse };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zebbedaja/er-save-parser",
   "type": "module",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "A parser for Elden Ring save files written in TypesScript.",
   "author": "zebbedaja",
   "license": "MIT",
@@ -33,15 +33,15 @@
   },
   "devDependencies": {
     "@eslint/js": "^10.0.1",
-    "@types/node": "^25.7.0",
+    "@types/node": "^25.9.1",
     "@typescript/native-preview": "7.0.0-dev.20260509.2",
     "bumpp": "^11.1.0",
-    "eslint": "^10.3.0",
+    "eslint": "^10.4.1",
     "eslint-config-prettier": "^10.1.8",
     "prettier": "^3.8.3",
-    "tsdown": "^0.22.0",
+    "tsdown": "^0.22.1",
     "typescript": "^6.0.3",
-    "typescript-eslint": "^8.59.3",
-    "vitest": "^4.1.6"
+    "typescript-eslint": "^8.60.0",
+    "vitest": "^4.1.7"
   }
 }