Feature: add {genre} token (#1167)

emmercm · Jun 16, 2024 · aa13e5e · aa13e5e
1 parent f2b546c
commit aa13e5e
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 0 deletions.
diff --git a/src/modules/datScanner.ts b/src/modules/datScanner.ts
@@ -353,6 +353,7 @@ export default class DATScanner extends Scanner {
         cloneOf: game.cloneof,
         romOf: game.romof,
         sampleOf: undefined,
+        genre: game.genre?.toString(),
         release: undefined,
         rom: roms,
       });

diff --git a/src/types/dats/game.ts b/src/types/dats/game.ts
@@ -60,6 +60,7 @@ export interface GameProps {
   readonly cloneOf?: string,
   readonly romOf?: string,
   readonly sampleOf?: string,
+  readonly genre?: string,
   // readonly board?: string,
   // readonly rebuildTo?: string,
   // readonly year?: string,
@@ -104,6 +105,10 @@ export default class Game implements GameProps {
   @Expose({ name: 'sampleof' })
   readonly sampleOf?: string;
 
+  // This is non-standard, but libretro uses it
+  @Expose({ name: 'genre' })
+  readonly genre?: string;
+
   // readonly board?: string;
   // readonly rebuildto?: string;
   // readonly year?: string;
@@ -128,6 +133,7 @@ export default class Game implements GameProps {
     this.cloneOf = props?.cloneOf;
     this.romOf = props?.romOf;
     this.sampleOf = props?.sampleOf;
+    this.genre = props?.genre;
     this.release = props?.release ?? [];
     this.rom = props?.rom ?? [];
   }
@@ -184,6 +190,10 @@ export default class Game implements GameProps {
     return this.device === 'yes';
   }
 
+  getGenre(): string | undefined {
+    return this.genre;
+  }
+
   getReleases(): Release[] {
     if (Array.isArray(this.release)) {
       return this.release;

diff --git a/src/types/outputFactory.ts b/src/types/outputFactory.ts
@@ -223,6 +223,11 @@ export default class OutputFactory {
 
     output = output.replace('{gameType}', game.getGameType());
 
+    const gameGenre = game.getGenre();
+    if (gameGenre) {
+      output = output.replace('{genre}', gameGenre);
+    }
+
     return output;
   }
 

diff --git a/test/outputFactory.test.ts b/test/outputFactory.test.ts
@@ -132,6 +132,27 @@ describe('token replacement', () => {
     expect(outputPath.format()).toEqual(expectedPath);
   });
 
+  test.each([
+    ['root/{genre}', 'Platform', path.join('root', 'Platform', 'Dummy.rom')],
+    ['root/{genre}', 'Sports', path.join('root', 'Sports', 'Dummy.rom')],
+  ])('should replace {genre}: %s', async (output, genre, expectedPath) => {
+    const options = new Options({ commands: ['copy'], output });
+    const dat = new LogiqxDAT(new Header(), []);
+    const game = new Game({
+      genre,
+    });
+
+    const outputPath = OutputFactory.getPath(
+      options,
+      dat,
+      game,
+      game.getReleases().find(() => true),
+      dummyRom,
+      await dummyRom.toFile(),
+    );
+    expect(outputPath.format()).toEqual(expectedPath);
+  });
+
   test.each([
     // Highest priority
     ['Game [BIOS]', 'BIOS'],