e4b61efcb61e3c5645af08bdbdc385ccc81950b4
[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 fotns 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   ; one or more surfaces, containing glyph images
17   (surface              
18  
19     ; may override default width
20     (glyph-width $w)    
21
22     ; may prevent to form variable-width glyphs from this surface
23     (monospace #t)      
24
25     ; filename containing glyph images,
26     ; related to data/images/engine/fonts/
27     ; any dimentions, RGBS pixel format
28     (glyphs $filename)   
29     
30     ; filename containing shadow images, 
31     ; should fit glyph image
32     (shadows $filename)  
33
34     ; charset definition
35     ; each string represent separate row of glyphs on image
36     ; spaces may be put to skip glyph (not drawn)
37     (chars 
38       $strings)
39   )
40 )
41 These files describes glyphs, contained on images 
42 at data/images/engine/fonts/ 
43 (or any subdirectory)
44
45 Each file describes separate font.
46 When extended fotns put in addon, names should be prefixed, like 
47 addonname-foo.stf to be added to font foo.stf
48
49 (supertux-font
50   ; height of font and glyph on images
51   (glyph-height $h)    
52   
53   ; default width of glyph on images and width of fixed-font
54   (glyph-width $w)   
55
56   ; one or more surfaces, containing glyph images
57   (surface              
58  
59     ; may override default width
60     (glyph-width $w)    
61
62     ; may prevent to form variable-width glyphs from this surface
63     (monospace #t)      
64
65     ; filename containing glyph images,
66     ; related to data/images/engine/fonts/
67     ; any dimentions, RGBS pixel format
68     (glyphs $filename)   
69     
70     ; filename containing shadow images, 
71     ; should fit glyph image
72     (shadows $filename)  
73
74     ; charset definition
75     ; each string represent separate row of glyphs on image
76     ; spaces may be put to skip glyph (not drawn)
77     (chars 
78       $strings)
79   )
80 )