Skinning

Skin Compatibility List

Here you can find a full List of supported skins for Xbox Media Center 2.0.0 and above.

General Information

XBMC includes a new GUI library written from scratch. This library allows you to skin/change everything you see in XBMC, from the images, the sizes and positions of all controls, colours, fonts, and text, through to altering navigation and even adding new functionality.

The skin system is quite complex, and this portion of the manual is dedicated to providing in depth information on how it all works, along with tips to make the experience a little more pleasant.

If you are just getting started with skinning XBMC, then it is suggested that the best way to learn is by modifying one of the many existing skins that are available. The default skin, Project Mayhem 3, includes almost all the various tricks and features that make the XBMC skinning engine so powerful, so is an ideal place to start. You may wish to start by having a look through the tutorial section, and try modifying a window or two by adding a button, or altering the textures or layout.

Anatomy of a Skin

Each skin folder must contain a skin.xml and this initial set of sub-folders:

MySkin/skin.xml

This contains the information that XBMC uses to find the other files that XBMC requires to describe it's skin. It also contains credits information, and versioning information.

MySkin/font

This subdirectory contains all fonts used by the skin. you can add/replace fonts here

MySkin/media

This subdirectory contains all the media files (.png/.gif/.jpg...)

MySkin/sounds

This subdirectory contains all the audio files (sounds.xml/.wav...)

MySkin/PAL

This is a resolution-specific folder.

Most skins also include the following set of sub-folders:

MySkin/PAL16x9

This is a resolution-specific folder.

MySkin/NTSC

This is a resolution-specific folder.

MySkin/NTSC16x9

This is a resolution-specific folder.

MySkin/720p

This is a resolution-specific folder.

MySkin/1080i

This is a resolution-specific directory.

XBMC can run in multiple resolutions, and thus can use different files for some resolutions (as there is a big difference between NTSC at 720x480 pixels and 1080i at 1920x1080 pixels!) See here for the order in which it looks for skin files.

More advanced skins may also contain sub-folders for additional components required to make their skin work; for example:

MySkin/extas

Often used to store special skin components or functions (scripts, etc.)

MySkin/docs

Often used to store documentation (readme, changelog, etc.)

The goal is to keep your skin folder structure as cleanly organized as possible as it makes it easier to troubleshoot problems; this is becomes very important if you are working as part of a XBMC skin creation team.

Skin Themes

All the basic media files for a skin should be compressed into the Textures.xpr file, and placed in the media/ folder. You can use the tool XBMCTex for this. All the images that make up the default skin theme should be in the Textures.xpr file.

In addition to this, XBMC allows other .xpr files in the media/ folder, each one representing a different theme for your skin. For instance, you could tint all your main textures a red colour, and create a new theme package Red.xpr? – this gives users more choice in the look of a particular skin. Note that only the textures change when you change themes – the layout stays the same. If the user has selected a theme, then when a control requires a texture, XBMC will first look in the <themename>.xpr file for the texture. It will fall back to the Textures.xpr file if <themename>.xpr doesn't contain the image. This means that the theme .xpr files need only contain the changed textures – all other textures will fallback to using Textures.xpr as usual.

A suggested method of creating a theme is as follows:

1. Run XBMCTex.exe on the folder containing the default texture files, to generate Textures.xpr as you would normally do.
2. Identify the textures you wish to have themed and copy them to a separate folder.
3. Create a separate folder for each theme outside of your normal skin work area, and place the altered copies of each of the textures in them.
4. Run XBMCTex.exe on each of the theme folders created in step 3 to create the themed .xpr files (note you can use the -output switch with XBMCTex.exe to name the theme appropriately).
5. Place Textures.xpr and each of the theme .xpr files in the media/ folder of your skin. XBMC will automatically pick them up.

Fonts

XBMC allows you to customize which fonts are displayed onscreen in the User Interface. See Fonts for more information.

Includes

The other special (and arguably the most important skinning file of all) is includes.xml. This is, as its title suggests, a place from which you can define the default look, size, and positioning of controls, to save you replicating many of the control's attributes throughout the window .xml files. For instance, you can setup the size, and textures used for a button control, thus allowing you to leave those details out in the rest of the skin files, unless ofcourse you want to override the default look or size etc. in a particular window.

This is extremely valuable as it allows you to greatly simplify a lot of the work in building a skin. For one thing, it means that once you have include files setup, many of the default parameters for a different resolution can be done by just altering the parameters within the include file(s) for the different resolution.

With the 2.1 skinning engine, you can infact have more than one include file - you can specify the file attribute when including from a different file, allowing you to have an include file dedicated to a particular set of attributes.

The layout of an includes file is as follows. <xml>

 <includes>
   <include name="whitetext">
     <textcolor>ffffffff</textcolor>
   </include>
   <include file="listdefaults.xml" />
   <default type="button">
     <include>whitetext</include>
   </default>
 </includes>

</xml>

You'll notice in the above example that we have 3 different types of includes. The first <include> tag basically allows a substitution of the tags underneath it whenever it occurs. For instance, if in a window .xml file you have this:

<xml>

 <control type="togglebutton">
   <include>whitetext</include>
   ... other tags go here
 </control>

</xml>

Then it would substitute the <textcolor> tag for where the include tag is. You can have as many includes as you like, and as many tags can be inside an include - even complete controls, or complete control groups.

The second <include> tag in the example demonstrates how to include from a different file. As there is no include name specifies, it will include the contents of the entire file at that point.

The <default> tag is similar to an include, except that it is used in every control of that type - even if you don't specify that the control is to use includes. Thus every buttoncontrol will have the whitetext include in it. Note that you can override this by specifying the <textcolor> tag in the buttoncontrol.

The Window XML Files

The other xml files each define the skin for a single window. They all have the same basic layout, allowing you to place different controls on the window, and define how navigation should operate.

The list of all window .xml files and what they represent may be found here.

The important thing to remember is that each window has a unique identifying number (id). This is how XBMC identifies the window from within the source code. Furthermore, many of the controls within each window should have a unique id as well, unless they're just used as images or labels where navigation is unimportant and XBMC does not need to be able to identify them uniquely. The window id's are all listed in the window list.

The structure of the window .xml files can be found here.

Controls

Controls are the substance of your skin. They define everything from buttons, to text labels, to visualization placement. This portion of the manual will explain each and every control in detail.

Conditional Visibility

XBMC's skinning engine versatility is based apon the fact that the skinner can display and hide portions of the skin using a variety of conditional statements that can be combined to create very user friendly UI implimentations. For further information of available variable and how they can be applied see Conditional Visibility

Animating Your Skin

The XBMC skinning engine supports animations of any control allowing them to rotate, slide, fade or any combination there-of. Combining animations with conditional statements ensure your skin will have stunning effects that appear as professional as a 1st party product.

Skinning Tutorials

This section is designed to help both people who are new to skinning XBMC get to grips with how the system works, as well as dealing with a few things that the old timers may find useful.