diff --git a/README.md b/README.md index 4c37b81f..389d66a8 100644 --- a/README.md +++ b/README.md @@ -34,16 +34,27 @@ Rewrite of [Sonixd](https://github.com/jeffvli/sonixd). - [x] Modern UI - [x] Scrobble playback to your server - [x] Smart playlist editor (Navidrome) +- [x] Synchronized and unsynchronized lyrics support - [ ] [Request a feature](https://github.com/jeffvli/feishin/issues) or [view taskboard](https://github.com/users/jeffvli/projects/5/views/1) ## Screenshots - + ## Getting Started Download the [latest desktop client](https://github.com/jeffvli/feishin/releases). +If you're using an M1 macOS device, [check here](https://github.com/jeffvli/feishin/issues/104#issuecomment-1553914730) for instructions on how to remove the app from quarantine. + +### Configuration + +1. Upon startup you will be greeted with a prompt to select the path to your MPV binary. If you do not have MPV installed, you can download it [here](https://mpv.io/installation/) or install it using any package manager supported by your OS. After inputting the path, restart the app. + +2. After restarting the app, you will be prompted to select a server. Click the `Open menu` button and select `Manage servers`. Click the `Add server` button in the popup and fill out all applicable details. You will need to enter the full URL to your server, including the protocol and port if applicable (e.g. `https://navidrome.my-server.com` or `http://192.168.0.1:4533`). + +- **Navidrome** - For the best experience, select "Save password" when creating the server and configure the `SessionTimeout` setting in your Navidrome config to a larger value (e.g. 72h). + ## FAQ ### What music servers does Feishin support? @@ -52,9 +63,8 @@ Feishin supports any music server that implements a [Navidrome](https://www.navi - [Navidrome](https://github.com/navidrome/navidrome) - [Jellyfin](https://github.com/jellyfin/jellyfin) -- ~~[Gonic](https://github.com/sentriz/gonic)~~ -- ~~[Astiga](https://asti.ga/)~~ -- ~~[Supysonic](https://github.com/spl0k/supysonic)~~ +- [Funkwhale](https://funkwhale.audio/) - TBD +- Subsonic-compatible servers - TBD ## Development diff --git a/media/preview_full_screen_player.png b/media/preview_full_screen_player.png new file mode 100644 index 00000000..115bfc93 Binary files /dev/null and b/media/preview_full_screen_player.png differ diff --git a/package-lock.json b/package-lock.json index 87072014..bed53283 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "feishin", - "version": "0.1.1", + "version": "0.2.0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "feishin", - "version": "0.1.1", + "version": "0.2.0", "hasInstallScript": true, "license": "GPL-3.0", "dependencies": { diff --git a/package.json b/package.json index 380039d4..899e01ac 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "feishin", "productName": "Feishin", "description": "Feishin music server", - "version": "0.1.1", + "version": "0.2.0", "scripts": { "build": "concurrently \"npm run build:main\" \"npm run build:renderer\"", "build:main": "cross-env NODE_ENV=production TS_NODE_TRANSPILE_ONLY=true webpack --config ./.erb/configs/webpack.config.main.prod.ts", diff --git a/release/app/package-lock.json b/release/app/package-lock.json index 2489d161..ac6795c7 100644 --- a/release/app/package-lock.json +++ b/release/app/package-lock.json @@ -1,12 +1,12 @@ { "name": "feishin", - "version": "0.1.1", + "version": "0.2.0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "feishin", - "version": "0.1.1", + "version": "0.2.0", "hasInstallScript": true, "license": "GPL-3.0", "dependencies": { @@ -26,7 +26,6 @@ "debug": "^4.1.1", "env-paths": "^2.2.0", "fs-extra": "^8.1.0", - "global-agent": "^3.0.0", "got": "^11.8.5", "progress": "^2.0.3", "semver": "^6.2.0", @@ -294,7 +293,6 @@ "integrity": "sha512-tzQq/+wrTZ2yU+U5PoeXc97KABhX2v55C/T0finH3tSKYuI8H/SqppIFymBBrUHcK13LvEGY3vdj3ikPPenL5g==", "dependencies": { "@nornagon/put": "0.0.8", - "abstract-socket": "^2.0.0", "event-stream": "3.3.4", "hexy": "^0.2.10", "jsbi": "^2.0.5", @@ -540,7 +538,6 @@ "integrity": "sha512-GDhU9ntwuKyGXdZBUgTIe+vXnWj0fppUEtMDL0+idd5Sta8TGpHssn/eusA9mrPr9qNDym6SxAYZjNvCn/9RBg==", "dev": true, "dependencies": { - "@types/yauzl": "^2.9.1", "debug": "^4.1.1", "get-stream": "^5.1.0", "yauzl": "^2.10.0" @@ -870,9 +867,6 @@ "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-4.0.0.tgz", "integrity": "sha512-m6F1R3z8jjlf2imQHS2Qez5sjKWQzbuuhuJ/FKYFRZvPE3PuHcSMVZzfsLhGVOkfd20obL5SWEBew5ShlquNxg==", "dev": true, - "dependencies": { - "graceful-fs": "^4.1.6" - }, "optionalDependencies": { "graceful-fs": "^4.1.6" } diff --git a/release/app/package.json b/release/app/package.json index 2f0b9c46..3d3abe0c 100644 --- a/release/app/package.json +++ b/release/app/package.json @@ -1,6 +1,6 @@ { "name": "feishin", - "version": "0.1.1", + "version": "0.2.0", "description": "", "main": "./dist/main/main.js", "author": {