A tool for rendering text using bitmap fonts in PNG format. C#-based port of the original Python version.
Go to file
Síle Ekaterin Liszka 6ea47e71d5 Add mailmap 2021-05-18 21:53:24 -05:00
.gitignore some tooling 2019-11-13 16:30:40 -05:00
.mailmap Add mailmap 2021-05-18 21:53:24 -05:00
CHANGELOG.md initial commit 2019-11-13 16:29:15 -05:00
COPYRIGHT.md initial commit 2019-11-13 16:29:15 -05:00
LICENSE initial commit 2019-11-13 16:29:15 -05:00
Makefile some tooling 2019-11-13 16:30:40 -05:00
Smeargle.cs Smeargle.cs: if output filenames include a path, make sure it exists 2019-11-14 03:13:50 -05:00
Tommy.cs initial commit 2019-11-13 16:29:15 -05:00
example.toml initial commit 2019-11-13 16:29:15 -05:00
example.txt initial commit 2019-11-13 16:29:15 -05:00
melissa8.png melissa8.png: actually include the font, doofus 2019-11-14 03:02:07 -05:00
melissa8.toml initial commit 2019-11-13 16:29:15 -05:00
readme.md initial commit 2019-11-13 16:29:15 -05:00


Smeargle Readme

Smeargle is a utility for prerendering text using image-based fonts. As of this release, it is written in C# rather than Python, making it easier than ever to use.

In order to use this program, you will need four things:

  • A TOML file describing the game, fonts, and scripts used.
  • A TOML file describing the individual fonts.
  • A PNG or BMP file with the font in a gridded layout.
  • A script in plaintext UTF-8 format, with no control codes.

TOML is a simple, but powerful, configuration file format; for more information on the format, see https://github.com/toml-lang/toml .


; This key is required, but exists for your reference.
name="Example Game"

; The following section is a mapping of font names to their TOML
; documents. It is required.
"Melissa 8"="melissa8.toml"

; One [script] section is required per script. The portion after the
; period is configurable. For example, it could be [script.test].

; The value for this key must be a name specified in the [font]
; section.
font="Melissa 8"

; Number of tiles a line *must* have; a message is printed for lines
; shorter than this. Zero (0) means no minimum.

; Maximum number of tiles permitted in a line; a warning is printed and
; the line is truncated if this limit is exceeded. Zero (0) means no
; maximum.

; Tilemap format. This means a mapping is produced for use with Atlas
; or Thingy, or the default format if this key is omitted. Values are,
; naturally, "atlas" or "thingy".

; Whether each tile should be padded to 16-bit references or sized
; dynamically based on the number of unique tiles. 'False' here means
; dynamically sizing.

; This is a number added to the mapping so that the references start at
; a certain point.

; Whether 16-bit references in the tilemap should be in little-endian
; format or not.

; The following are optional; if omitted, a directory will be created
; based on the script filename and the files will be placed there.


; Required, but only for your reference.
name="Melissa 8"

; Currently unenforced and unused, but required for your reference.

; Width of each cell in the font grid
; Height of each cell in the font grid

; Required section.
; Glyph, then a tuple of the index into the font and the width of the
; glyph in pixels. Note that this is 1-indexed. Note that a space (" ")
; reference must exist in order for Smeargle to backfill the output
; correctly.
" "=[115, 4]