Readme

   1 ttf2png - True Type Font to PNG converter
   2 Copyright (c) 2004-2018  Mikko Rasa, Mikkosoft Productions
   3
   4
   5 Software requirements
   6
   7 FreeType 2
   8 libpng 1.6
   9 C compiler (preferably GCC)
  10
  11
  12 Command-line options
  13
  14   -r <low>,<high>
  15     Range of code points to convert, specified as unicode code points.  The
  16     default is 0,255, matching the ISO-8859-1 (Latin-1) character set.  Code
  17     points can be specified as plain numbers, unicode code points (U+xxxx) or
  18     UTF-8 characters.  This option can be specified multiple times to add
  19     more ranges to be converted.
  20
  21   -s <pixels>
  22     Font size to use.  The default is 10 pixels.
  23
  24   -l <num>
  25     Number of glyphs to put in one line.  Defaults to autodetect.  Ignored
  26     if -p is used.
  27
  28   -c <pixels>[x<pixels>]
  29     Character cell size.  If only a single number is given, a square cell is
  30     used.  The special values auto and autorect may be used to choose an
  31     autodetected square or rectangle cell, respectively.  The default is auto.
  32     Ignored if -p is used.
  33
  34   -o <filename>
  35     Output file name.  Use - for stdout; the output is a png image, so it's
  36     best to pipe it somewhere.  The default is font.png.
  37
  38   -a
  39     Force autohinter.  By default native hinting is used if present in the
  40     font.
  41
  42   -t
  43     Render glyphs to alpha channel, with grey channel filled with white.  By
  44     default only the grey channel is used.
  45
  46   -i
  47     Invert colors of the glyphs.  When rendering to alpha channel, only the
  48     alpha channel is inverted.  The default is to render black glyphs on a
  49     white background.
  50
  51   -v
  52     Increase the level of verbosity.
  53
  54   -e
  55     Use cells in sequence, without leaving gaps.  By default the position of
  56     each glyph is determined by its code point.  Ignored if -p is used.
  57
  58   -p
  59     Pack the glyphs tightly in the image.  Small gaps are left between glyphs,
  60     controlled by the -n option.  By default glyphs are rendered in a regular
  61     grid.  Creating a definition file is recommended, as the resulting image
  62     can seem rather messy.
  63
  64   -m <pixels>
  65     Leave a margin around the edges of the generated image.  By default glyphs
  66     can touch the edges.  Only used with -p.
  67
  68   -n <pixels>
  69     Control the amount of padding between glyphs.  The default is 1 pixel.
  70     Only used with -p.
  71
  72   -d
  73     File name to write glyph definitions.  See the section below for details.
  74
  75   -h
  76     Print a help message with option summary.
  77
  78
  79 Glyph definition files
  80
  81 Rendering a proportional font correctly requires some positioning and spacing
  82 information, called font metrics.  To that end, ttf2png can write a definition
  83 file alongside the image.
  84
  85 The basic format is line-based.  Empty lines, or those starting with a hash
  86 sign (#), should be ignored.  Data lines consist of a keyword followed by
  87 space-separated fields.
  88
  89 The keyword "font" is followed by five fields with overall information about
  90 the image and the font:
  91
  92   Fields 1-2: width and height of the image
  93   Field 3: nominal size of the font
  94   Fields 4-5: ascent and descent of the font
  95
  96 The keyword "glyph" is followed by eight fields describing a single glyph:
  97
  98   Field 1: the code point of the glyph
  99   Fields 2-3: x and y position of the glyph in the image
 100   Fields 4-5: width and height of the glyph
 101   Fields 6-7: x and y offset of the glyph from its base point
 102   Field 8: advance from this glyph to the next
 103
 104 The keyword "kern" is followed by three fields describing kerning between two
 105 glyphs:
 106
 107   Field 1: the code point of the left-hand glyph
 108   Field 2: the code point of the right-hand glyph
 109   Field 3: kerning distance between the glyphs
 110
 111 The following ASCII art image illustrates most of these metrics.  Note that in
 112 some fonts, not all of the glyphs fit completely inside the character box.
 113
 114                 - - - - - - - -     ^
 115                | character box |    |
 116                                     |
 117                |               |    |
 118                    o-------o        | ascent
 119                |   |       |   |    |
 120                    | glyph |        |
 121                |   |       |   |    |
 122     base point     |       |        |
 123              \ |   |       |   |    |
 124               \    |       |        |
 125            _ __x___|_______|___|____|__ baseline
 126   y_offset |       |       |        |
 127            v   |   o-------o   |    | descent
 128                 - - - - - - - -     v
 129
 130                |--->
 131                x_offset
 132
 133                |--------------->
 134                advance
 135
 136
 137 Changelog
 138
 139 next
 140 - Alternate ways of specifying code point ranges
 141 - Multiple code point ranges can be specified
 142
 143 1.1
 144 - Controllable margin and padding in packed mode
 145 - Do not generate overly large images in sequential grid mode
 146
 147 1.0
 148 - Improve the packing algorithm
 149 - Non-square cells for grid mode
 150 - Option to invert colors
 151 - Include kerning information in definition file
 152
 153 0.3
 154 - Restructure the code
 155 - Add tight packing mode
 156 - Autodetect cell size and chars-per-line in grid mode
 157
 158 0.2.2
 159 - Write both X and Y offsets of glyphs to the definition file
 160 - Output font ascent and descent to definition file
 161
 162 0.2.1
 163 - Don't create too large image with sequential mode if the range is sparse
 164
 165 0.2
 166 - Added output to stdout
 167 - Clean up code a bit
 168 - Added sequential mode
 169 - Added definition file writing
 170
 171 0.1.1
 172 - Added more verbosity
 173 - Added transparency mode
 174
 175 0.1
 176 - Initial release
 177
 178
 179 License
 180
 181 This program is free software; you can redistribute it and/or
 182 modify it under the terms of the GNU General Public License
 183 as published by the Free Software Foundation; either version 2
 184 of the License, or (at your option) any later version.
 185
 186 This program is distributed in the hope that it will be useful,
 187 but WITHOUT ANY WARRANTY; without even the implied warranty of
 188 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 189 GNU General Public License for more details.
 190
 191 You should have received a copy of the GNU General Public License
 192 along with this program; if not, write to the Free Software
 193 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.