Added README.
[irreco.git] / themes / theme-specs.txt
blob777ea7145d1d41aef04e765a240cfaa6e72b6439
3 Irreco Theme Specification v0.4
6 Theme name:
7         Because the directory name which contains the theme files should be
8         always in lower case and without spaces, the user friendly theme 
9         name will be saved into a file called name.
12 Image format:
13         PNG images are recommended, but image format can be anything 
14         GdkPixbuf will load.
15         
16         
17 In Maemo 4.0 Chinook GdkPixbuf can load the following image formats:
18         The Sun raster image format
19         The ICO image format
20         The Targa image format
21         The WBMP image format
22         The PNG image format
23         The PCX image format
24         The TIFF image format
25         The GIF image format
26         The XPM image format
27         The JPEG image format
28         The BMP image format
29         The PNM/PBM/PGM/PPM image format family
30         The XBM image format
31         The ANI image format
34 Button images:
35         A button consists of two images. One for up / unpressed / passive state,
36         and another for down / pressed / active state. The images are suffixed
37         as pressed and unpressed. Up and down button images should be of the 
38         same size.
40         You can make button of any size or form you want, but size of 128x128 
41         pixels is recommended because it is more or less the size of users 
42         thumb on the screen. At any case, much smaller buttons can be difficult
43         to use.
44         
45         Nothing really forces you to create all of the buttons, Irreco can
46         use incomplete themes, but it is nice to do so.
47         
48         Button images are to be saved to /buttons directory.
51 Action buttons:
52         A complete irreco theme should contain the following action buttons:
53         
54         power           Power.
55         up              An arrow up / selection up.
56         down            An arrow down / selection down.
57         left            An arrow left / selection left.
58         right           An arrow right / selection right.
59         ok              An OK / Enter / select button.
60         menu            A menu button.
61         next            Next track / channel.
62         prev            Previous track / channel.
63         play            Play.
64         pause           Pause.
65         playpause       Play / pause toggle button for devices which have a 
66                         combined play/pause button.
69 Numeric buttons:
70         A complete irreco theme should contain the following numeric buttons
71         from 0 to 9:
72         
73         num_0
74         num_1
75         num_2
76         num_3
77         num_4
78         num_5
79         num_6
80         num_7
81         num_8
82         num_9
83         
84         
85 Text buttons:
86         A complete irreco theme should have two buttons without a predefined 
87         icon or text. Irreco will draw text specified by the user inside these 
88         buttons.
89         
90         blank           A blank button of the same size as the other buttons 
91                         in the buttonset.
92         blank_large     A larger rectangular button which can have a longer text
93                         inside. Like a spacebar button of sorts. This should be
94                         2x or 3x the size of a normal button.
97 Backgrounds:
98         Background images should be saved into bg directory inside the theme 
99         directory. The name of the file is what is shown to the user as the 
100         name of the background.
103 Directory structure:
104         The theme images should be stored inside a directory named after the 
105         theme. Filenames should be entirely lovercase, exept in bg directory.
106         
107         evil/
108         evil/bg
109         evil/bg/Evil Darkness.png
110         evil/bg/Evil Glow.png
111         evil/buttons
112         evil/buttons/blank_config_append
113         evil/buttons/blank_pressed.png
114         evil/buttons/blank_unpressed.png
115         evil/buttons/down_pressed.png
116         evil/buttons/down_unpressed.png
117         evil/buttons/left_pressed.png
118         evil/buttons/left_unpressed.png
119         evil/buttons/menu_pressed.png
120         evil/buttons/menu_unpressed.png
121         evil/buttons/next_pressed.png
122         evil/buttons/next_unpressed.png
123         evil/buttons/num_0_pressed.png
124         evil/buttons/num_0_unpressed.png
125         evil/buttons/num_1_pressed.png
126         evil/buttons/num_1_unpressed.png
127         evil/buttons/num_2_pressed.png
128         evil/buttons/num_2_unpressed.png
129         evil/buttons/num_3_pressed.png
130         evil/buttons/num_3_unpressed.png
131         evil/buttons/num_4_pressed.png
132         evil/buttons/num_4_unpressed.png
133         evil/buttons/num_5_pressed.png
134         evil/buttons/num_5_unpressed.png
135         evil/buttons/num_6_pressed.png
136         evil/buttons/num_6_unpressed.png
137         evil/buttons/num_7_pressed.png
138         evil/buttons/num_7_unpressed.png
139         evil/buttons/num_8_pressed.png
140         evil/buttons/num_8_unpressed.png
141         evil/buttons/num_9_pressed.png
142         evil/buttons/num_9_unpressed.png
143         evil/buttons/ok_pressed.png
144         evil/buttons/ok_unpressed.png
145         evil/buttons/pause_pressed.png
146         evil/buttons/pause_unpressed.png
147         evil/buttons/play_pressed.png
148         evil/buttons/play_unpressed.png
149         evil/buttons/playpause_pressed.png
150         evil/buttons/playpause_unpressed.png
151         evil/buttons/power_pressed.png
152         evil/buttons/power_unpressed.png
153         evil/buttons/prev_pressed.png
154         evil/buttons/prev_unpressed.png
155         evil/buttons/right_pressed.png
156         evil/buttons/right_unpressed.png
157         evil/buttons/up_pressed.png
158         evil/buttons/up_unpressed.png