1 Note: This document is short and highly incomplete. If you want to write a new,
2 decent one, it will be more than welcome!
9 A skin (or theme, the two words have almost the same meaning) for VLC is made
10 of many BMP files (Windows Bitmap format) containing all the images needed, and
11 of an XML file describing how these images should be displayed, what happens
12 when the user clicks on a button, etc.
14 Those of you who have already done skins for other softwares shouldn't have too
15 many difficulties to understand how all this works.
22 One cool thing with VLC sliders is that they are not necessarily rectilinear,
23 but they can follow any Bezier curve. So if you want to have a slider moving
24 on a half-circle, or even doing a loop, you can !
26 This is not the place to explain how these curves work, the only thing to know
27 is that a Bezier curve can be caracterised by a set of points. Once you have
28 them (thanks to the graphical utility presented at the end of this file, for
29 example), you just need to enter the list of abscissas in the 'abs' attribute
30 and the list of ordinates (in the same order...) in the 'ord' attribute. The
31 separator is the coma. Example: abs="2,45,88" ord="50,120,50"
33 Bezier curves are used for the SliderControl and the PlaylistControl tags.
40 Basically, you need one bitmap file by state of control. For example, with a
41 image control you'll need 1 image, with a button 2 images (or 3 if you provide
42 the disabled state). A slider will also need 2, one for the static part and
43 another for the mobile part. Of course, the same bitmap file can be used for
44 many controls, provided you want to display the same image!
46 The bitmap format doesn't allow a transparent color, but in the XML file you
47 can specify a color that will be considered as transparent wherever it appears
55 XML is a markup language, like HTML. It won't be explained here any further,
56 please use Google if you don't know what is XML. You'll see, it's rather easy
59 The XML file used for the VLC skins follows a predefined DTD. You can find this
60 DTD in VLC CVS, and its reading is strongly advised, since it contains most of
61 the default values used for the parameters. A skin that doesn't follow the DTD
62 with which VLC was compiled won't be loaded by VLC (and it might even crash
65 For a better comprehension of what follows, you should have a look at the DTD
66 (in modules/gui/skin/parser/dkin.dtd) and/or at an example of valid xml skin
67 (such as modules/gui/skin/skins/default/theme.xml).
69 OK, let's go for an enumeration of the different tags and theor attributes :
71 - Theme: The main tag.
73 - magnet: allows to select the range of action (in pixels) of magnetism
74 with border of screen : that is to say when the distance between the
75 border of the screen and a window is less than this value, the window
76 will stick to the border. 0 means no magnetism.
79 - ThemeInfo: You can enter here some information about you (but this
80 information is currently unused by VLC...)
82 - name: not yet supported.
83 - author: not yet supported.
84 - email: not yet supported.
85 - webpage: not yet supported.
87 - Bitmap: Associates a bitmap file with a name (=identifiant) that will be
88 used by the various controls. Obviously, you need one Bitmap tag for each
91 - id: this is the name of the bitmap that will be used with controls
92 (2 bitmaps shouldn't have the same name).
93 - alphacolor: this is the transparency color of the bitmap. It must be
94 indicated with the following format: "#RRGGBB" (where RR stands for the
95 hexadecimal value of the red component, GG for the green one, and BB for
97 - file: this attribute is used to indicate the path and name of the bitmap
98 file used. This path can be absolute (but you should avoid it as often as
99 possible), or relative to the path of the xml file.
101 - Event: An action that will be associated to a control later.
103 - id: this is the name of the event that will be used with controls.
104 (2 events shouldn't have the same name).
105 - event: see events-howto.txt
106 - key: this is the shortcut key associated with the event. This means that
107 the event will be executed when hitting the correspounding key. It must
108 be indicated with the following format : "MOD+L" where "MOD" is the
109 modifier key ("CTRL" or "ALT") and "L" is the letter in uppercase
110 ("MOD+" is optionnal).
113 - Font: Declares a font to be used in a TextControl or PlaylistControl.
115 - id: this is the name of the font that will be used with controls.
116 Default is "default". (2 fonts shouldn't have the same name).
117 - font: this is the name of the font
119 - size: this is the size of the font in points (pt).
121 - color: this is the color of the font with the following format,
122 "#RRGGBB" (see Bitmap).
123 Default is "#000000" (black).
124 - weight: this is the weight of the font. It must be between 0 and 1000
125 Default is "400" (normal weight). Fewer is thinner...
126 - italic: sets if the font must be in italic format.
128 - underline: sets if the font must be underlined.
131 - Window: A window that will appear on screen.
132 - id: this is the name of the window (it will be only used for events
133 but it is important: 2 windows shouldn't have the same name).
134 - visible: sets if the window should appear or not at the launch of VLC.
136 - x: sets the left position of the window.
138 - y: sets the top position of the window.
140 - fadetime: sets the time in milliseconds of the hide/show fading
143 - alpha: sets the transparency of the window. It must be between 1 and
144 255. 1 is nearly total transaprency and should be avoided. 255 is total
146 Default is "255". You should use high values.
147 - movealpha: sets the transparency of the window when the window is
148 moving. Same range as alpha.
150 - dragdrop: sets if drag and drop of media files is allowed in this
154 - ControlGroup: Adds an offset to the elements it contains. A ControlGroup is
155 only supposed to ease the job of the skin designer, who can adjust the
156 position of a group of controls without modifying all the coordinates, but
157 you can ignore it if you want (only one ControlGroup is necessary, just
158 inside Window). ControlGroup tags can be nested.
162 - y: what do you think ?
165 - Anchor: Creates a "magnetic point" in the current Window. If an anchor of
166 another Window enters in the range of action of this anchor, the 2 anchors
167 will automatically be on the same place, and the windows are "sticked". Each
168 anchor has a priority ('priority' attribute), and the anchor with the
169 highest priority is the winner, which means that when moving its Window all
170 the other anchored Windows will move too. To break the effect of 2 linked
171 anchors, you need to move the Window whose anchor has the lower priority.
173 - x: is it really necessary to explain ?
177 - priority: priority of anchor (see the previous description).
178 No default, must de defined!
179 - range: Range of action of the anchor in pixels.
182 - ImageControl, ButtonControl, CheckBoxControl, TextControl, SliderControl,
183 PlaylistControl: The various visual controls that constitute a Window. They
184 share some properties: 'x' and 'y' for the position, 'visible' for the
185 initial state, 'id' for identifying them (only needed if you want to create
186 an event acting on this particular control) and 'help' for a short
187 description of the control that could be displayed in a special TextControl
188 (see below). All the controls can also accept events, and you have the
189 possibility to associate many events to a control at once, separing them
192 - ImageControl: Creates a simple image. Useful for backgrounds.
193 - image: this attribute must be set to an identifiant of a Bitmap tag.
194 - onclick: the 'event' attribute can be used to associate an event to the
195 image (the event is triggered by a click on the image).
196 Typical use: an Event made with 'WINDOW_MOVE(window)' (where 'window' is
197 the id of a Window) can be associated to an ImageControl of this
198 Window. Hence the Window can be moved via the image...
200 - ButtonControl: Creates a button.
201 - up: identifiant of a Bitmap. Used for drawing the up state of the
203 - down: identifiant of a Bitmap. Used for drawing the down state of the
205 - disabled : identifiant of a Bitmap. Used for drawing the disabled state
207 - onclick: event executed when clicking on the button.
209 - onmouseover: event executed when the mouse cursor enters the button.
211 - onmouseout: event executed when the mouse cursor leaves the button.
213 - tooltiptext : used to display a tooltip.
214 Default is "none" (no tooltip).
216 - CheckBoxControl: Creates a checkbox, i.e. a button with 2 states
217 (checked/unchecked). So you need 6 images for a full-featured checkbox: each
218 state has a basic image, an image corresponding to a click not yet released,
219 and an image for the disabled control. If you supply only the basic images,
220 the other ones will be identical.
222 - img1: identifiant of a Bitmap. Used for drawing control in state 1.
223 - clickimg1: identifiants of a bitmap. Used for drawing control when
224 clicking on it in state 1.
225 Default is the value of 'img1' attribute.
226 - img2: identifiant of a Bitmap. Used for drawing control in state 2.
227 - clickimg2: identifiant of a Bitmap. Used for drawing control when
228 clicking on it in state 2.
229 Default is the value of 'img2' attribute.
230 - disabled1: identifiant of a Bitmap. Used for drawing control in state 1
232 Default is the value of 'img1' attribute.
233 - disabled2: identifiant of a Bitmap. Used for drawing control in state 1
235 Default is the value of 'img2' attribute.
236 - onclick1: event executed when clicking on the control in state 1.
238 - onclick2: event executed when clicking on the control in state 2.
240 - onmouseover1: event executed when the mouse cursor enters the button in
243 - onmouseout1: event executed when the mouse cursor leaves the button in
246 - onmouseover2: event executed when the mouse cursor enters the button in
249 - onmouseout2: event executed when the mouse cursor leaves the button in
253 - TextControl: Creates a text.
255 - font: the font to use, which must be one of the Font identifiants.
256 - text: the text to display.
257 - align: either 'left' or 'center' or 'right'.
259 - scroll: if set to 'true', the text will scroll if it does not fit into
262 - scrollspace: size in pixel between two occurences of the text when
265 - display: this value is a bit special, it allows to have a text
266 auto-updated by VLC. Possible values are 'time', 'left_time',
267 'total_time', 'file_name' (for the current file name with its path),
268 'title' (for the file name without the path) and 'help' (for a help
269 about the controls that defined their 'help' attribute).
270 You can specify several types by separating them with semicolons. To
271 switch between then, just double click on the text.
272 Useful to switch between 'time' and 'left_time'.
273 - width: Width of the text in pixels. If set to "0", the width is
274 automatically calculated to fit with the current text.
277 - SliderControl: Creates a slider. The 'abs' and 'ord' attributes are needed
278 for the Bezier curve that the slider will follow. 'up' and 'down' are the
279 images of the slider. The 'tooltiptext' attribute works, and the slider will
280 automatically append the percentage of the position.
282 - type: two 'types' of sliders are predefined: 'time' for a slider
283 allowing to seek in the stream, and 'volume' for a volume slider.
285 - up: identifiant of a Bitmap.
286 - down: identifiant of a Bitmap.
287 - abs: see SliderControl description and bezier curve description.
288 - ord: see SliderControl description and bezier curve description.
289 - tooltiptext: used to display a tooltip.
290 Default is "none" (no tooltip).
292 - PlaylistControl: Creates a playlist. This tag must contain a SliderControl
293 tag (to allow scrolling in the playlist). If the playlist contains entries
294 wider than the list width, an automatic tooltip will appear with
295 the full name of the entry. The other attributes are rather easy to
298 - width: width of the list in pixels. This is the whole width for file
299 name, number of files in the playlist and info text.
301 - infowidth: width of the info text in pixels.
303 - font: the font to use, which must be one of the Font identifiants.
304 - playfont: the font to use for current playing file, which must be one of
305 the Font identifiants.
307 - selcolor: color in "#RRGGBB" format of the selected files.
308 Default is "#0000FF" (blue).
309 - abs: see PlaylistControl description and bezier curve description.
310 - ord: see PlaylistControl description and bezier curve description.
317 Once your skin is finished, instead of keeping many bitmap files and the XML
318 file, you can compress them in a .tar.gz archive (Winzip and UmtimateZip can do
319 it perfectly, for example). Before doing so, don't forget to rename your XML
320 file into "theme.xml", or VLC won't be able to read it... Then rename your
321 compressed file with the .vlt extension and... that's all! VLC can load
322 directly skins with the .vlt extension.
329 - To generate easily Bezier curves, you can use the curve-maker. Basically,
330 you add and remove points at will, and you can move them to see how the
331 curve evolves. When you have reached the perfect curve, you just have to
332 copy-paste the list of abscissas and ordinates into the 'abs' and 'ord'
333 attributes of your SliderControl or PlaylistControl. The curve-maker also
334 allows to load a bitmap, this could be useful if you want to follow a
335 specific pattern of a slider, for example.
337 - When you are creating your skin, you may want to see the VLC messages where
338 some errors are logged. For this, open a dos window, go to the directory
339 where VLC is installed, and type "vlc -I skin -v --extraintf logger". This
340 should open VLC and a log window (what's more, the logs should be saved in a
341 file called vlc-log.txt). The interesting lines are those with "skin
344 - For the Bitmap tags, don't use absolute paths but relative paths (they are
345 relative to the XML file directory), so that your skin can be reused by
346 anybody without a particular file structure.
348 - To fully use the possibilities given, you should look at how other skins are
349 made, it's often very useful.