spf

Crates.iospf
lib.rsspf
version0.7.0-beta.0
created_at2024-10-26 02:03:32.922912+00
updated_at2025-09-02 15:25:56.243092+00
description.spf (Simple Pixel Font) file parser
homepage
repositoryhttps://github.com/SimplePixelFont/spf.rs
max_upload_size
id1423486
size155,624
(The-Nice-One)

documentation

README

SimplePixelFont - spf.rs stars - spf.rs forks - spf.rs Rust GitHub tag License issues - spf.rs Codecov Documentationcov

Parser library for the SimplePixelFont file specifications, written in Rust. spf.rs is both a native crate and also an FFI library which can be used in a variety of other programming languages which support library loading.

Installation

  • To install spf.rs as a rust crate run the following command in your cargo project or read more:
cargo add spf
  • To use spf.rs as an FFI library in your language of choice you must first download a pre-built library artifact of spf.rs from the releases section which includes the dynamic library along with a header file. Pre-built artifacts are available for many architectures, however if there is no build for your architecture-including embedded devices-you can compile spf.rs from source.

Usage

Note: spf.rs documentation is currently out of date, however actively being updated to reflect the SimplePixelFont new standardized specification.

Usage varies depending on the programming language you choose. For a guide using the native Rust interface check out the Getting Started in Rust article. You can also check out the Using the FFI in C article for usage with the spf.rs library.

Supported SPF Tables

spf.rs is the official parser for the SimplePixelFont file specifications, and will always attempt to parallel developments within the specifictaitons. The following tables are supported:

| Type | Stability | Notes | | --- | --- | --- | --- | | Character Table | ✔ | Added in v0.7.0-alpha.0 | | Pixmap Table | ✔ | Added in v0.7.0-alpha.0 | | Color Table | ✔ | Added in v0.7.0-alpha.0 |

Key:

  • ⚠️ = Work in progress
  • = Not implemented
  • = Stable
Commit count: 212

cargo fmt