Skip to content

Commit

Permalink
Proper readme
Browse files Browse the repository at this point in the history
Signed-off-by: Daniele Ricci <[email protected]>
  • Loading branch information
daniele-athome committed Feb 4, 2021
1 parent 05675ef commit 4246bf4
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,26 @@ start `snapclient` when Mopidy is stopped and stop it when Mopidy is playing.
Install by running:

```
sudo python3 -m pip mopidy-snapduck
sudo python3 -m pip Mopidy-Snapduck
```

## Configuration

TODO
Before starting Mopidy, you must add configuration for Mopidy-Snapduck to your Mopidy configuration file::

```
[snapduck]
snapclient_path = /path/to/snapclient
snapclient_args = arguments_for_snapclient
```

The following configuration values are available:

* `snapduck/enabled`: If the snapduck extension should be enabled or not. Defaults to `true`.
* `snapduck/snapclient_path`: Path to the snapclient executable. Defaults to `/usr/bin/snapclient`.
* `snapduck/snapclient_args`: Arguments for snapclient. Defaults to none.

## ALSA

When using ALSA Mopidy will not release the sound card immediately after stopping, so it is recommended
to configure a dmix device to enable shared access between Mopidy and the Snapcast client.

0 comments on commit 4246bf4

Please sign in to comment.