Troubleshooting and Advancedsettings.xml: Difference between pages

Revision as of 16:34, 22 November 2008

The "advancedsettings.xml" file, which does not exist by default, may be created by a user in their "\UserData\" folder.
This file can contain additional settings and pre-defined values for the settings available in the GUI (thus removing them from the GUI settings screens).
"advancedsettings.xml" is useful for advanced/expert users and for installers.

NOTE! This file will not exist unless created by the end-user, meaning YOU!

The XBMC software will never write to this file, so any settings you define will not be overwritten by any XBMC GUI settings.
So you can only edit this file manually on your computer, via a text-editor (like Notepad in Windows or a XML-editor).
All the settings available outside of the GUI are documented on this page.

NOTE: This file is CaSe SeNsItIvE, so make sure you use all lower-case tags or they will not be read properly by XBMC.

Layout

The layout of advancedsettings.xml is as follows:

   <setting>value</setting>
   ...
   <setting>value</setting>

</advancedsettings> </xml>

where "setting" gives the name of the setting, and "value" gives it's value.

A list of the available "setting" strings and their values is given below.

List of available settings

<loglevel>

The logging level that XBMC will use to log errors and information. Available values are:

-1 No logging, suppresses all log output.
0 Normal logging, only logging errors (Default)
1 Debug logging.
2 Debug logging with freemem, fps and cpu usage shown on screen.
3 Debug logging with freemem, fps and cpu usage and full smb logging.

<cddbaddress>

The address of the online CDDb database. You may set this to another freedb mirror if there is a more suitable one. Defaults to freedb.freedb.org

<nodvdrom>

Set to true if you have no DVD-ROM drive in your XBox, or if it's broken. Defaults to false.

<usepcdvdrom>

Set to true if you have replaced the XBox DVD-ROM drive with a standard PC DVD-ROM. Expect performance to be somewhat variable. Defaults to false.
removed for non XBox builds with r14123.

<detectasudf>

Set to true if you wish to detect joint ISO9660/UDF disks as UDF. Defaults to false.

<disablemodchipdetection>

Set to true to disable modchip detection. This is required for X2 chips to launch XBEs.

<cachepath>

Set to the path on the XBox Harddisk that XBMC should use for when it caches files (such as when caching subtitles or for unzipping or unrarring). Defaults to Z:\

<virtualshares>

Set to false to disable virtual shares like plugins, last.fm or shoutcast sources. Defaults to true.

<pictureextensions>

A list of additional file-extensions to allow (add) or exclude (remove) in the My Pictures window.

These are the current default extensions for PICTURES:

.png .jpg .jpeg .bmp .gif .ico .tif .tiff .tga .pcx .cbz .zip .cbr .rar .m3u

 <add>.ex1|.ex2</add>
 <remove>.ex3|.ex4</remove>

</pictureextensions> </xml>

<musicextensions>

A list of additional file-extensions to allow (add) or exclude (remove) in the My Music windows.

These are the current default extensions for MUSIC:

.nsv .m4a .flac .aac .strm .pls .rm .mpa .wav .wma .ogg .mp3 .mp2 .m3u .mod .amf .669 .dmf .dsm .far .gdm .imf .it .m15 .med .okt .s3m .stm .sfx .ult .uni .xm .sid .ac3 .dts .cue .aif .aiff .wpl .ape .mac .mpc .mp+ .mpp .shn .zip .rar .wv .nsf .spc .gym .adplug .adx .dsp .adp .ymf .ast .afc .hps .xsp

 <add>.ex1|.ex2</add>
 <remove>.ex3|.ex4</remove>

</musicextensions> </xml>

<videoextensions>

A list of additional file-extensions to allow (add) or exclude (remove) in the My Video windows.

These are the current default extensions for VIDEOS:

.m4v .3gp .nsv .ts .ty .strm .rm .rmvb .m3u .ifo .mov .qt .divx .xvid .bivx .vob .nrg .img .iso .pva .wmv .asf .asx .ogm .m2v .avi .bin .dat .dvr-ms .mpg .mpeg .mp4 .mkv .avc .vp3 .svq3 .nuv .viv .dv .fli .flv .rar .001 .wpl .zip

 <add>.ex1|.ex2</add>
 <remove>.ex3|.ex4</remove>

</videoextensions> </xml>

<languagecodes>

Translation table for subtitle and audio names. Contains entries of the form

<xml>

   <short>alt</short><long>Alternate</long>

</xml>

<sorttokens>

Allows you to specify additional tokens that will be ignored at the start of lines during sorting. <xml>

 <sorttokens>
   <token>the</token>
 </sorttokens>

</xml>

<samba>

  <doscodepage></doscodepage>  
  <clienttimeout>10</clienttimeout>  
  <nostat>false</nostat>

</samba> </xml>

<moviestacking>

This tag used to be called <videostacking>.
Contains regular expressions for use in matching filenames in a "stack" of video files. The regular expression must have a (...) surrounding the volume label portion. Text matching is compared case-insensitive. Anything matched by the regular expression will be removed from the titlename. If more than one (...) section is used, the first one will be the prefix, the second one the volume label, and the third one (if it exists) will be the suffix. Use this to keep extensions after matching. If more than one expression matches a particular filename, the first one will be used.

Default stacking: <xml>

 <moviestacking>
   <regexp>[ _\.-]+cd[ _\.-]*([0-9a-d]+)</regexp>
   <regexp>[ _\.-]+dvd[ _\.-]*([0-9a-d]+)</regexp>
   <regexp>[ _\.-]+part[ _\.-]*([0-9a-d]+)</regexp>
   <regexp>[ _\.-]+dis[ck][ _\.-]*([0-9a-d]+)</regexp>
   <regexp>()[ _\.-]+([0-9]*[abcd]+)(\.....?)$</regexp>
   <regexp>([a-z])([0-9]+)(\.....?)$</regexp>
   <regexp>()([ab])(\.....?)$</regexp>
 </moviestacking>

</xml>

If the argument action="append" or append="yes" is supplied, the default videostacking regular expressions will remain intact and the user specified ones will be added to the end. Example: <xml>

 <moviestacking action="append">
   <regexp>custom[ _\.-]*([0-9a-d]+)</regexp>
 </moviestacking>

</xml>

If the argument action="prepend" is supplied, the default videostacking regular expressions will remain intact and the user specified ones will be added to the beginning. Example: <xml>

 <moviestacking action="prepend">
   <regexp>custom[ _\.-]*([0-9a-d]+)</regexp>
 </moviestacking>

</xml>

If no argument is supplied, or the argument append="no" is supplied, the default videostacking regular expressions are overwritten by the user specified ones.

<tvshowmatching>

Contains regular expression to match the season and episode numbers in filenames.

Default stacking:

<xml>

 <tvshowmatching>
   <regexp>\[[Ss]([0-9]+)\]_\[[Ee]([0-9]+)([^\\/]*)</regexp>  
   <regexp>[\._ \-]([0-9]+)x([0-9]+)([^\\/]*)</regexp>  
   <regexp>[\._ \-][Ss]([0-9]+)[\.\-]?[Ee]([0-9]+)([^\\/]*)</regexp>  
   <regexp>[\._ \-]([0-9]+)([0-9][0-9])([\._ \-][^\\/]*)</regexp>  
 </tvshowmatching>

</xml>

The "append" and "action" arguments described in the videostacking section work the same for tvshowmatching tags. Examples of matching regexps for certain filenames can be found on the TV_Shows page.

NOTE: for multi-episode matching to work, there needs to be a third set of parentheses on the end. This part is fed back into the regexp engine.

<excludefromscan>

Contains regular expressions to match filenames which should be excluded from a library scan.

Default stacking:

<xml>

 <excludefromscan>
   <regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
 </excludefromscan>

</xml>

The "append" and "action" arguments described in the videostacking section work the same for excludefromscan tags.

<pathsubstitution>

Path substitutions for use with playlist loading. These are processed in order, and are useful for substituting an absolute path on a PC with a path suitable for XBMC to handle. Default is no path substitutions defined. An example is:

<xml>

 <pathsubstitution>
   <substitute>
     <from>G:\dvds\</from>
     <to>smb://somecomputer/g-share/dvds/</to>
   </substitute>
 </pathsubstitution>

</xml>

<forcedswaptime>

Use to force a backbuffer->frontbuffer swap while vsync is enabled. Set to the time (in ms) to allow for the swap (eg <forcedswaptime>1</forcedswaptime> is typical). It defaults off.

<playlistasfolders>

In the recent releases, playlists are treated as folders. Selecting a playlist no longer plays it, but opens it, as if it were a folder.
Set to false to revert to the previous behavior. When you select a playlist, its content is added to the list of elements to be played.
NOTE! This setting will not affect smart playlists, they will always show as folders.

<playlistretries>

The default number of retries if for example a source is offline is 100. With this control you can alter the number of consecutive failed items before a playlist fails.

<xml>

 <playlistretries>100</playlistretries>

</xml>

<playlisttimeout>

The default timeout before item failure is 20 sec. It can be changed with this control

<xml>

 <playlisttimeout>20</playlisttimeout>

</xml>

<songinfoduration>

This controls how long the song information will remain onscreen when the song changes during visualisations. The valid range is 1 to 15, in seconds. This does not include the duration of any transition effects. (The default is 2 seconds.)

<xml>

 <songinfoduration>10</songinfoduration>

</xml>

<remoterepeat>

The repeat delay for the Infrared remote control, in milliseconds. Length of time a remote button needs to be held before it will start repeating (ie continuously sending button pushes while it's held down). Defaults to 480.

<controllerdeadzone>

Deadzone for controller thumb sticks. 0 indicates no deadzone at all. 1 indicates all deadzone (ie no movement will be detected). Defaults to 0.2

<displayremotecodes>

Set to true to have XBMC display the Infrared Remote's button codes (OBC's) on screen when you press buttons. Useful for assigning functions to the buttons on a universal remote control. Defaults to false.

<thumbsize>

Size of the square in pixels that XBMC will use to cache thumbnail images. If the thumb is smaller than this size it will be cached as-is. If it is larger it will be scaled so that the number of pixels is less than a square of this value. Default is 512 (192 on xbox), which refers to 512x512 = 262144 (for XBox 192x192 = 36864) pixels in total. The thumbnail will be cached at using the same aspect ratio as the original image, using up to 262144 (for XBox 36864) pixels.

<musicthumbs>

A list of additional files to try when searching for music thumbnail images. (The default is folder.jpg which can be removed.)

 <remove>folder.jpg</remove>
 <add>thumb.jpg|cover.jpg</add>

</musicthumbs> </xml>

<musicfilenamefilters>

Contains filters to match music information (artist, title etc.) from a tagless music filename. The first <filter> to match completely is used. Matched items include:

%A - Artist %T - Title %B - Album %N - Track number %S - Part of set (disk number) %D - Duration %G - Genre %Y - Year %R - Rating

<xml>

 <musicfilenamefilters>
   <filter>%A - %T</filter>
 </musicfilenamefilters>

</xml>

<dvdthumbs>

A list of additional files to try when searching for dvdrom thumbnail images. (The default is folder.jpg which can be removed.)

 <remove>folder.jpg</remove>
 <add>thumb.jpg|cover.jpg</add>

</dvdthumbs> </xml>

<masterlock>

If you enable any masterlock settings below, they will be removed from UI. Code needs to be MD5'd, and you can use this site to hash it.

<xml>

  <startuplock>false</startuplock>  
  <enableshutdown>false</enableshutdown>  
  <automastermode>false</automastermode>  
  <loginlock>true</loginlock>  
  <maxretries>3<maxretries>

</masterlock> </xml>

<postprocessing>

MPlayer postprocessing settings. This is unreliable, and so they're in here only.

<xml>

 <postprocessing>
   <enable>false</enable>  
   <auto>true</auto>  
   <verticaldeblocking>false</verticaldeblocking>  
   <verticaldeblocklevel>0</verticaldeblocklevel>  
   <horizontaldeblocking>false</horizontaldeblocking>  
   <horizontaldeblocklevel>0</horizontaldeblocklevel>  
   <autobrightnesscontrastlevels>false</autobrightnesscontrastlevels>  
   <dering>false</dering>  
 </postprocessing>

</xml>

<audio>

 <headroom>0</headroom>
 <karaokesyncdelay>0</karaokesyncdelay>  
 <defaultplayer>paplayer</defaultplayer>

</audio> </xml>

<video>

 <subsdelayrange>10</subsdelayrange>  
 <audiodelayrange>10</audiodelayrange>  
 <smallstepbackseconds>7</smallstepbackseconds>  
 <smallstepbacktries>3</smallstepbacktries>
 <smallstepbackdelay>300</smallstepbackdelay>
 <usetimeseeking>true</usetimeseeking>  
 <timeseekforward>30</timeseekforward>  
 <timeseekbackward>-30</timeseekbackward>  
 <timeseekforwardbig>600</timeseekforwardbig>  
 <timeseekbackwardbig>-600</timeseekbackwardbig>  
 <percentseekforward>2</percentseekforward>  
 <percentseekbackward>-2</percentseekbackward>  
 <percentseekforwardbig>10</percentseekforwardbig>  
 <percentseekbackwardbig>-10</percentseekbackwardbig>  
 <blackbarcolour>1</blackbarcolour>  
 <fullscreenonmoviestart>true</fullscreenonmoviestart> 
 <defaultplayer>dvdplayer</defaultplayer>

</video> </xml>

<musiclibrary>

Options specific to the Music Library

<xml>

 <musiclibrary>
   <hideallitems>true</hideallitems> 
   <allitemsonbottom>true</allitemsonbottom> 
   <hidecompilationartists>true</hidecompilationartists>
   <albumssortbyartistthenyear>true</albumssortbyartistthenyear>
   <albumformat>%B - %Y</albumformat>  
   <albumformatright>%A</albumformatright>  
   <prioritiseapetags>true</prioritiseapetags>  
   <itemseparator> / </itemseparator>
 </musiclibrary>

</xml>

<videolibrary>

Options specific to the Video Library

<xml>

 <videolibrary>
   <allitemsonbottom>true</allitemsonbottom>  
   <backgroundupdate>true</backgroundupdate> 
   <cleanonupdate>true</cleanonupdate>  
   <hideallitems>true</hideallitems>  
   <hideemptyseries>true</hideemptyseries>  
   <hiderecentlyaddeditems>true</hiderecentlyaddeditems>  
   <itemseparator> / </itemseparator>  
 </videolibrary>

</xml>

<slideshow>

 <panamount>2.5</panamount>
 <zoomamount>5.0</zoomamount>
 <blackbarcompensation>20</blackbarcompensation>

</slideshow> </xml>

<lcd>

 <rows>4</rows>               
 <columns>20</columns>        
 <address1>0</address1>       
 <address2>20</address2>      
 <address3>64</address3>      
 <address4>84</address4>      
 <heartbeat>true</heartbeat>  
 <scrolldelay>2</scrolldelay>

</lcd> </xml>

<network>

 <autodetectpingtime>30</autodetectpingtime>  
 <curlclienttimeout>10</curlclienttimeout>  
 <httpproxyusername></httpproxyusername>  
 <httpproxypassword></httpproxypassword>

</network> </xml>

<tuxbox>

<xml>

<tuxbox>
   <audiochannelselection>false</audiochannelselection>
   <submenuselection>false</submenuselection>
   <defaultrootmenu>0</defaultrootmenu>
   <defaultsubmenu>4</defaultsubmenu>
   <pictureicon>true</pictureicon>
   <epgrequesttime>10</epgrequesttime>
   <zapwaittime>0</zapwaittime>  
 </tuxbox>

</xml>

<playcountminimumpercent>

Video: Minimum percentage that has to be played before it is marked as watched.

Music: Minimum percentage that has to be played before it is considered for incrementing in the Top 100 database view, or for last.fm submittal.

<ftpshowcache>

default is false, if set to true, shows cache (X Y Z) partitions in the root directory listing

<screensaver>

To avoid potential worries of plasma screen burn-in, you can set the Dim screensaver fade level to 0% here or in the Settings. <xml> <screensaver>

 <dimlevel>0</dimlevel>

</screensaver> </xml>

<busydialogdelay>

Set the delay in milliseconds before the busydialog pops up (default 2000). <xml> <busydialogdelay>2000</busydialogdelay> </xml>

<rootovershoot>

Disable root overshooting aka evil B(tm) navigation. 'Evil B' navigation refers to the 'previous folder' action returning to the parent window from the root location of a media window. Sometimes a user would just want to repeatedly hit the B button to reach the root location without worrying of overshooting to the previous window. For this you should disable evil b by setting this value to false. <xml> <rootovershoot>false</rootovershoot> </xml>

<hosts>

Static dns entries which take precedence over your dns server. <xml> <hosts>

 <entry name="HOSTNAME">IPADDRESS</entry>

</hosts> </xml>

<fullscreen>

Starts XBMC in full screen (check resolutions!). The same as starting XBMC with -fs.

<xml> <fullscreen>false</fullscreen> </xml>

How to include GUI settings

You can also define the settings normally defined in the GUI in advancedsettings.xml. Any GUI based settings defined in advancedsettings.xml will override the GUI values, and the settings will be removed completely from the GUI (ie only alterable by editting advancedsettings.xml).

The easiest way to include a GUI setting is to first make sure it is set in the GUI to the value that you want, and then to open the UserData\guisettings.xml file and find the XML entry that corresponds to that setting.

Then just add that entry to the advancedsettings.xml file.

For instance, to set the Font Character Set for the GUI (found in the appearance setting, in the Look and Feel section), you'd open up guisettings.xml and find:

<xml>

 <lookandfeel>
   <charset>Hebrew (Windows)</charset>
 </lookandfeel>

</xml>

Simply take that entry and place it in advancedsettings.xml. The GUI entry for the character set will then no longer appear, and XBMC will always use the Hebrew (Windows) character set.

Here are some special cases, if they aren't defined the user will be prompted first time he/she tries to access any of these paths:
Note: There are no default pre-set values

<trainerpath>

   <trainerpath>Q:\system\trainers</trainerpath>

</myprograms> </xml>

<recordingpath>

   <recordingpath>E:\Recordings</recordingpath>

</mymusic> </xml>

<cddaripperpath>

   <path>E:\Recordings</path>

</cddaripper> </xml>

<playlistspath>

   <playlistspath>E:\Playlists</playlistspath>

</system> </xml>

<screenshotpath>

 <screenshotpath>E:\Screenshots</screenshotpath>

</pictures> </xml>

Troubleshooting and Advancedsettings.xml: Difference between pages

Revision as of 16:34, 22 November 2008

Layout

List of available settings

<loglevel>

<cddbaddress>

<nodvdrom>

<usepcdvdrom>

<detectasudf>

<disablemodchipdetection>

<cachepath>

<virtualshares>

<pictureextensions>

<musicextensions>

<videoextensions>

<languagecodes>

<sorttokens>

<samba>

<moviestacking>

<tvshowmatching>

<excludefromscan>

<pathsubstitution>

<forcedswaptime>

<playlistasfolders>

<playlistretries>

<playlisttimeout>

<songinfoduration>

<remoterepeat>

<controllerdeadzone>

<displayremotecodes>

<thumbsize>

<musicthumbs>

<musicfilenamefilters>

<dvdthumbs>

<masterlock>

<postprocessing>

<audio>

<video>

<musiclibrary>

<videolibrary>

<slideshow>

<lcd>

<network>

<tuxbox>

<playcountminimumpercent>

<ftpshowcache>

<screensaver>

<busydialogdelay>

<rootovershoot>

<hosts>

<fullscreen>

How to include GUI settings

<trainerpath>

<recordingpath>

<cddaripperpath>

<playlistspath>

<screenshotpath>

Navigation menu

Search