https://github.com/judy2k/bmtext

Python rendering of text using BMFont bitmap font files.
https://github.com/judy2k/bmtext

bitmap font pil pillow python

Last synced: 6 months ago
JSON representation

Python rendering of text using BMFont bitmap font files.

• Host: GitHub
• URL: https://github.com/judy2k/bmtext
• Owner: judy2k
• Created: 2020-06-21T13:12:08.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-06-21T22:43:38.000Z (over 5 years ago)
• Last Synced: 2025-04-06T19:43:26.846Z (6 months ago)
• Topics: bitmap, font, pil, pillow, python
• Language: Python
• Homepage:
• Size: 53.7 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# BMText

Render text with [BMFont](https://www.angelcode.com/products/bmfont/) generated bitmap fonts.

**Status**: The core of this code is reasonably well tested, but it's at an early stage, it's basically just been thrown up online, and you use it at your own risk.

## Why???

I wanted kerning, and I wanted support for a widespread bitmap font format. BMFont is used to generate bitmap fonts from Truetype fonts, and the format it uses seems reasonably well supported.

I have vague plans to extend the format slightly to allow pre-rendered glyphs - so characters could

be multi-colored or embossed, for example.

## Using it

Install it with:

```bash

python -m pip install bmtext

```

Currently the API matches ImageDraw.text as closely as possible (given the limited feature-set).

```python

from PIL import Image

from bmtext.meta import parse_file

from bmtext.pil import BMText

im = Image.new('RGB', (320, 180), color=(160, 160, 255))

drawer = BMText(im)

font = parse_file("tests/fixtures/raleway-30/raleway-thin-32.fnt")

# FIXME: Overlapping glyphs remove part of previous char.

drawer.text((5, 5), "Antidisestablishmentarianism\nThorough\nSHOUTING!!!\nTomato?", font, fill='blue')

im.show()

```

![Sample of rendered text](https://github.com/judy2k/bmtext/blob/master/assets/rendered_text.png)

## To Do

* FNT Compatibility:

    * Handle binary font metadata formats.

    * Test with multiple pages

    * Multiple channel support

    * Outline support (2-pass rendering)

* Improve error handling:

    * Malformed fnt files

    * Missing characters from font (replace/error)

* Features:

    * Allow arrangement of pre-rendered characters (rather than single-color alpha characters).

    * Implement textsize

    * Implement alignment

    * Implement anchor

* More testing:

    * Test with older versions of pillow

* Port to Python 3.5+ (remove the walrus operator)

## Developing

Run the following to install the project (and dev dependencies) into your active virtualenv:

```bash

pip install -e .[dev]

```