@zebbedaja/er-save-parser 0.0.7 → 0.0.9

package/README.md

@@ -1,11 +1,17 @@
 # ER Save Parser
 
+![CI](https://github.com/zebbedaja/er-save-parser/actions/workflows/ci.yml/badge.svg)
+[![npm version](https://img.shields.io/npm/v/@zebbedaja/er-save-parser)](https://www.npmjs.com/package/@zebbedaja/er-save-parser)
+[![npm downloads](https://img.shields.io/npm/dm/@zebbedaja/er-save-parser)](https://www.npmjs.com/package/@zebbedaja/er-save-parser)
+![npm package minimized gzipped size](https://img.shields.io/bundlejs/size/%40zebbedaja%2Fer-save-parser)
+[![license](https://img.shields.io/badge/license-MIT-blue)](LICENSE)
+
 Parse Elden Ring PC save files into structured TypeScript/JavaScript objects.
 
 ## Features
 
 - **Full save slot parsing** — all 10 slots with character data, attributes, Flask counts, regions visited, death count, and more
-- **Event flag decoding** — track boss defeats, quest progress, and ending states using bit-level BST map lookups
+- **Event flag decoding** — track boss defeats, quest progress, and ending states
 - **Settings extraction** — camera, audio, HDR, ray tracing, and other game settings
 - **Profile summaries** — character name, level, play time, starting gift, and archetype per slot
 - **Zero runtime dependencies** — pure ESM, no bundled dependencies
@@ -18,6 +24,10 @@ npm install @zebbedaja/er-save-parser
 
 ## Usage
 
+### Node
+
+#### TypeScript
+
 ```typescript
 import { parse, type Save, type Slot, type Character } from '@zebbedaja/er-save-parser'
 import { readFileSync } from 'fs'
@@ -48,8 +58,42 @@ slot?.eventFlags?.forEach((flag) => {
 })
 ```
 
+#### JavaScript
+
+```javascript
+import { parse } from '@zebbedaja/er-save-parser'
+import { readFileSync } from 'node:fs'
+
+const buffer = readFileSync('ER0000.sl2').buffer
+const save = parse(buffer)
+
+console.log(save.steamId)
+console.log(save.settings?.hud)
+
+const slot = save.slots?.[0]
+const char = slot?.character
+
+if (char) {
+  console.log(char.characterName)    // "Tarnished"
+  console.log(char.level)            // 150
+  console.log(char.runes)            // 1234567
+  console.log(char.strength)         // 45
+  console.log(char.faith)            // 30
+  console.log(char.arcane)           // 20
+}
+
+// Check boss defeats
+slot?.eventFlags?.forEach((flag) => {
+  if (flag.state) {
+    console.log(`${flag.name} ✓`)
+  }
+})
+```
+
 ### Reading from a file in the browser
 
+#### TypeScript
+
 ```typescript
 async function parseFromFile(file: File): Promise<Save> {
   const buffer = await file.arrayBuffer()
@@ -57,6 +101,15 @@ async function parseFromFile(file: File): Promise<Save> {
 }
 ```
 
+#### JavaScript
+
+```javascript
+async function parseFromFile(file) {
+  const buffer = await file.arrayBuffer()
+  return parse(buffer)
+}
+```
+
 ## Parsed Data
 
 ### `Save` (root)
@@ -144,17 +197,7 @@ async function parseFromFile(file: File): Promise<Save> {
 
 ## Error handling
 
-```typescript
-try {
-  const save = parse(buffer)
-} catch (error: unknown) {
-  if (error instanceof Error) {
-    console.error('Failed to parse save file:', error.message)
-  }
-}
-```
-
-The parser will throw if:
+The parser will throw an Error if:
 - 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
@@ -169,6 +212,22 @@ npm run build     # Bundle with tsdown
 npm run dev       # Watch mode
 ```
 
+## TODO
+
+- Read all event flags
+- Read equipment
+- Read inventory
+
 ## License
 
 MIT
+
+## Credits
+
+- [Hapfel1/er-save-manager](https://github.com/Hapfel1/er-save-manager) — Python-based save manager/editor with GUI, backup, teleportation, and community features
+- [ClayAmore/ER-Save-Lib](https://github.com/ClayAmore/ER-Save-Lib) — Rust library for reading/writing save files with PC and PlayStation support
+- [ClayAmore/ER-Save-Editor](https://github.com/ClayAmore/ER-Save-Editor) — Full-featured Rust save editor for PC and PlayStation save files
+- [EthanShoeDev/elden-ring-compass](https://github.com/EthanShoeDev/elden-ring-compass) — React-based progress tracker with interactive map and save file polling
+- [CyberGiant7/Elden-Ring-Automatic-Checklist](https://github.com/CyberGiant7/Elden-Ring-Automatic-Checklist) — Online tool that analyzes save files to track 100% completion and missing items
+- [vawser/Smithbox](https://github.com/vawser/Smithbox) — Comprehensive modding tool for FromSoftware games with param, map, model, and material editors
+- [soulsmodding.com](https://soulsmodding.com) — FromSoftware save file documentation and reverse engineering resources