# HG changeset patch
# User Matti Hamalainen <ccr@tnsp.org>
# Date 1103665440 0
# Node ID 42632e13d6b55d12a1aecfeaaaa43c4c9c0b40cf
# Parent  d8f088079384bc882fd3f03046fdd2eba098c508
More documentation about configuration.


diff -r d8f088079384 -r 42632e13d6b5 README
--- a/README	Tue Dec 21 21:22:00 2004 +0000
+++ b/README	Tue Dec 21 21:44:00 2004 +0000
@@ -66,6 +66,7 @@
   For SIDPlay 2 emulation, select "Real C64" unless you know better.
   For SIDPlay 1 emulation, select "Bank switching".
 
+
 Emu#2-tab
 ---------
 - Clock Speed: Sets default clockspeed and can also "force" the
@@ -89,6 +90,7 @@
     option available. HardSID is backend for HardSID card,
     but it is not supported yet by XMMS-SID.
 
+
 Filters-tab
 -----------
 - Emulate filters: Enable filter emulation. Usually you will want
@@ -99,18 +101,90 @@
   these are), the defaults will work very well and there is no need
   to touch filter settings.
 
+
 Songlength-tab
 --------------
 Most of song length settings should be self-explanatory. The
 respective "Only when song-length is unknown" options make
 maximum/minimum playtime limits work only when song length
+information is not found from song-length database.
 
-* XSIDPLAY-compatible song-length database is a file that contains
-  lengths for most songs in High Voltage SID Collection (HVSC). I
-  highly recommend that you download the database and configure
-  XMMS-SID to use it. The SLDB is available at
-  http://www.geocities.com/SiliconValley/Lakes/5147/sidplay/sldb.html
+- Use XSIDPLAY-compatible database: If enabled, you can specify
+  song-length database file and it is used. If disabled, the
+  database is not used.
+
+- DB-file: Specify path and filename, usually Songlengths.txt,
+  that contains lengths for most songs in High Voltage SID
+  Collection (HVSC) in XSIDPLAY compatible format, for example:
+  /media/Songlengths.txt
+
+  Click the "Browse" button to get a file selector dialog.
+
+I highly recommend that you download the database and configure
+XMMS-SID to use it. The SLDB is available at
+
+http://www.geocities.com/SiliconValley/Lakes/5147/sidplay/sldb.html
+
+
+Title-tab
+---------
+STIL-database configuration:
+
+- Use STIL information database: If enabled, the settings below
+  take effect and XMMS-SID can utilize additional information
+  from High Voltage SID Collection (HVSC) STIL-database. STIL
+  contains general information about the tune, plus trivia,
+  history and comments from the composers.
+
+- STIL-file: Path and filename STIL database. Usually the STIL
+  file is under DOCUMENTS/ sub-directory of HVSC, for example:
+  /media/C64Music/DOCUMENTS/STIL.txt
+
+- HVSC path: Path to your High Voltage SID Collection directory,
+  for example: /media/C64Music
+
+  Click the "Browse" button to get a file selector dialog.
+
+Song name/title format:
 
+- Override generic XMMS titles: Enable to override generic XMMS
+  titlestring setting and use XMMS-SID specific titlestring
+  format.
+
+
+Misc-tab
+--------
+Sub-tune control:
+
+- Disabled: No separate sub-tune control. The sub-tune selector
+  in XMMS-SID's fileinfo dialog will still be enabled.
+
+- Seek back/forward changes sub-song: This method is similar to
+  the one used in "XMMS-SidPlay"
+
+- Pop-up via seekbar (UADE-style): Similar to selector used in
+  Unix Amiga Delitracker Emulator (UADE). Any interaction with
+  XMMS's seeking capabilities pops up a sub-tune control window.
+  Mouse and arrow keys can be used to select a tune. Escape key
+  (ESC) or moving mouse out of the window closes it.
+
+- Song-position patch: If you have a patched version of XMMS
+  (patched with song-position patch, which comes with XMMS-SID),
+  you can select this method. Then you can use XMMS's seekbar
+  to select the sub-tune. (Back in XMMS-SID v0.7 this was the
+  only option.)
+
+Automatic sub-tune changes:
+
+- Go through all sub-tunse in file:
+
+- Only tunes with specified minimum length:
+
+Miscellaneous options:
+
+- Detect file by contents:  If XMMS-SID doesn't recognize your
+  SID-tunes, try enabling this option. It is EXTREMELY slow if
+  you're reading a 10000-tune playlist, though.
 
 
 Miscellaneous tips
@@ -125,11 +199,6 @@
 * Filter-settings can be usually left as they are, unless you know
   what you're doing.
 
-* If the plugin doesn't recognize your SID-tunes, try checking the
-  'Determine filetype by contents' option in the XMMS-SID config
-  window. This is EXTREMELY slow if you're reading a 10000-tune
-  playlist, though.
-
 * For those who don't know it: Autopanning and stereo are not native
   to the original SID chip, but are extra options implemented in
   libSIDPlay. So if you think that the tune does not sound as it