tunio-desktop/README.md

<img src="assets/icon.png" alt="sonixd logo" title="sonixd" align="right" height="60px" />

# Sonixd

  <a href="https://github.com/jeffvli/sonixd/releases">
    <img src="https://img.shields.io/github/v/release/jeffvli/sonixd?style=flat-square&color=blue"
    alt="Release">
  </a>
  <a href="https://github.com/jeffvli/sonixd/compare/dev">
    <img src="https://img.shields.io/github/commits-since/jeffvli/sonixd/latest/dev?style=flat-square&color=red"
    alt="Commits">
  </a>
  <a href="https://github.com/jeffvli/sonixd/blob/main/LICENSE">
    <img src="https://img.shields.io/github/license/jeffvli/sonixd?style=flat-square&color=brightgreen"
    alt="License">
  </a>
  <a href="https://github.com/jeffvli/sonixd/releases">
    <img src="https://img.shields.io/github/downloads/jeffvli/sonixd/total?style=flat-square&color=orange"
    alt="Downloads">
  </a>

Sonixd is a cross-platform desktop client built for Subsonic-API compatible music servers. This project was inspired by the many existing clients, but aimed to address a few key issues including <strong>scalability</strong>, <strong>library management</strong>, and <strong>user experience</strong>.

- [**Usage documentation & FAQ**](https://github.com/jeffvli/sonixd/discussions/15)
- [**Theming documentation**](https://github.com/jeffvli/sonixd/discussions/61)

The application is successfully tested on the following servers: [Navidrome](https://github.com/navidrome/navidrome), [Airsonic](https://github.com/airsonic/airsonic), [Airsonic-Advanced](https://github.com/airsonic-advanced/airsonic-advanced), [Supysonic](https://github.com/spl0k/supysonic), [Gonic](https://github.com/sentriz/gonic), [Astiga](https://asti.ga/)

## Features

- HTML5 audio with crossfading and gapless\* playback
- Drag and drop rows with multi-select
- Modify and save playlists intuitively
- Handles large playlists and queues
- Global mediakeys support
- Multi-theme support
- Supports all Subsonic API compatible servers targeting v1.15.0
- Built with Electron, React with the [rsuite v4](https://github.com/rsuite/rsuite) component library

<h5>* Gapless playback is artifically created using the crossfading players so it may not be perfect, YMMV.</h5>

## Screenshots

<a href="https://raw.githubusercontent.com/jeffvli/sonixd/main/assets/screenshots/0.5.0/album.png"><img src="https://raw.githubusercontent.com/jeffvli/sonixd/main/assets/screenshots/0.5.0/album.png" width="49.5%"/></a>
<a href="https://raw.githubusercontent.com/jeffvli/sonixd/main/assets/screenshots/0.5.0/artist.png"><img src="https://raw.githubusercontent.com/jeffvli/sonixd/main/assets/screenshots/0.5.0/artist.png" width="49.5%"/></a>
<a href="https://raw.githubusercontent.com/jeffvli/sonixd/main/assets/screenshots/0.5.0/context_menu.png"><img src="https://raw.githubusercontent.com/jeffvli/sonixd/main/assets/screenshots/0.5.0/context_menu.png" width="49.5%"/></a>
<a href="https://raw.githubusercontent.com/jeffvli/sonixd/main/assets/screenshots/0.5.0/now_playing.png"><img src="https://raw.githubusercontent.com/jeffvli/sonixd/main/assets/screenshots/0.5.0/now_playing.png" width="49.5%"/></a>

## Install

You can install sonixd by downloading the [latest release](https://github.com/jeffvli/sonixd/releases) for your specified operating system.

- Windows: `.exe`
- Linux: `.AppImage`
- MacOS: `.dmg`

Once installed, run the application and sign in to your music server with the following details. If you are using [airsonic-advanced](https://github.com/airsonic-advanced/airsonic-advanced), you will need to make sure that you create a `decodable` credential for your login user within the admin control panel.

- Server - `e.g. http://localhost:4040/`
- User name - `e.g. admin`
- Password - `e.g. supersecret!`

If you have any questions, feel free to check out the [Usage Documentation & FAQ](https://github.com/jeffvli/sonixd/discussions/15).

## Development / Contributing

This project is built off of [electron-react-boilerplate](https://github.com/electron-react-boilerplate/electron-react-boilerplate) v2.3.0.
If you want to contribute to this project, please first create an [issue](https://github.com/jeffvli/sonixd/issues/new) or [discussion](https://github.com/jeffvli/sonixd/discussions/new) so that we can both discuss the idea and its feasability for integration.

First, clone the repo via git and install dependencies:

```bash
git clone https://github.com/jeffvli/sonixd.git
yarn install
```

Start the app in the `dev` environment:

```bash
yarn start
```

To package apps for the local platform:

```bash
yarn package
```

If you are unable to run via debug in VS Code, check troubleshooting steps [here](https://github.com/electron-react-boilerplate/electron-react-boilerplate/issues/2757#issuecomment-784200527).

If your devtools extensions are failing to run/install, check troubleshooting steps [here](https://github.com/electron-react-boilerplate/electron-react-boilerplate/issues/2788).

## License

[GNU General Public License v3.0 ©](https://github.com/jeffvli/sonixd/blob/main/LICENSE)