b-g / scfbuild

Create SVG in OpenType color fonts from a set of SVG source files.

SVGinOT Color Font Builder

Create color fonts from SVGs on the command line

scfbuild creates SVG in OpenType color fonts directly from a set of source SVG files greatly simplifying the process of creating a custom color font.

Regular color and standard character glyphs are named by Unicode code point (e.g. 1f60e.svg). Ligatures are named by code points separated by a hyphen - (e.g.1f441-1f5e8.svg). Note: Color glyphs cannot exist alone, they must replace existing standard glyphs.

The generated fonts work in all operating systems, but will currently only show color glyphs in Mozilla Firefox and Thunderbird. This is not a limitation of the generated fonts, but of the operating systems and applications. Only the SVG in OpenType color font format is supported. The Apple, Google, and Microsoft color font formats are not supported.

Examples

• EmojiOne Color - SCFBuild was created to make this color emoji font using EmojiOne graphics.
• Twitter Color Emoji - Color emoji font using Twitter Emoji for Everyone graphics.
• Reinebow - A colorful alphanumeric font. [source]

What is SVGinOT?

SVG in Open Type is a standard by Adobe and Mozilla for color OpenType and Open Font Format fonts. It allows font creators to embed complete SVG files within a font enabling full color and even animations. There are more details in the SVGinOT proposal and the OpenType SVG table specifications.

SVGinOT Demos (Firefox only):

• https://www.adobe.com/devnet-apps/type/svgopentype.html
• https://hacks.mozilla.org/2014/10/svg-colors-in-opentype-fonts/

Usage - Linux

Required Python libraries:

• FontTools 2.5+
• FontForge
• lxml

Run: bin/scfbuild

$ bin/scfbuild --help
usage: scfbuild [-h] [-o OUTPUT] [-g DIR] [-s DIR] [--transform TRANSFORM]
                [--font-family FAMILY] [--font-subfamily SUBFAMILY]
                [--font-version FONT_VERSION] [-c YAML_CONF] [-v] [-V]

SCFBuild - SVGinOT Color Font Builder 1.x.x

optional arguments:
  -h, --help            show this help message and exit
  -o OUTPUT, --output OUTPUT
                        output font file
  -g DIR, --glyph-svg-dir DIR
                        directory of regular no-color SVG glyphs to add to the
                        font
  -s DIR, --color-svg-dir DIR
                        directory of SVGinOT color SVG glyphs to add to the
                        font.
  --glyph-only					generate font with no-color SVG glyphs only 
  --transform TRANSFORM
                        add a transform to the <svg> tag of each color SVG.
                        Example "translate(0 -1638) scale(2.048)"
  --font-family FAMILY  family name for the font. default: Untitled
  --font-subfamily SUBFAMILY
                        weight/style for the font. default: Regular
  --font-version FONT_VERSION
                        version number for the font. default: 1.0
  -c YAML_CONF, --yaml-conf YAML_CONF
                        yaml build configuration, overridden by command line
                        options.
  -v, --verbose         print detailed debug information
  -V, --version         print version information

Docker

If you don't want to install the required Python libraries from above locally on your machine, then you can use the provided Docker container, which bundles nicely all requirements.

1. Install Docker

2. Either A) build the container on your onw: docker build -t scfbuild . or B) pull the latest published container: docker pull ghcr.io/b-g/scfbuild/scfbuild:latest

3. Run and share folder with container:

$ cd path/to/repo/scfbuild
$ docker run --interactive --tty --rm --volume $PWD:/wd --workdir /wd scfbuild:latest bash
# now you can use bin/scfbuild via the docker container
$ bin/scfbuild --help

Other Tools

scfbuild softens the learning curve for font creation, but cannot replace more advanced tools. Here are some starting points if you need more features, although none support color fonts at this time:

• http://fontforge.github.io/en-US/
• https://github.com/adobe-type-tools/afdko
• https://birdfont.org/

License

SCFBuild is released under the GNU General Public License v3. See LICENSE.txt in the project root directory.