summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorLarsAC <LarsAC@e10066b5-e1e2-0310-b819-94efdf66514b>2005-10-06 20:02:17 +0000
committerLarsAC <LarsAC@e10066b5-e1e2-0310-b819-94efdf66514b>2005-10-06 20:02:17 +0000
commite92d344ea60fe0a8aa24cde1437f3a353be4dbbb (patch)
treee0dd30763e6f7781f2138da9ab695f6da20a8379 /README
parent8338a983c93bb0dee0de75ac8ed71b210b67ec04 (diff)
downloadvdr-plugin-muggle-e92d344ea60fe0a8aa24cde1437f3a353be4dbbb.tar.gz
vdr-plugin-muggle-e92d344ea60fe0a8aa24cde1437f3a353be4dbbb.tar.bz2
Adapt documentation
git-svn-id: https://vdr-muggle.svn.sourceforge.net/svnroot/vdr-muggle/trunk/muggle-plugin@849 e10066b5-e1e2-0310-b819-94efdf66514b
Diffstat (limited to 'README')
-rw-r--r--README28
1 files changed, 15 insertions, 13 deletions
diff --git a/README b/README
index 9d9c1f0..2d67c7d 100644
--- a/README
+++ b/README
@@ -231,24 +231,26 @@ If a track has no ID3 tags, the following defaults will be applied:
\section covers COVERS
-muggle can display cover images. Currently, muggle simply displays all
-images which reside in the same directory as the current file.
+Muggle can display cover images (and others). Set the setup entry "Background mode"
+to "Image" to enable this feature. The images are found like this:
-#1. if the database field album.coverimg contains something: This is
-# displayed. If the image file does not exist, show an error.
-#2. else: take the track filename and replace its extension by .jpg
-# if this file exists, display it
-#3. else try the file "cover.jpg" in the current directory. If it
-# does not exist, try parent directory. Repeat until the TLD is
-# reached.
+1. Check whether there are images in the APIC id3v2 tag of the file.
+ If so, expand these and show them on the screen during replay.
+2. Otherwise, check all image files in the directory of the current song
+3. Recursively look into parent directories (up to top level) until at least
+ one image is found and display it.
+4. If no images can be found at all, nothing is displayed.
So if you want a default background for all tracks you should put it
-into TLD/cover.jpg. It is strongly recommended to define such a default
-background. Otherwise if no cover is found for a track, the previously
-displayed cover stays on the screen.
+into the toplevel directory (e.g. cover.jpg). It is strongly recommended to
+define such a default background. Otherwise if no cover is found for a track,
+the previously displayed cover stays on the screen. This is a known "behavior".
+
+Currently, the database entry (album.coverimg) is not taken into account.
During installation, make sure that the script called image_convert.sh
-(from the scripts directory) is somewhere on your path.
+(from the scripts directory) is somewhere on your path. Also, make sure to use
+the -c flag if you use a runvdr (or similar) script.
\section quickuse QUICK INTRO