mirror of
https://github.com/jeffvli/feishin.git
synced 2024-11-20 14:37:06 +01:00
78 lines
4.4 KiB
Markdown
78 lines
4.4 KiB
Markdown
# Feishin
|
|
|
|
<p align="center">
|
|
<a href="https://github.com/jeffvli/feishin/blob/main/LICENSE">
|
|
<img src="https://img.shields.io/github/license/jeffvli/feishin?style=flat-square&color=brightgreen"
|
|
alt="License">
|
|
</a>
|
|
<a href="https://github.com/jeffvli/feishin/releases">
|
|
<img src="https://img.shields.io/github/v/release/jeffvli/feishin?style=flat-square&color=blue"
|
|
alt="Release">
|
|
</a>
|
|
<a href="https://github.com/jeffvli/feishin/releases">
|
|
<img src="https://img.shields.io/github/downloads/jeffvli/feishin/total?style=flat-square&color=orange"
|
|
alt="Downloads">
|
|
</a>
|
|
</p>
|
|
<p align="center">
|
|
<a href="https://discord.gg/FVKpcMDy5f">
|
|
<img src="https://img.shields.io/discord/922656312888811530?color=black&label=discord&logo=discord&logoColor=white"
|
|
alt="Discord">
|
|
</a>
|
|
<a href="https://matrix.to/#/#sonixd:matrix.org">
|
|
<img src="https://img.shields.io/matrix/sonixd:matrix.org?color=black&label=matrix&logo=matrix&logoColor=white"
|
|
alt="Matrix">
|
|
</a>
|
|
</p>
|
|
|
|
Rewrite of [Sonixd](https://github.com/jeffvli/sonixd).
|
|
|
|
## Features
|
|
|
|
- [x] MPV player backend
|
|
- [x] Web player backend
|
|
- [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
|
|
|
|
<a href="https://raw.githubusercontent.com/jeffvli/feishin/development/media/preview_full_screen_player.png"><img src="https://raw.githubusercontent.com/jeffvli/feishin/development/media/preview_full_screen_player.png" width="49.5%"/></a> <a href="https://raw.githubusercontent.com/jeffvli/feishin/development/media/preview_album_artist_detail.png"><img src="https://raw.githubusercontent.com/jeffvli/feishin/development/media/preview_album_artist_detail.png" width="49.5%"/></a> <a href="https://raw.githubusercontent.com/jeffvli/feishin/development/media/preview_album_detail.png"><img src="https://raw.githubusercontent.com/jeffvli/feishin/development/media/preview_album_detail.png" width="49.5%"/></a> <a href="https://raw.githubusercontent.com/jeffvli/feishin/development/media/preview_smart_playlist.png"><img src="https://raw.githubusercontent.com/jeffvli/feishin/development/media/preview_smart_playlist.png" width="49.5%"/></a>
|
|
|
|
## 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?
|
|
|
|
Feishin supports any music server that implements a [Navidrome](https://www.navidrome.org/) or [Jellyfin](https://jellyfin.org/) API. **Subsonic API is not currently supported**. This will likely be added in [later when the new Subsonic API is decided on](https://support.symfonium.app/t/subsonic-servers-participation/1233).
|
|
|
|
- [Navidrome](https://github.com/navidrome/navidrome)
|
|
- [Jellyfin](https://github.com/jellyfin/jellyfin)
|
|
- [Funkwhale](https://funkwhale.audio/) - TBD
|
|
- Subsonic-compatible servers - TBD
|
|
|
|
## Development
|
|
|
|
Built and tested using Node `v16.15.0`.
|
|
|
|
This project is built off of [electron-react-boilerplate](https://github.com/electron-react-boilerplate/electron-react-boilerplate) v4.6.0.
|
|
|
|
## License
|
|
|
|
[GNU General Public License v3.0 ©](https://github.com/jeffvli/feishin/blob/dev/LICENSE)
|