From a43ae63f6138523b8e5a0bcc0425df40692ea02f Mon Sep 17 00:00:00 2001
From: "Y.Tory" <5343692+kagemomiji@users.noreply.github.com>
Date: Thu, 13 Jun 2024 15:36:36 +0000
Subject: [PATCH] kagemomiji/airsonic-advanced#254 add document for coverart

---
 docs/media/coverart.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 docs/media/coverart.md

diff --git a/docs/media/coverart.md b/docs/media/coverart.md
new file mode 100644
index 000000000..8ecf7e0cf
--- /dev/null
+++ b/docs/media/coverart.md
@@ -0,0 +1,39 @@
+# Cover Art/ Artist Image
+
+Airsonic-Advanced supports cover art and artist image for your music.
+
+## Configuration
+
+Settings for importing cover art and artist images can be found in the WebUI under `Settings` > `General`.
+
+| item | Description | Default Value |
+| --- | --- | --- |
+| Cover art files | The image file names and extensions to be used as cover art, separated by spaces.| cover.jpg cover.png cover.gif folder.jpg jpg jpeg gif png |
+| Cover art source | The source for obtaining cover art.| Prefer external file over embedded image |
+| Cover art quality | The quality of the cover art.| 90 |
+| Cover art concurrency | Specify the number of cover art thumbnails that can be generated simultaneously (if needed). Higher number means more thumbs can be generated simultaneously, but requires more CPU threads/cores. This setting requires a restart before it takes effect.| 4 |
+
+
+## How it works
+
+Airsonic Advanced handles cover art and artist images under the assumption that files are saved in an artist/album/song folder structure as follows:
+
+### Cover Art for Music Files
+
+Airsonic Advanced handles cover art as follows:
+
+1. Retrieve cover art according to the method specified in Cover art source:
+  - Prefer embedded image over external file: Prioritize the embedded cover art in the file.
+  - Prefer external file over embedded image: Prioritize the image in the same directory as the file.
+  - Use only embedded image: Use only the embedded cover art in the file.
+  - Use only external file: Use only the image in the same directory as the file.
+2. If cover art is not found using the above methods, the default cover art is used.
+
+### Cover Art for Album
+
+The album cover art uses the cover art from one of the music files directly under the album.
+
+### Artist Images
+
+Artist images use images with the `Cover Art files` in the artist directory. If none are found, a default artist image is generated.
+If you set the `Cover art source` to `Use only embedded image`, the artist image will not use files in the artist directory.