6e677d7454
* Add customizable resolution for the fullscreen player image --------- Co-authored-by: iiPython <ben@iipython.dev> Co-authored-by: Benjamin <iipython@proton.me> |
||
|---|---|---|
| .erb | ||
| .github | ||
| .husky | ||
| .vscode | ||
| assets | ||
| media | ||
| release/app | ||
| src | ||
| .editorconfig | ||
| .eslintignore | ||
| .eslintrc.js | ||
| .gitattributes | ||
| .gitignore | ||
| .prettierrc | ||
| .stylelintrc.json | ||
| CHANGELOG.md | ||
| Dockerfile | ||
| LICENSE | ||
| ng.conf.template | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
| vercel.json | ||
Feishin
Rewrite of Sonixd.
Features
- MPV player backend
- Web player backend
- Modern UI
- Scrobble playback to your server
- Smart playlist editor (Navidrome)
- Synchronized and unsynchronized lyrics support
- Request a feature or view taskboard
Screenshots
Getting Started
Desktop (recommended)
Download the latest desktop client. The desktop client is the recommended way to use Feishin. It supports both the MPV and web player backends, as well as includes built-in fetching for lyrics.
If you're using a device running macOS 12 (Monterey) or higher, check here for instructions on how to remove the app from quarantine.
Web and Docker
Visit https://feishin.vercel.app to use the hosted web version of Feishin. The web client only supports the web player backend.
Feishin is also available as a Docker image. The images are hosted via ghcr.io and are available to view here. You can run the container using the following commands:
# Run the latest version
docker run --name feishin -p 9180:9180 ghcr.io/jeffvli/feishin:latest
# Build the image locally
docker build -t feishin .
docker run --name feishin -p 9180:9180 feishin
Configuration
-
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 or install it using any package manager supported by your OS. After inputting the path, restart the app.
-
After restarting the app, you will be prompted to select a server. Click the
Open menubutton and selectManage servers. Click theAdd serverbutton 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.comorhttp://192.168.0.1:4533).
- Navidrome - For the best experience, select "Save password" when creating the server and configure the
SessionTimeoutsetting in your Navidrome config to a larger value (e.g. 72h).- Linux users - The default password store uses
libsecret.kwallet4/5/6are also supported, but must be explicitly set in Settings > Window > Passwords/secret score.
- Linux users - The default password store uses
- Optional - If you want to host Feishin on a subpath (not
/), then pass in the following environment variable:PUBLIC_PATH=PATH. For example, to host on/feishin, pass inPUBLIC_PATH=/feishin.
FAQ
MPV is either not working or is rapidly switching between pause/play states
First thing to do is check that your MPV binary path is correct. Navigate to the settings page and re-set the path and restart the app. If your issue still isn't resolved, try reinstalling MPV. Known working versions include v0.35.x and v0.36.x. v0.34.x is a known broken version.
What music servers does Feishin support?
Feishin supports any music server that implements a Navidrome or Jellyfin API. Subsonic API is not currently supported. This will likely be added in later when the new Subsonic API is decided on.
Development
Built and tested using Node v16.15.0.
This project is built off of electron-react-boilerplate v4.6.0.
Translation
This project uses Weblate for translations. If you would like to contribute, please visit the link and submit a translation.