Add support for Onion (OnionOS) artwork format

README.md

@@ -8,7 +8,7 @@
 
 <img src="https://raw.githubusercontent.com/sinedied/mini-scraper/refs/heads/main/pic.jpg" alt="picture of a scraped boxart" width="180" align="right">
 
-Artwork scraper for [MinUI](https://github.com/shauninman/MinUI), [NextUI](https://github.com/LoveRetro/NextUI) and [muOS](https://muos.dev/).
+Artwork scraper for [MinUI](https://github.com/shauninman/MinUI), [NextUI](https://github.com/LoveRetro/NextUI), [muOS](https://muos.dev/), and [Onion](https://onionui.github.io/).
 
 > [!NOTE]
 > MinUI does't officially support boxarts, but still has [some support for it as stated by its author](https://www.reddit.com/r/SBCGaming/comments/1hycyqx/minui_box_art/).
@@ -48,7 +48,7 @@ When running the scraper, you can pass the following options:
 - `-w, --width <size>`: Max width of the image (default: 300)
 - `-h, --height <size>`: Max height of the image
 - `-t, --type <type>`: Type of image to scrape (can be `boxart`, `snap`, `title`, `box+snap`, `box+title`) (default: `boxart`)
-- `-o, --output <format>`: Artwork format (can be (`minui`, `nextui`, `muos`, `anbernic`) (default: `minui`)
+- `-o, --output <format>`: Artwork format (can be (`minui`, `nextui`, `muos`, `anbernic`, `onion`) (default: `minui`)
 - `-a, --ai`: Use AI for advanced matching (default: false)
 - `-m, --ai-model <name>`: Ollama model to use for AI matching (default: `gemma2:2b`)
 - `-r, --regions <regions>`: Preferred regions to use for AI matching (default: `World,Europe,USA,Japan`)

package.json

@@ -26,6 +26,8 @@
     "minui",
     "nextui",
     "muos",
+    "anbernic",
+    "onion",
     "scraper",
     "boxart",
     "ai"

src/cli.ts

@@ -31,7 +31,7 @@ export async function run(args: string[] = process.argv) {
     .option('-w, --width <size>', 'Max width of the image', Number.parseFloat, 300)
     .option('-h, --height <size>', 'Max height of the image', Number.parseFloat)
     .option('-t, --type <type>', 'Art type (boxart, snap, title, box+snap, box+title)', 'boxart')
-    .option('-o, --output <format>', 'Artwork format (minui, nextui, muos, anbernic)', 'minui')
+    .option('-o, --output <format>', 'Artwork format (minui, nextui, muos, anbernic, onion)', 'minui')
     .option('-a, --ai', 'Use AI for advanced matching', false)
     .option('-m, --ai-model <name>', 'Ollama model to use for AI matching', 'gemma2:2b')
     .option('-r, --regions <regions>', 'Preferred regions to use for AI matching', 'World,Europe,USA,Japan')

src/format/format.ts

@@ -5,7 +5,8 @@ export enum Format {
   MinUI = 'minui',
   NextUI = 'nextui',
   MuOS = 'muos',
-  Anbernic = 'anbernic'
+  Anbernic = 'anbernic',
+  Onion = 'onion'
 }
 
 export type SeparateArtworksFunction = (options: Options) => Promise<boolean>;
@@ -53,6 +54,11 @@ export async function getOutputFormat(options: Options): Promise<OutputFormat> {
       return anbernic.default;
     }
 
+    case Format.Onion: {
+      const onion = await import('./onion.js');
+      return onion.default;
+    }
+
     // eslint-disable-next-line @typescript-eslint/switch-exhaustiveness-check
     default: {
       throw new Error(`Unknown format: ${options.output}`);

src/format/onion.ts

@@ -0,0 +1,55 @@
+import path from 'node:path';
+import fs from 'node:fs/promises';
+import createDebug from 'debug';
+import glob from 'fast-glob';
+import { getArtTypes } from '../libretro.js';
+import { type Options } from '../options.js';
+import { composeImageTo, resizeImageTo } from '../image.js';
+import { type ArtType } from '../art.js';
+
+const debug = createDebug('onion');
+const boxartFolder = 'boxart';
+
+export async function useSeparateArtworks(_options: Options) {
+  return false;
+}
+
+export async function getArtPath(filePath: string, _machine: string, _type?: ArtType) {
+  const fileName = path.basename(filePath, path.extname(filePath));
+  return path.join(path.dirname(filePath), boxartFolder, `${fileName}.png`);
+}
+
+export async function exportArtwork(
+  art1Url: string | undefined,
+  art2Url: string | undefined,
+  artPath: string,
+  options: Options
+) {
+  const artTypes = getArtTypes(options);
+  if (artTypes.art2 && (art1Url ?? art2Url)) {
+    debug(`Found art URL(s): "${art1Url}" / "${art2Url}"`);
+    await composeImageTo(art1Url, art2Url, artPath, { width: options.width, height: options.height });
+  } else if (art1Url) {
+    debug(`Found art URL: "${art1Url}"`);
+    await resizeImageTo(art1Url, artPath, { width: options.width, height: options.height });
+  } else {
+    return false;
+  }
+
+  return true;
+}
+
+export async function cleanupArtwork(targetPath: string, _romFolders: string[], _options: Options) {
+  const boxartFolders = await glob([`**/${boxartFolder}`], { onlyDirectories: true, cwd: targetPath });
+  await Promise.all(boxartFolders.map(async (boxartFolder) => fs.rm(boxartFolder, { recursive: true })));
+  console.info(`Removed ${boxartFolders.length} ${boxartFolder} folders`);
+}
+
+const onion = {
+  useSeparateArtworks,
+  getArtPath,
+  exportArtwork,
+  cleanupArtwork
+};
+
+export default onion;

src/index.ts

@@ -13,3 +13,4 @@ export * as minui from './format/minui.js';
 export * as nextui from './format/nextui.js';
 export * as muos from './format/muos.js';
 export * as anbernic from './format/anbernic.js';
+export * as onion from './format/onion.js';