Advancedsettings.xml

From Official Kodi Wiki
Revision as of 09:17, 28 June 2006 by Scape (talk)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

This file, which may be created by a user in their XBMC\UserData folder, can contain additional settings and can contain pre-defined values for the settings available in the GUI (thus removing them from the GUI settings screens). Useful for advanced users and for installers.

XBMC will not write to this file, so any settings you define will never be overwritten by XBMC. All the settings available outside of the GUI are documented on this page.

1 Layout

The layout of AdvancedSettings.xml is as follows:

<xml> <AdvancedSettings>

   <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 is given below.

2 List of available settings

2.1 <loglevel>

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

  • 0 Normal logging, only logging errors (Default)
  • 1 Debug logging.
  • 2 Debug logging with freemem shown on screen.
  • 3 Debug logging with freemem and full smb logging.

2.2 <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

2.3 <imdbaddress>

The address of the online IMDb database. You may set this to another of IMDb's servers for more localized results. Defaults to akas.imdb.com

2.4 <autodetectfg>

Set to false if you have an old bios that can't handle the auto-detection of the F and G partitions of the XBox Hard disk drive. Defaults to true.

2.5 <usefdrive>

Set to true if you have an F partition. Only read if <autodetectfg> is set to false.

2.6 <usegdrive>

Set to true if you have a G partition. Only read if <autodetectfg> is set to false.

2.7 <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.

2.8 <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:\

2.9 <pictureextensions>

A list of additional file extensions to allow in the My Pictures window.

<xml> <pictureextensions>

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

</pictureextensions> </xml>

2.10 <musicextensions>

A list of additional file extensions to allow in the My Music windows.

<xml> <musicextensions>

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

</musicextensions> </xml>

2.11 <videoextensions>

A list of additional file extensions to allow in the My Video windows.

<xml> <videoextensions>

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

</videoextensions> </xml>

2.12 <languagecodes>

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

<xml>

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

</xml>

2.13 <samba>

<xml> <samba>

  <doscodepage></doscodepage> # code page to use for filenames
  <clienttimeout>10</clienttimeout> # timeout (in seconds)

</samba> </xml>

2.14 <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>

 <videostacking>
   <regexp>[ _\.-]+cd[ _\.-]*([0-9a-d]+)</regexp>
   <regexp>[ _\.-]+dvd[ _\.-]*([0-9a-d]+)</regexp>
   <regexp>[ _\.-]+part[ _\.-]*([0-9a-d]+)</regexp>
   <regexp>()[ _\.-]+([0-9]*[abcd]+)(\....)$</regexp>
   <regexp>()[\^ _\.-]+([0-9]+)(\....)$</regexp>
   <regexp>([a-z])([0-9]+)(\....)$</regexp>
 </videostacking>

</xml>

2.15 <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>

2.16 <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.

2.17 <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

2.18 <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.

2.19 <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 to within this square. Default is 128.

2.20 <newmyprograms>

Set to true to enable the new My Programs version (more in line with the rest of XBMC).

2.21 <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>

<masterlock>

  <lockmode>#</lockmode> 
  #0 - disabled.
  #1 - numeric, enter a numerical value to unlock.
  #2 - gamepad combo, enter Gamepad key combo and finish with pressing START.
  #3 - fulltext, enter normal textstring to unlock.
        
  <lockcode>#</lockcode> is a MD5 hashed value. 
  Code is dependant on lockmode ofcourse. 
  An easier approach is probably to set code using GUI in XBMC then copy the value from guisettings.xml.
  <lockmusic>false</lockmusic> #true enables lock for My Music section
   
  <lockvideo>false</lockvideo>
   
  <lockpictures>false</lockpictures>
   
  <lockprograms>false</lockprograms>
   
  <lockfiles>true</lockfiles> #false disables lock for My Files section
   
  <locksettings>true</locksettings> #false disables lock for My Settings
   
  <sharelocks>false</sharelocks> #true enables user to set separate locks on shares
   
  <startuplock>false</startuplock> #true prompts user for code upon startup
   
  <enableshutdown>false</enableshutdown> #true shuts down xbox after 3 failed attempts to enter correct code
  AdvancedSettings.xml ONLY:    
  <maxretries>#<maxretries> enter the max number of retries to input code, 3 is default.

</masterlock> </xml>

2.22 <postprocessing>

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

<xml>

 <postprocessing>
   <enable>false</enable>   # enable/disable postprocessing
   <auto>true</auto>        # auto filter settings (overrides the below)
   <verticaldeblocking>false</verticaldeblocking>     # use vertical deblocking
   <verticaldeblocklevel>0</verticaldeblocklevel>     # level of vertical deblocking (0-100)
   <horizontaldeblocking>false</horizontaldeblocking> # use horizontal deblocking
   <horizontaldeblocklevel>0<horizontaldeblocklevel>  # level of horizontal deblocking (0-100)
   <autobrightnesscontrastlevels>false</autobrightnesscontrastlevels> # whether to use mplayers colour balancing
   <dering>false</dering>   # whether to apply the dering filter
 </postprocessing>

</xml>

2.23 <audio>

<xml> <audio>

 <headroom>0</headroom> # Amount of headroom XBMC should use above the maximum volume level, in decibels.  Defaults to 0, valid values 0, 6, 12.

</audio> </xml>

2.24 <video>

<xml> <video> # use "VideoSettings" instead of "video" for builds prior to May 22, 2006

 <subsdelayrange>10</subsdelayrange>  # Delay range for subtitles, in seconds.
 <audiodelayrange>10</audiodelayrange>  # Delay range for audio/video sync, in seconds.
 <smallstepbackseconds>7</smallstepbackseconds>  # Length of the small skip back (normally the BACK button) when playing a video
 <smallstepbacktries>3</smallstepbacktries>
 <smallstepbackdelay>300</smallstepbackdelay>
 <usetimeseeking>true</usetimeseeking>  # Whether to use time based or percentage based seeking.
 <timeseekforward>30</timeseekforward>  # Time to seek forward in seconds when doing a short seek.  Defaults to 30.
 <timeseekbackward>-30</timeseekbackward>  # Time to seek backward in seconds when doing a short seek.  Defaults to -30.
 <timeseekforwardbig>600</timeseekforwardbig>  # Time to seek forward in seconds when doing a long seek.  Defaults to 600 (10 minutes).
 <timeseekbackwardbig>-600</timeseekbackwardbig>  # Time to seek forward in seconds when doing a long seek.  Defaults to -600 (10 minutes).
 <percentseekforward>2</percentseekforward>  # Amount to seek forward as a percentage, when doing a short seek.  Defaults to 2.
 <percentseekbackward>-2</percentseekbackward>  # Amount to seek backward as a percentage, when doing a short seek.  Defaults to -2.
 <percentseekforwardbig>10</percentseekforwardbig>  # Amount to seek forward as a percentage, when doing a long seek.  Defaults to 10.
 <percentseekbackwardbig>-10</percentseekbackwardbig>  # Amount to seek forward as a percentage, when doing a long seek.  Defaults to -10.

</video> # use "VideoSettings" instead of "video" for builds prior to May 22, 2006 </xml>

2.25 <slideshow>

<xml> <slideshow>

 <panamount>2.5</panamount>  # Amount to pan images as a percentage of the screen
 <zoomamount>5.0</zoomamount>  # Amount to zoom images as a percentage of the screen
 <blackbarcompensation>20</blackbarcompensation>  # Amount to compensate (zoom) images to attempt to reduce black bars.  Results in cropping of the longer length of the image in order to reduce the black bars on the shorter length of the image.  Defaults to 20.

</slideshow> </xml>

2.26 <lcd>

<xml> <lcd>

 <rows>4</rows>  # Number of rows to use for the LCD.
 <columns>20</columns>  # Number of columns to use for the LCD.
 <address1>0</address1>  # Memory address for row 1.
 <address2>20</address2>  # Memory address for row 2.
 <address3>64</address3>  # Memory address for row 3.
 <address4>84</address4>  # Memory address for row 4.

</lcd> </xml>

2.27 <network>

<xml> <network>

 <autodetectpingtime>30</autodetectpingtime>  #Length in seconds between pinging the network to detect new xbox's.

</network> </xml>

2.28 <playcountminimumpercent>

Minimum percentage that has to be played of a video before it is marked as watched.

3 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

3.1 <trainerpath>

<xml> <myprograms>

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

</myprograms> </xml>

3.2 <recordingpath>

<xml> <mymusic>

   <recordingpath>E:\Recordings</recordingpath>

</mymusic> </xml>

3.3 <cddaripper.path>

<xml> <cddaripper>

   <path>E:\Recordings</path>

</cddaripper> </xml>

3.4 <screenshotpath> and <playlistspath>

<xml> <system>

   <screenshotpath>Q:\Screenshots</screenshotpath> 
   <playlistspath>E:\Playlists</playlistspath>

</system> </xml>