Updated docs
This commit is contained in:
+29
-50
@@ -4,7 +4,7 @@ Shanty can generate playlists from your library using similar-artist data from L
|
||||
|
||||
## Requirements
|
||||
|
||||
Playlist generation using the **similar-artist** strategy requires a Last.fm API key. Set it via the `SHANTY_LASTFM_API_KEY` environment variable:
|
||||
Playlist generation requires a Last.fm API key. Set it via the `SHANTY_LASTFM_API_KEY` environment variable:
|
||||
|
||||
```yaml
|
||||
# In docker-compose.yml
|
||||
@@ -14,29 +14,40 @@ environment:
|
||||
|
||||
Get a free API key at: https://www.last.fm/api/account/create
|
||||
|
||||
Other playlist strategies (genre, random, smart rules) do not require an API key.
|
||||
When creating your API account, use any application name and leave the callback URL blank or enter `http://localhost`.
|
||||
|
||||
## Generating a playlist
|
||||
|
||||
1. Open the Shanty web UI and go to **Playlists**.
|
||||
2. Click the **Generate** tab.
|
||||
3. Choose a generation strategy:
|
||||
- **Similar Artists** -- Start with one or more seed artists and build a playlist from their music and music by similar artists. This is the most useful strategy for discovering connections in your library.
|
||||
- **Genre** -- Filter tracks by genre tags.
|
||||
- **Random** -- A random selection from your library.
|
||||
- **Smart Rules** -- Define rules based on track attributes (artist, album, year, genre, etc.).
|
||||
4. For the Similar Artists strategy:
|
||||
- Search for and select one or more **seed artists**.
|
||||
- Adjust **popularity bias** (higher values favor well-known tracks, lower values dig deeper).
|
||||
- Set the **track count** (how many tracks in the playlist).
|
||||
- Choose **ordering**: interleave (mix artists evenly), score (highest match first), or random.
|
||||
5. Click **Generate**.
|
||||
3. Search for and select one or more **seed artists** from your library. The dropdown shows all artists you have tracks for.
|
||||
4. Adjust **popularity bias** (higher values favor well-known tracks, lower values dig deeper).
|
||||
5. Set the **track count** (how many tracks in the playlist).
|
||||
6. Choose **ordering**:
|
||||
- **Interleave** -- spreads artists evenly throughout the playlist, avoiding back-to-back tracks from the same artist.
|
||||
- **By Score** -- highest-scored tracks first (most similar to your seeds, weighted by popularity).
|
||||
- **Random** -- fully shuffled.
|
||||
7. Click **Generate**.
|
||||
|
||||
The generated playlist is shown as a preview. You can then save it or adjust the parameters and regenerate.
|
||||
|
||||
## Saving a playlist
|
||||
### How generation works
|
||||
|
||||
After generating a playlist, click **Save** to give it a name and store it. Saved playlists appear in the **Saved** tab.
|
||||
Shanty uses Last.fm's similar-artist data to find tracks from artists related to your seeds. For example, if you seed with "Radiohead," the playlist might include tracks by Radiohead, Thom Yorke, Portishead, Massive Attack, and other similar artists -- but only tracks that actually exist in your library.
|
||||
|
||||
The **popularity bias** slider (0-10) controls the balance:
|
||||
- Higher values favor popular, well-known tracks from each artist.
|
||||
- Lower values give more equal weight to deep cuts and lesser-known tracks.
|
||||
|
||||
Multiple seed artists are blended together -- artists similar to more of your seeds get higher scores.
|
||||
|
||||
## Creating a blank playlist
|
||||
|
||||
From the **Saved** tab, click **New** to create an empty playlist and open it in the editor. You can then add tracks manually.
|
||||
|
||||
## Saving a generated playlist
|
||||
|
||||
After generating a playlist, enter a name and click **Save Playlist**. Saved playlists appear in the **Saved** tab.
|
||||
|
||||
## Editing a playlist
|
||||
|
||||
@@ -46,47 +57,15 @@ After generating a playlist, click **Save** to give it a name and store it. Save
|
||||
- **Drag and drop** tracks to reorder them.
|
||||
- **Remove** tracks by clicking the remove button next to each track.
|
||||
- **Add** tracks by searching in the track picker at the bottom.
|
||||
- **Rename** the playlist or update its description.
|
||||
- **Rename** the playlist.
|
||||
4. Click **Save** when done.
|
||||
|
||||
## Exporting as M3U
|
||||
|
||||
To export a playlist as an M3U file (compatible with most music players):
|
||||
|
||||
1. Open a saved playlist.
|
||||
2. Click **Export M3U**.
|
||||
3. The file downloads to your computer.
|
||||
|
||||
M3U files contain file paths relative to your library, so they work with any music player that has access to the same library directory.
|
||||
From the **Saved** tab, click **M3U** on any playlist to download it as an M3U file. M3U files are compatible with most music players and contain file paths relative to your library.
|
||||
|
||||
## Playlists via Subsonic
|
||||
|
||||
Saved playlists are available through the Subsonic API. Any Subsonic client that supports playlists (most do) can see and play your Shanty playlists.
|
||||
|
||||
To use this, make sure you have [Subsonic set up](subsonic.md) with a Subsonic password configured.
|
||||
|
||||
## Generation strategies explained
|
||||
|
||||
### Similar Artists
|
||||
|
||||
This uses Last.fm's similar-artist data to find tracks from artists related to your seeds. For example, if you seed with "Radiohead," the playlist might include tracks by Radiohead, Thom Yorke, Portishead, Massive Attack, and other similar artists -- but only tracks that exist in your library.
|
||||
|
||||
The **popularity bias** slider controls the balance:
|
||||
- High bias (closer to 1.0): favors popular/well-known tracks
|
||||
- Low bias (closer to 0.0): gives equal weight to all tracks
|
||||
|
||||
### Genre
|
||||
|
||||
Filters your library by genre tags and selects tracks that match. You can specify one or more genres.
|
||||
|
||||
### Random
|
||||
|
||||
A random sample from your entire library. If ordering is not set to "random," tracks are ordered by artist/album for easier listening.
|
||||
|
||||
### Smart Rules
|
||||
|
||||
Define custom rules like:
|
||||
- Artist contains "Pink Floyd"
|
||||
- Year is between 1970 and 1980
|
||||
- Genre is "Progressive Rock"
|
||||
|
||||
Tracks matching all rules are included, up to the count limit.
|
||||
|
||||
Reference in New Issue
Block a user