docs: simplify the readme.
This commit is contained in:
parent
8426d14500
commit
a5bc558486
1 changed files with 2 additions and 70 deletions
72
README.md
72
README.md
|
@ -14,73 +14,9 @@ go to the plugin settings and below the `Initial Program` configuration
|
||||||
choose the smart playlist you want to edit, or `Create new playlist ...`
|
choose the smart playlist you want to edit, or `Create new playlist ...`
|
||||||
to create a new one.
|
to create a new one.
|
||||||
|
|
||||||
### Without the UI
|
[Go here](examples.md) to see some example configurations.
|
||||||
|
|
||||||
After [installing](#installation) the plugin and restarting Jellyfin
|
Below are all the configuration values for a smart playlist.
|
||||||
create a empty file in `config/data/smartplaylists` like this, maybe
|
|
||||||
you want to generate a playlist of your favourite rock songs:
|
|
||||||
|
|
||||||
```
|
|
||||||
$ touch config/data/smartplaylists/Rock.yaml
|
|
||||||
```
|
|
||||||
|
|
||||||
Afterwards run the Task `(re)generate Smart Playlists`, this will rename
|
|
||||||
the `yaml` file and populate it with some default values. You can now
|
|
||||||
adjust the file to your liking. [Go here](examples.md) to see more
|
|
||||||
examples.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
Id: Rock
|
|
||||||
Playlists:
|
|
||||||
- PlaylistId: 24f12e1e-3278-d6d6-0ca4-066e93296c95
|
|
||||||
UserId: 6eec632a-ff0d-4d09-aad0-bf9e90b14bc6
|
|
||||||
Name: Rock
|
|
||||||
Program: (begin (invoke item "IsFavoriteOrLiked" (list *user*)))
|
|
||||||
SortProgram: (begin *items*)
|
|
||||||
Filename: /config/data/smartplaylists/Rock.yaml
|
|
||||||
Enabled: true
|
|
||||||
```
|
|
||||||
|
|
||||||
This is the default configuration and will always match all your
|
|
||||||
favorite songs (and songs which are in favourited albums).
|
|
||||||
|
|
||||||
To change the filter you can append a `|` (pipe) to the Program
|
|
||||||
line and write multiline filters like this:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
Porgram: |
|
|
||||||
(begin
|
|
||||||
(invoke item "IsFavoriteOrLiked" (list *user*)))
|
|
||||||
```
|
|
||||||
|
|
||||||
This is equivalent to the above example (not counting the other
|
|
||||||
fields obviously).
|
|
||||||
|
|
||||||
|
|
||||||
### Id
|
|
||||||
|
|
||||||
Arbitrary Id assigned to this playlist, can usually be left alone.
|
|
||||||
|
|
||||||
### Playlists
|
|
||||||
|
|
||||||
A list of Playlist/User mappings. By default all users get an entry.
|
|
||||||
|
|
||||||
The ids must have the dashes in them as of now. To convert a id
|
|
||||||
from without dashes to the canonical form run this command:
|
|
||||||
|
|
||||||
`echo '<your id here>' | python3 -c 'import uuid; import sys; print(uuid.UUID(sys.stdin.read().strip()))'`
|
|
||||||
|
|
||||||
To get your user id navigate to your user profile and copy the part
|
|
||||||
after `userId` in the address bar.
|
|
||||||
|
|
||||||
#### PlaylistId
|
|
||||||
|
|
||||||
The id of the playlist that should be managed, must be owned by the
|
|
||||||
corresponding user.
|
|
||||||
|
|
||||||
#### UserId
|
|
||||||
|
|
||||||
The user associated with this playlist.
|
|
||||||
|
|
||||||
### Name
|
### Name
|
||||||
|
|
||||||
|
@ -128,10 +64,6 @@ the items by name you could use the following program:
|
||||||
*items*)
|
*items*)
|
||||||
```
|
```
|
||||||
|
|
||||||
### Filename
|
|
||||||
|
|
||||||
The path to this file, only used internally and updated by the program.
|
|
||||||
|
|
||||||
### Enabled
|
### Enabled
|
||||||
|
|
||||||
Enable this playlist, currently ignored.
|
Enable this playlist, currently ignored.
|
||||||
|
|
Loading…
Reference in a new issue