goblin-malin 0.1.1 → 0.1.3

package/README.md

@@ -1,43 +1,93 @@
-# goblin-malin 😉
-
-> [!CAUTION]
-> **This project is in early, early, early development.**<br>
-> Be aware that the data model can change drastically, making previous versions incompatible with the current one. Use at your own risk 😉
-
-A keyboard-driven terminal UI for downloading and tagging music tracks with metadata. Import links from Spotify, YouTube, the app cross-references metadata across providers, finds the best download source (only yt-dlp for now), and saves it to disk with clean tags.
-
-## Installation
-
-### Running the project as a developer
-
-You can run the project as a developer:
-
-1. Clone the repository and open a terminal in the project directory
-2. Install [Node.js](https://nodejs.org/en/download) and [yarn](https://classic.yarnpkg.com/lang/en/docs/install)
-3. Install dependencies in the project directory: `yarn install`
-4. Run the application: `yarn run dev`
-
-### Launching the app in js code
-
-> Not customizable yet
-
-```js
-import GoblinMalin from "goblin-malin";
-
-GoblinMalin.start();
-```
-
-## Steps
-
-- Import track URLs from compatible streaming platforms with `Ctrl+V`:
-  - `Spotify`
-  - `YouTube`
-- System fetches primary metadata from the corresponding URL platform
-- System discovers the same track on other platforms (cross-referencing via ISRC or track/artist name)
-- Filters/orders metadata sources by relevance or leaves the default ranking chosen by the system (use `TAB` key to switch the focused window).
-- System downloads matching tracks from available download providers:
-  - `yt-dlp`
-- User selects the best download source and previews the audio
-- User saves the file to the desired folder with embedded tags
-
-<img src="docs\screenshots\2026-05-08-download-view.png" width="100%"/>
+# goblin-malin 😉
+
+- [goblin-malin 😉](#goblin-malin-)
+    - [Installation](#installation)
+        - [Installation with `npm` (RECOMMENDED)](#installation-with-npm-recommended)
+        - [Installation with `yarn`](#installation-with-yarn)
+        - [Installation with `pnpm`](#installation-with-pnpm)
+        - [Installation on Windows](#installation-on-windows)
+    - [Steps](#steps)
+    - [Running the project as a developer](#running-the-project-as-a-developer)
+    - [Launching the app through js code](#launching-the-app-through-js-code)
+    - [Screenshots](#screenshots)
+        - [Metadata view](#metadata-view)
+        - [Download view](#download-view)
+
+> [!CAUTION]
+> **This project is in early, early, early development.**<br>
+> Be aware that the data model can change drastically, making previous versions incompatible with the current one. Use at your own risk 😉
+
+A keyboard-driven terminal UI for downloading and tagging music tracks with metadata. Import links from Spotify, YouTube, the app cross-references metadata across providers, finds the best download source (only yt-dlp for now), and saves it to disk with clean tags.
+
+## Installation
+
+### Installation with `npm` (RECOMMENDED)
+
+1. Install [Node.js](https://nodejs.org/en/download) with `npm`
+2. Install with `npm`
+    ```bash
+    npm install -g goblin-malin
+    goblin-malin # Run application
+    ```
+
+### Installation with `yarn`
+
+```bash
+yarn global add goblin-malin
+```
+
+### Installation with `pnpm`
+
+```bash
+pnpm add -g  goblin-malin
+```
+
+### Installation on Windows
+
+[![Windows](https://img.shields.io/badge/-Windows_x64-blue.svg?style=flat&logo=windows&logoColor=%23ffffff&color=%230078d4)](https://github.com/Tetraxel/goblin-malin/releases/latest/download/goblin-malin-win-x64.exe)
+
+```bash
+goblin-malin.exe
+```
+
+## Steps
+
+- Import with `Ctrl+V` URLs from compatible streaming platforms :
+    - `Spotify` (requires Spotify Premium Account to have full metadata)
+    - `YouTube`
+- System fetches primary metadata from the corresponding URL platform
+- System discovers the same track on other platforms (cross-referencing via ISRC or track/artist name)
+- Filters/orders metadata sources by relevance or leaves the default ranking chosen by the system (use `TAB` key to switch the focused window).
+- System downloads matching tracks from available download providers:
+    - `yt-dlp`
+- User selects the best download source and previews the audio
+- User saves the file to the desired folder with embedded tags
+
+## Running the project as a developer
+
+You can run the project as a developer:
+
+1. Clone the repository and open a terminal in the project directory
+2. Install [Node.js](https://nodejs.org/en/download) and [yarn](https://classic.yarnpkg.com/lang/en/docs/install)
+3. Install dependencies in the project directory: `yarn install`
+4. Run the application: `yarn run dev`
+
+## Launching the app through js code
+
+> Not customizable yet
+
+```js
+import GoblinMalin from "goblin-malin";
+
+GoblinMalin.start();
+```
+
+## Screenshots
+
+### Metadata view
+
+<img src="https://raw.githubusercontent.com/Tetraxel/goblin-malin/main/docs/screenshots/2026-05-14-metadata-view.png" width="100%"/>
+
+### Download view
+
+<img src="https://raw.githubusercontent.com/Tetraxel/goblin-malin/main/docs/screenshots/2026-05-08-download-view.png" width="100%"/>

package/dist/assets/themes/dark.json

@@ -0,0 +1,74 @@
+{
+    "palette": {
+        "blue": "#58a6ff",
+        "cyan": "#39c5cf",
+        "red": "#ff7b72",
+        "green": "#56d364",
+        "yellow": "#e3b341",
+        "orange": "#f0883e",
+        "purple": "#d2a8ff",
+        "pink": "#f778ba",
+        "white": "#e6edf3",
+        "gray": "#8b949e",
+        "grayDark": "#484f58"
+    },
+    "ui": {
+        "background": "#000000",
+        "rowBackground": "#111111",
+        "rowActiveDimmedBackground": "#1d1d1d",
+        "rowActiveBackground": "#2f2f2f",
+        "border": "#39c5cf",
+        "separator": "#39c5cf",
+        "selection": "#58a6ff",
+        "tabActive": "#58a6ff",
+        "tabInactive": "#8b949e",
+        "panelTitle": "#e6edf3",
+        "progressFill": "#56d364",
+        "progressEmpty": "#484f58",
+        "modalBorder": "#39c5cf",
+        "focusIndicator": "#58a6ff",
+        "dimText": "#484f58"
+    },
+    "text": {
+        "primary": "#e6edf3",
+        "secondary": "#8b949e",
+        "muted": "#484f58",
+        "hint": "#8b949e",
+        "active": "#e6edf3",
+        "heading": "#e6edf3"
+    },
+    "status": {
+        "processing": "#388bfd",
+        "pending": "#e6edf3",
+        "success": "#56d364",
+        "warning": "#e3b341",
+        "error": "#ff7b72",
+        "skipped": "#8b949e",
+        "locked": "#e6edf3",
+        "downloading": "#e3b341"
+    },
+    "field": {
+        "normal": "#e6edf3",
+        "overridden": "#e3b341",
+        "missing": "#8b949e",
+        "selected": "#56d364",
+        "error": "#ff7b72"
+    },
+    "confidence": {
+        "primary": "#00fbff",
+        "high": "#56d364",
+        "medium": "#e3b341",
+        "low": "#8b949e",
+        "veryLow": "#ff7b72"
+    },
+    "diff": {
+        "base": "#8b949e",
+        "changed": "#39c5cf",
+        "modified": "#e3b341"
+    },
+    "action": {
+        "primary": "#e3b341",
+        "destructive": "#ff7b72",
+        "neutral": "#8b949e"
+    }
+}

package/dist/assets/themes/light.json

@@ -0,0 +1,74 @@
+{
+    "palette": {
+        "blue": "#0969da",
+        "cyan": "#1b7c83",
+        "red": "#cf222e",
+        "green": "#1a7f37",
+        "yellow": "#9a6700",
+        "orange": "#bc4c00",
+        "purple": "#8250df",
+        "pink": "#bf3989",
+        "white": "#ffffff",
+        "gray": "#57606a",
+        "grayDark": "#24292f"
+    },
+    "ui": {
+        "background": "#ffffff",
+        "rowBackground": "#f6f8fa",
+        "rowActiveDimmedBackground": "#d0d7de",
+        "rowActiveBackground": "#b0b0b0",
+        "border": "#1b7c83",
+        "separator": "#1b7c83",
+        "selection": "#0969da",
+        "tabActive": "#0969da",
+        "tabInactive": "#57606a",
+        "panelTitle": "#24292f",
+        "progressFill": "#1a7f37",
+        "progressEmpty": "#d0d7de",
+        "modalBorder": "#1b7c83",
+        "focusIndicator": "#0969da",
+        "dimText": "#d0d7de"
+    },
+    "text": {
+        "primary": "#24292f",
+        "secondary": "#57606a",
+        "muted": "#d0d7de",
+        "hint": "#57606a",
+        "active": "#24292f",
+        "heading": "#24292f"
+    },
+    "status": {
+        "processing": "#0550ae",
+        "pending": "#24292f",
+        "success": "#1a7f37",
+        "warning": "#9a6700",
+        "error": "#cf222e",
+        "skipped": "#57606a",
+        "locked": "#24292f",
+        "downloading": "#9a6700"
+    },
+    "field": {
+        "normal": "#24292f",
+        "overridden": "#9a6700",
+        "missing": "#57606a",
+        "selected": "#1a7f37",
+        "error": "#cf222e"
+    },
+    "confidence": {
+        "primary": "#007f81",
+        "high": "#1a7f37",
+        "medium": "#9a6700",
+        "low": "#57606a",
+        "veryLow": "#cf222e"
+    },
+    "diff": {
+        "base": "#57606a",
+        "changed": "#1b7c83",
+        "modified": "#9a6700"
+    },
+    "action": {
+        "primary": "#9a6700",
+        "destructive": "#cf222e",
+        "neutral": "#57606a"
+    }
+}