Readme

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