About

VFIT (Variable Font Instancing Tool) allows you to generate custom, static instances of a variable font defined in a configuration file.

Installation

VFIT is now available on the Python Package Index. You can install VFIT with the following command:

$ pip3 install vfit

Alternatively, you can install VFIT by downloading a pre-built wheel from the Releases section or by building it yourself.

# Skip this step if you're downloading a prebuilt wheel.
$ git clone https://github.com/jonpalmisc/vfit.git && cd vfit
$ poetry build && cd dist

# Install VFIT from the wheel.
$ pip install vfit-version-py3-none-any.whl

Usage

To begin, you will need a variable font file to work with. Your first step will be creating a configuration file. See sample.json for an example.

Next, run VFIT and pass your configuration and variable font file as arguments:

$ vfit config.json variable.ttf

If you would like to generate instances into a specific directory, you can use the -o option. For more options, see vfit --help.

Contributing

All contributions are welcome. If you find a bug or have a request for a feature, feel free to create a new issue (or even better, a pull request).

If you are submitting a pull request, please format your code with yapf using the default settings. Additionally, I am aware that camelCase naming is against the convention for Python, but it is the convention used by fonttools, so I have chosen to use it here as well for consistency.

Credits

Special thanks to Viktor Rubenko, who knows way more about font technology than I do and has been incredibly helpful in fixing strange bugs.

The VFIT logo uses NewGlyph's Armada variable font.

License

Copyright © 2020 Jon Palmisciano

VFIT is available under the MIT License. See LICENSE.txt for more information.