Merge pull request #73 from perrello/foxol-compat

Support for .sav SRAM files.

Author: arianrhodsandlot

docs/src/content/docs/apis/launch.md

@@ -178,6 +178,12 @@ const nostalgist = await Nostalgist.launch({
 
     The initial SRAM to be loaded after launching.
 
+  + #### `sramType`
+
+    **type:** `srm | sav`
+
+    Sets the save file battery type used by Nostalgist internally. Use `'sav'` for cores like melonDS. Defaults to `'srm'`.
+
   + #### `shader`
 
     **type:** `string`

readme.md

@@ -125,6 +125,10 @@ Please refer to [nostalgist.js.org/apis](https://nostalgist.js.org/apis).
 
   The high-performance, preservation-focused netflix style emulation engine powered by Nostalgist.
 
++ [Foxol](https://play.foxol.app)
+
+  Foxol is a modern emulator platform with multiplayer, cloud saves, cheats, and deep customization across every device.
+
 
 ### Credits
 

src/classes/emulator-file-system.ts

@@ -56,6 +56,11 @@ export class EmulatorFileSystem {
     FS.mkdirTree(directory)
   }
 
+  readdir(path: string) {
+    const { FS } = this
+    return FS.readdir(path)
+  }
+
   readFile(path: string, encoding: 'binary' | 'utf8' = 'utf8') {
     const { FS } = this
     return FS.readFile(path, { encoding })

src/classes/emulator-options.ts

@@ -68,6 +68,8 @@ export class EmulatorOptions {
 
   sram?: ResolvableFile | undefined
 
+  sramType?: 'sav' | 'srm'
+
   state?: ResolvableFile | undefined
 
   waitForInteraction: ((params: { done: () => void }) => void) | undefined
@@ -127,6 +129,7 @@ export class EmulatorOptions {
     this.respondToGlobalEvents = options.respondToGlobalEvents ?? true
     this.signal = options.signal
     this.size = options.size ?? 'auto'
+    this.sramType = options.sramType ?? 'srm'
     // eslint-disable-next-line sonarjs/deprecation
     this.waitForInteraction = options.waitForInteraction
     this.element = this.getElement()

src/classes/emulator.ts

@@ -86,7 +86,11 @@ export class Emulator {
   }
 
   private get sramFilePath() {
-    return path.join(this.sramFileDirectory, `${this.romBaseName}.srm`)
+    return path.join(this.sramFileDirectory, `${this.romBaseName}.${this.sramFileType}`)
+  }
+
+  private get sramFileType() {
+    return this.options.sramType
   }
 
   private get stateFileDirectory() {

src/types/nostalgist-options.ts

@@ -147,6 +147,11 @@ export interface NostalgistOptions {
    */
   sram?: ResolvableFileInput
 
+  /**
+   * The type of battery save the core generates.
+   */
+  sramType?: 'sav' | 'srm'
+
   respondToGlobalEvents?: boolean
 
   /**