Usage¶

This document covers basic usage of mcfonts. It does not cover more elaborate use-cases.

Loading¶

Saving¶

Add provider¶

font = MinecraftFont(...)
font.append(BitmapProvider(...))
font.insert(2, SpaceProvider(...))
font[1] = UnihexProvider(...)

Remove provider¶

font = MinecraftFont(...)
del font[0]
font.remove(SpaceProvider(...))

Get all characters & glyphs¶

font = MinecraftFont(...)
for provider in font:
    for (character, glyph) in provider.items():
        # character is str
        # glyph is any subclass of Glyph
        ...

Get a glyph¶

font = MinecraftFont(...)
provider = font.get_first_provider_covering("A")
if provider is not None:
    glyph = provider["A"]

Add a glyph¶

provider = BitmapProvider(...)
provider.set_chars(["A"]) # Specific to BitmapProvider
glyph = BitmapGlyph(...)
provider["A"] = glyph

Replace a glyph¶

font = MinecraftFont(...)
provider = font.get_first_provider_covering("A")
if provider is not None:
    provider["A"] = BitmapGlyph(...)

Delete a glyph¶

font = MinecraftFont(...)
provider = font.delete("A")
if provider is not None:
    provider["A"] = BitmapGlyph(...)

Delete characters from providers¶

font = MinecraftFont(...)
font.delete_character_from_providers("A")

Delete providers with character¶

font = MinecraftFont(...)
font.delete_providers_with_character("A")