Data-driven raster fonts for pixel art games.

Install

cargo add raster_font

Quick Start

Author a font in TOML:

name   = "Example Font"

image  = "font.png"

layout = "abc$(->|=>)"



[pack]

size   = [8, 8]

region = { min = [0, 0], max = [8, 8] }

Load it in Bevy using the bevy feature:

use bevy::prelude::*;
use raster_font::prelude::*;

fn main() {
    App::new()
        .add_plugins((DefaultPlugins, RasterFontAssetLoaderPlugin))
        .add_systems(Startup, load_font)
        .run();
}

fn load_font(asset_server: Res<AssetServer>) {
    let _font: Handle<RasterFont> = asset_server.load("font.toml");
}

Resolve input text into glyphs at runtime:

use raster_font::{backend::prelude::*, tree::InputResolver};

fn draw<B: Backend<Resources: SpriteSheet>>(font: &RasterFont<B>) {
    for glyph in font.valid("Hello -> world :)") {
        // Draw glyph
    }
}

Matching is leftmost-longest, so sequences like -> naturally take precedence over their prefixes.

Feature Flags

Backend Examples

• bevy_asset: Demonstrates using the 1st-party BevyBackend to load RasterFont assets in the Bevy game engine.
• macroquad: Minimal backend example for Macroquad

Docs

Full usage including custom backends, layout syntax, and advanced glyph extraction are exhaustively documented at docs.rs/raster_font.

Roadmap

• BIDI: Allow unicode to support bidirectional text layout. (right-to-left scripts, and mixing of left-to-right and right-to-left text)
• Contextual glyph substitution: e.g. when S is followed by T, allow substitution of S instead of ST to enable kerning and ligatures without needing to define separate sequences and glyphs for every combination of characters.
• More backends: Raster Font only has one 1st-party backend (bevy), but the API is designed to be backend-agnostic, as long as they have some concept of an image.