mcfonts documentation

mcfonts is a versatile, fast, and extensible package for working with Minecraft JSON fonts.

mcfonts works with any font JSON and can export every kind of texture and sizing, no matter the format.

It can be used anywhere in places that deal with Minecraft fonts.

To get started, see Installation.

Warning

mcfonts is in beta. API may change at any time, read the changelog carefully.

Contents

Getting started

• System Requirements
  • Operating System
  • Recommendations
  • Python
• Installation
  • From PyPI
  • From source
• Importing
  • My font has no colors!

Usage

• Command Line
• Compacting
  • Compacting to charlist
  • Compacting to fixed
  • Compacting to square
• Coverage Reports
• Exporting
  • Export Filter
  • Export only providers with options
  • Export providers without options
  • Export and ignore options
  • Export only providers of one type
  • Export only some characters
  • Export without some characters
  • Speed
  • Large file size

Common Operations

• Generate a charlist
  • From Unicode range
• Combine fonts
• Control program behavior
  • Turn on/off colored output
• Make an image of every glyph in a font

Miscellaneous

• Glossary
• Extensions
  • The "options" provider
  • Rangestrings in "spaces" provider
  • Comments

Providers

• Bitmap Provider
  • Structure
  • Height
  • Ascent
  • Charlist
    • Warped charlist
• Space Provider
  • Structure
  • Advances
  • To glyph sizes
• TTF Provider
  • Structure
  • Shift
  • Size
  • Oversample
  • Skip
• Legacy Unicode Provider
  • Structure
  • Sizes
  • Template
    • Surrogates
  • To advances
• Options Provider
  • Structure
  • Width
  • Spacing
  • Fullwidth
  • Shift

Reference

• mcfonts
  • Submodules
    • mcfonts.compacting
      • Module Contents
    • mcfonts.constants
      • Module Contents
    • mcfonts.coverage_reports
      • Module Contents
    • mcfonts.exceptions
      • Module Contents
    • mcfonts.filters
      • Module Contents
    • mcfonts.glyphs
      • Module Contents
  • Package Contents
    • Classes
    • Functions
      • MinecraftFont
      • from_java_ambiguous()
      • from_java_font_contents()
      • from_java_font_file()
      • from_java_pack_folder()
      • from_java_pack_zip()
      • from_java_resource_template()

Indices and tables

• Index

• Search Page