goblin-malin 0.1.2 → 0.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +56 -14
- package/dist/{chunk-Y4ZGX5NZ.js → chunk-PUWZTNM6.js} +870 -521
- package/dist/{chunk-ZZ35YTR2.js → chunk-PYRJ4FSU.js} +14 -1
- package/dist/cli.js +2 -2
- package/dist/index.js +2 -2
- package/dist/{metadata-AGDUAOW7.js → metadata-6BFFVJQ7.js} +1 -1
- package/package.json +12 -2
- package/scripts/save-install-source.mjs +40 -0
- package/.env.example +0 -6
package/README.md
CHANGED
|
@@ -1,5 +1,18 @@
|
|
|
1
1
|
# goblin-malin 😉
|
|
2
2
|
|
|
3
|
+
- [goblin-malin 😉](#goblin-malin-)
|
|
4
|
+
- [Installation](#installation)
|
|
5
|
+
- [Installation with `npm` (RECOMMENDED)](#installation-with-npm-recommended)
|
|
6
|
+
- [Installation with `yarn`](#installation-with-yarn)
|
|
7
|
+
- [Installation with `pnpm`](#installation-with-pnpm)
|
|
8
|
+
- [Installation on Windows](#installation-on-windows)
|
|
9
|
+
- [Steps](#steps)
|
|
10
|
+
- [Running the project as a developer](#running-the-project-as-a-developer)
|
|
11
|
+
- [Launching the app through js code](#launching-the-app-through-js-code)
|
|
12
|
+
- [Screenshots](#screenshots)
|
|
13
|
+
- [Metadata view](#metadata-view)
|
|
14
|
+
- [Download view](#download-view)
|
|
15
|
+
|
|
3
16
|
> [!CAUTION]
|
|
4
17
|
> **This project is in early, early, early development.**<br>
|
|
5
18
|
> Be aware that the data model can change drastically, making previous versions incompatible with the current one. Use at your own risk 😉
|
|
@@ -8,38 +21,67 @@ A keyboard-driven terminal UI for downloading and tagging music tracks with meta
|
|
|
8
21
|
|
|
9
22
|
## Installation
|
|
10
23
|
|
|
11
|
-
###
|
|
24
|
+
### Installation with `npm` (RECOMMENDED)
|
|
12
25
|
|
|
13
|
-
|
|
26
|
+
1. Install [Node.js](https://nodejs.org/en/download) with `npm`
|
|
27
|
+
2. Install with `npm`
|
|
28
|
+
```bash
|
|
29
|
+
npm install -g goblin-malin
|
|
30
|
+
goblin-malin # Run application
|
|
31
|
+
```
|
|
14
32
|
|
|
15
|
-
|
|
16
|
-
2. Install [Node.js](https://nodejs.org/en/download) and [yarn](https://classic.yarnpkg.com/lang/en/docs/install)
|
|
17
|
-
3. Install dependencies in the project directory: `yarn install`
|
|
18
|
-
4. Run the application: `yarn run dev`
|
|
33
|
+
### Installation with `yarn`
|
|
19
34
|
|
|
20
|
-
|
|
35
|
+
```bash
|
|
36
|
+
yarn global add goblin-malin
|
|
37
|
+
```
|
|
21
38
|
|
|
22
|
-
|
|
39
|
+
### Installation with `pnpm`
|
|
23
40
|
|
|
24
|
-
```
|
|
25
|
-
|
|
41
|
+
```bash
|
|
42
|
+
pnpm add -g goblin-malin
|
|
43
|
+
```
|
|
26
44
|
|
|
27
|
-
|
|
45
|
+
### Installation on Windows
|
|
46
|
+
|
|
47
|
+
[](https://github.com/Tetraxel/goblin-malin/releases/latest/download/goblin-malin-win-x64.exe)
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
goblin-malin.exe
|
|
28
51
|
```
|
|
29
52
|
|
|
30
53
|
## Steps
|
|
31
54
|
|
|
32
55
|
- Import with `Ctrl+V` URLs from compatible streaming platforms :
|
|
33
|
-
|
|
34
|
-
|
|
56
|
+
- `Spotify` (requires Spotify Premium Account to have full metadata)
|
|
57
|
+
- `YouTube`
|
|
35
58
|
- System fetches primary metadata from the corresponding URL platform
|
|
36
59
|
- System discovers the same track on other platforms (cross-referencing via ISRC or track/artist name)
|
|
37
60
|
- Filters/orders metadata sources by relevance or leaves the default ranking chosen by the system (use `TAB` key to switch the focused window).
|
|
38
61
|
- System downloads matching tracks from available download providers:
|
|
39
|
-
|
|
62
|
+
- `yt-dlp`
|
|
40
63
|
- User selects the best download source and previews the audio
|
|
41
64
|
- User saves the file to the desired folder with embedded tags
|
|
42
65
|
|
|
66
|
+
## Running the project as a developer
|
|
67
|
+
|
|
68
|
+
You can run the project as a developer:
|
|
69
|
+
|
|
70
|
+
1. Clone the repository and open a terminal in the project directory
|
|
71
|
+
2. Install [Node.js](https://nodejs.org/en/download) and [yarn](https://classic.yarnpkg.com/lang/en/docs/install)
|
|
72
|
+
3. Install dependencies in the project directory: `yarn install`
|
|
73
|
+
4. Run the application: `yarn run dev`
|
|
74
|
+
|
|
75
|
+
## Launching the app through js code
|
|
76
|
+
|
|
77
|
+
> Not customizable yet
|
|
78
|
+
|
|
79
|
+
```js
|
|
80
|
+
import GoblinMalin from "goblin-malin";
|
|
81
|
+
|
|
82
|
+
GoblinMalin.start();
|
|
83
|
+
```
|
|
84
|
+
|
|
43
85
|
## Screenshots
|
|
44
86
|
|
|
45
87
|
### Metadata view
|