User Install Instructions

Overview

These instructions are for people who want to use Fontknife to do things like:

• converting assets for a specific Python-based project

• as dependency for one of your projects

• trying it without installing it for your entire user account

See Contributor Install Instructions if you’d like to contribute bug fixes or new features.

Requirements

First, make sure you have Python 3.8+ installed:

1. Open your favorite terminal application.

2. Try running python. If it says the command was not found, try the following:

   1. python3

   2. python3.8 or later minor version numbers

3. At least one of them should show something like the output below:

   Python 3.9.2 (default, Feb 28 2021, 17:03:44)
   [GCC 10.2.1 20210110] on linux
   Type "help", "copyright", "credits" or "license" for more information.
   >>>
   

4. If it doesn’t, the see Installing Python section below.

5. Otherwise, type exit(), press enter, and skip to User Install Steps.

Installing Python

Platform	Most reliable way to install Python
Windows	From Python’s official Windows downloads page
macOS	From Python’s official macOS downloads page
Linux	Your distro’s package manager: Pop!_OS sudo apt-get install python3 or via the Pop Shop Ubuntu sudo apt-get install python3 Fedora See Fedora’s Python guide

User Install Steps

1. Create a virtual environment if you haven’t

2. Make sure it’s activated

3. pip install fontknife to install the latest version

4. fontknife convert --help to make sure it runs.

Testing Your Install

If you want to make sure your install is working, use the following steps:

1. Download the Tom Thumb BDF font from the bottom of this page.

2. Run fontknife convert -p tom-thumb.bdf sheet.png

3. The resulting file should be identical to the one below:

   

   It’s tiny (64 x 72 px) because the input data is a 3 x 5 pixel font.