Add explanation to rtl switch to fonts README
[supertux.git] / data / fonts / README
1 These files describes glyphs, contained on images 
2 at data/images/engine/fonts/ 
3 (or any subdirectory)
4
5 Each file describes separate font.
6 When extended fonts put in addon, names should be prefixed, like 
7 addonname-foo.stf to be added to font foo.stf
8
9 (supertux-font
10   ; height of font and glyph on images
11   (glyph-height $h)    
12   
13   ; default width of glyph on images and width of fixed-font
14   (glyph-width $w)   
15
16   ; text in this font is written from right-to-left (optional)
17   (rtl #t)
18
19   ; one or more surfaces, containing glyph images
20   (surface              
21  
22     ; may override default width
23     (glyph-width $w)    
24
25     ; may prevent to form variable-width glyphs from this surface
26     (monospace #t)      
27
28     ; filename containing glyph images,
29     ; related to data/images/engine/fonts/
30     ; any dimentions, RGBS pixel format
31     (glyphs $filename)   
32     
33     ; filename containing shadow images, 
34     ; should fit glyph image
35     (shadows $filename)  
36
37     ; charset definition
38     ; each string represent separate row of glyphs on image
39     ; spaces may be put to skip glyph (not drawn)
40     (chars 
41       $strings)
42   )
43 )