Netherworld's Pretend Minibar
    Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »



    This is a node.js-based command-line tool for generating font files in either C header format (suitable for hacking on hardware projects) or PSF files (suitable for the Linux framebuffer console).

    It expects the fonts to be painted into a grid in a BMP file, and will detect the grid dimensions by the whitespace between letters. Some example BMP files are in the fonts/ folder.

    Header files

    "Header file" format is a C header file describing the character height, the glyph cell data, and a table of offsets. All glyphs must be the same height, but they can be different widths (proportional fonts). The glyph data for character N starts at offset[N] (inclusive) and goes through offset[N + 1] (exclusive).

    Each int is a single column of pixels, with the LSB at the top. The columns are listed left-to-right. Having the LSB at the top may seem weird, but it allows for fast decoding if you draw top-to-bottom: each pixel can mask off the lowest bit and then shift right one place.

    In the BMP file, glyphs that aren't as wide as the cell should be pushed up against the left edge. Font-problems will detect the whitespace on the right edge, and remove it.

    PSF files

    PSF file format is described here:

    Each glyph must be the same width and height in a PSF file (monospace), and exactly 256 or 512 characters must be defined. BIOS only supports a glyph width of 8, so only framebuffers can use smaller widths. (Linux still uses BIOS to draw text in a surprising number of cases.)

    Font-problems will generate a simple unicode mapping table for PSF files, which you can specify with "--map". The argument to "--map" can be a sequence of code point ranges, or it can be the name of a filename with this list in it (called an "fmap file"). Some sample fmap files are included with the sample fonts.

    Sample fonts

    Three sample fonts are included:

    • "Tom Thumb" from my blog, with some line-drawing and block characters added, for console tools like Midnight Commander. Each cell is 4x6, which I believe is the smallest a bitmap font can be while still having any legibility.

    • "Lola" is a simple proportional font, ranging from 4x8 to 6x8. It was designed to work on LED matrix displays like this one.

    • "Lola12" is a larger monospace font, 6x12, meant for use on larger Linux terminals, or where more legibility is desired. It's roughly equivalent to the smallest standard Linux console font (Terminus12) but looks nicer IMHO.

    All of these fonts are licensed as Creative Commons "share & adapt": -- I'd also love to see any modifications or additions, to possibly merge them back in.




    npm i font-problems

    Downloadslast 7 days







    last publish


    • avatar