bitedutils

README

bited-utils

Pipeline helpers and utilities for building fonts from bited BDFs. Built with Go and Nix flakes.

• bited-build: A command that generates vector (TTF, WOFF2) and bitmap (BDF, PCF, OTB, DFONT) fonts from bited BDFs. Supports integer scaling and Nerd Font patching.
• bited-img: A command that generates image specimens for bited BDFs. Features Base16 color support.
• bited-clr: A TUI tool for fine-tuned coloring of TXT/CLR pairs.
• bited-scale: A command for scaling bited BDFs.
• bited-bbl: A command for proportionalizing bited BDFs.

Built with bited-utils

kirsch

ANAKRON

Nix flake template

In a blank directory where you want your font project to reside, run:

nix flake init --template github:molarmanful/bited-utils

This will create an annotated template project with Nix scaffolding around bited-utils to help get your font project up and running.

TXT/CLR files

To generate colorful images, bited-img accepts pairs of .txt and .clr files. For example, if you have a file test.txt that you wish to color, you would include test.clr containing your desired color codes in the same directory.

A .clr file is really just lines of spaces and color codes. The color codes are as follows:

Code	Definition
0-9, A-F	Set color to a Base16 color
.	Reset to foreground color

All other characters are treated as no-ops and simply pass on the current color.

Codes are interpreted left-to-right, top-to-bottom. The position of a code matches a position in the TXT file where you wish to color. Say you have the following TXT:

Hello, world!
Testing Testing 123

And the following CLR:

A    . D    .
5       6       BCE

Would produce:

Why TXT/CLR?

When designing the pipeline for creating color specimens for my fonts (what would eventually become bited-img), I initially considered several existing approaches to creating the specimen sources:

• Writing Pango markup directly, which would make passing them to ImageMagick super easy.
• Creating ANSI via an editor and then generating the Pango markup.

Both of these approaches suffer from a rather important flaw, however: because they embed color data alongside content in the same file, their source files are difficult to read and/or write in a text editor. So my caveman solution was to just separate the color data into its own file, which preserves a readable TXT source.

My workflow for creating these TXT/CLR files goes something like:

1. Create the TXT file with uncolored contents.
2. Copy the TXT file to CLR.
3. Block out the CLR file with color codes. Neovim's visual block mode is especially well-suited for this.
4. Remove extraneous text and use bited-clr for finer adjustments if necessary.

Documentation

Overview

bited-utils is a set of pipeline helpers and utilities for building fonts from bited BDFs.

Documentation for each utility:

• github.com/molarmanful/bited-utils/bited-build
• github.com/molarmanful/bited-utils/bited-img
• github.com/molarmanful/bited-utils/bited-clr
• github.com/molarmanful/bited-utils/bited-scale
• github.com/molarmanful/bited-utils/bited-bbl

Index

• Constants
• Variables
• func Check(err error)
• func PropString(v any) string
• func WcWidth(r rune, nerd bool) int
• type BDF
  • func R2BDF(r io.Reader) (*BDF, error)
  • func (bdf *BDF) BDF2W(w io.Writer) error
  • func (bdf *BDF) CleanProps()
  • func (bdf *BDF) Scale(scale int) error
  • func (bdf *BDF) WriteChars(w io.Writer) error
  • func (bdf *BDF) WriteProps(w io.Writer) error
• type BmI
• type Glyph
  • func (glyph *Glyph) Bits() iter.Seq2[BmI[[2]int], bool]
  • func (glyph *Glyph) Bytes() iter.Seq2[BmI[[2]int], byte]
  • func (glyph *Glyph) Copy() *Glyph
  • func (glyph *Glyph) Flip(i int, j int)
  • func (glyph *Glyph) Get(i int, j int) (bool, bool)
  • func (glyph *Glyph) H() int
  • func (glyph *Glyph) Hex2Row(i int, s string) error
  • func (glyph *Glyph) Name() string
  • func (glyph *Glyph) NewBm(w int, h int)
  • func (glyph *Glyph) Row32() int
  • func (glyph *Glyph) Row8() int
  • func (glyph *Glyph) Rows() iter.Seq2[int, []uint32]
  • func (glyph *Glyph) SWidth(bdf *BDF) int
  • func (glyph *Glyph) Scale(scale int)
  • func (glyph *Glyph) Set(i int, j int, b bool) bool
  • func (glyph *Glyph) SetRect(oi int, oj int, w int, h int, b bool)
  • func (glyph *Glyph) Uints() iter.Seq2[BmI[[2]int], uint32]
  • func (glyph *Glyph) W() int
  • func (glyph *Glyph) Write(bdf *BDF, w io.Writer) error
  • func (glyph *Glyph) WriteBm(w io.Writer) error
• type XLFD
  • func ParseXLFD(s string) (*XLFD, error)
  • func (xlfd *XLFD) Props() *orderedmap.OrderedMap[string, any]
  • func (xlfd *XLFD) PtSize() int
  • func (xlfd *XLFD) String() string
  • func (xlfd *XLFD) ValidateSlant() error
  • func (xlfd *XLFD) ValidateSpacing() error

Constants

const (
	PRE = iota
	X
	PROPS
	CHARS
	CHAR
	BM
	POST
)

Variables

var NerdFont = &unicode.RangeTable{
	R16: []unicode.Range16{
		{0x23fb, 0x23fe, 1},
		{0x2b58, 0x2b58, 1},
		{0xe000, 0xe00a, 1},
		{0xe0a0, 0xe0a3, 1},
		{0xe0b0, 0xe0c8, 1},
		{0xe0ca, 0xe0ca, 1},
		{0xe0cc, 0xe0d7, 1},
		{0xe200, 0xe2a9, 1},
		{0xe300, 0xe3e3, 1},
		{0xe5fa, 0xe6b7, 1},
		{0xe700, 0xe8ef, 1},
		{0xea60, 0xec1e, 1},
		{0xed00, 0xefce, 1},
		{0xf000, 0xf381, 1},
		{0xf400, 0xf533, 1},
	},
	R32: []unicode.Range32{
		{0xf0001, 0xf1af0, 1},
	},
}

Functions

func Check

func Check(err error)

Check panics if error is non-nil.

func PropString

func PropString(v any) string

func WcWidth

func WcWidth(r rune, nerd bool) int

Types

type BDF

type BDF struct {
	*XLFD

	Props  *orderedmap.OrderedMap[string, any]
	Glyphs []*Glyph
	// contains filtered or unexported fields
}

func R2BDF

func R2BDF(r io.Reader) (*BDF, error)

func (*BDF) BDF2W

func (bdf *BDF) BDF2W(w io.Writer) error

func (*BDF) CleanProps

func (bdf *BDF) CleanProps()

func (*BDF) Scale

func (bdf *BDF) Scale(scale int) error

func (*BDF) WriteChars

func (bdf *BDF) WriteChars(w io.Writer) error

func (*BDF) WriteProps

func (bdf *BDF) WriteProps(w io.Writer) error

type BmI

type BmI[T any] struct {
	I        T
	IsRowEnd bool
}

type Glyph

type Glyph struct {
	Code   int
	DWidth int

	X int
	Y int
	// contains filtered or unexported fields
}

func (*Glyph) Bits

func (glyph *Glyph) Bits() iter.Seq2[BmI[[2]int], bool]

func (*Glyph) Bytes

func (glyph *Glyph) Bytes() iter.Seq2[BmI[[2]int], byte]

func (*Glyph) Copy

func (glyph *Glyph) Copy() *Glyph

func (*Glyph) Flip

func (glyph *Glyph) Flip(i int, j int)

func (*Glyph) Get

func (glyph *Glyph) Get(i int, j int) (bool, bool)

func (*Glyph) H

func (glyph *Glyph) H() int

func (*Glyph) Hex2Row

func (glyph *Glyph) Hex2Row(i int, s string) error

func (*Glyph) Name

func (glyph *Glyph) Name() string

func (*Glyph) NewBm

func (glyph *Glyph) NewBm(w int, h int)

func (*Glyph) Row32

func (glyph *Glyph) Row32() int

func (*Glyph) Row8

func (glyph *Glyph) Row8() int

func (*Glyph) Rows

func (glyph *Glyph) Rows() iter.Seq2[int, []uint32]

func (*Glyph) SWidth

func (glyph *Glyph) SWidth(bdf *BDF) int

func (*Glyph) Scale

func (glyph *Glyph) Scale(scale int)

func (*Glyph) Set

func (glyph *Glyph) Set(i int, j int, b bool) bool

func (*Glyph) SetRect

func (glyph *Glyph) SetRect(oi int, oj int, w int, h int, b bool)

func (*Glyph) Uints

func (glyph *Glyph) Uints() iter.Seq2[BmI[[2]int], uint32]

func (*Glyph) W

func (glyph *Glyph) W() int

func (*Glyph) Write

func (glyph *Glyph) Write(bdf *BDF, w io.Writer) error

func (*Glyph) WriteBm

func (glyph *Glyph) WriteBm(w io.Writer) error

type XLFD

type XLFD struct {
	Foundry  string
	Family   string
	Weight   string
	Slant    string
	Setwidth string
	AddStyle string
	PxSize   int
	Res      struct {
		X int
		Y int
	}
	Spacing string
	// contains filtered or unexported fields
}

func ParseXLFD

func ParseXLFD(s string) (*XLFD, error)

func (*XLFD) Props

func (xlfd *XLFD) Props() *orderedmap.OrderedMap[string, any]

func (*XLFD) PtSize

func (xlfd *XLFD) PtSize() int

func (*XLFD) String

func (xlfd *XLFD) String() string

func (*XLFD) ValidateSlant

func (xlfd *XLFD) ValidateSlant() error

func (*XLFD) ValidateSpacing

func (xlfd *XLFD) ValidateSpacing() error