PHPackages bolk/text-figlet - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. bolk/text-figlet ActiveLibrary[Utility & Helpers](/categories/utility) bolk/text-figlet ================ Render text using FIGlet fonts v2.8.0(3mo ago)031MITPHPPHP >=8.1 Since Mar 19Pushed 3mo agoCompare [ Source](https://github.com/bolknote/Text_Figlet)[ Packagist](https://packagist.org/packages/bolk/text-figlet)[ RSS](/packages/bolk-text-figlet/feed)WikiDiscussions main Synced 3w ago READMEChangelog (7)Dependencies (10)Versions (8)Used By (0) Text\_Figlet ============ [](#text_figlet) PHP implementation of the FIGlet font format for rendering plain text as ASCII art. ``` ,--, ,--.'| ,--, ,--, ,--, | : ,--.'| ,--.'| ,---.'| : ' | | : | | : ,---. | | : _' | : : ' : : ' ' ,'\ : : |.' | ,---. | ' | | ' | / / | | ' ' ; : / \ ' | | ' | | . ; ,. : ' | .'. | / / || | : | | : ' | |: : | | : | '. ' / |' : |__' : |__' | .; : ' : | : ;' ; /|| | '.'| | '.'| : | | | ' ,/ ' | / |; : ; : ;\ \ / ; : ;--' | : || , /| , / `----' | ,/ \ \ / ---`-' ---`-' '---' `----' ``` Installation ------------ [](#installation) ``` composer require bolk/text-figlet ``` Quick start ----------- [](#quick-start) ``` use Bolk\TextFiglet\Figlet; $figlet = new Figlet(); $figlet->loadFont('standard.flf'); echo $figlet->render('Hello!'); ``` Fonts without a path are looked up in the bundled `fonts/` directory. You can also pass a full path: ``` $figlet->loadFont('/path/to/custom.flf'); ``` Layout modes ------------ [](#layout-modes) FIGlet supports three horizontal layout modes. The default comes from the font, but you can override it: ``` use Bolk\TextFiglet\LayoutMode; $figlet->setHorizontalLayout(LayoutMode::Smushing); // characters overlap $figlet->setHorizontalLayout(LayoutMode::Fitting); // characters touch $figlet->setHorizontalLayout(LayoutMode::FullSize); // full width ``` The same applies vertically when rendering multi-line input: ``` $figlet->setVerticalLayout(LayoutMode::Fitting); echo $figlet->render("Hello\nWorld"); ``` Word wrapping ------------- [](#word-wrapping) ``` $figlet->setWidth(80); echo $figlet->render('A very long sentence that will be wrapped'); ``` Justification ------------- [](#justification) ``` use Bolk\TextFiglet\Justification; $figlet->setWidth(80); $figlet->setJustification(Justification::Center); echo $figlet->render('Centered'); ``` `Justification::Auto` (the default) picks left for LTR fonts and right for RTL. Paragraph mode -------------- [](#paragraph-mode) Treats single newlines as spaces (like word processors). Double newlines remain as line breaks: ``` $figlet->setParagraphMode(true); echo $figlet->render("Hello\nWorld"); // rendered as "Hello World" echo $figlet->render("Hello\n\nWorld"); // two separate lines ``` Control files ------------- [](#control-files) FIGlet control files (`.flc`) are mapping tables that preprocess input before rendering. They are used for character remapping, encoding modes, and locale-specific input conversions: ``` $figlet->loadControlFile('utf8.flc'); echo $figlet->render('Hello'); $figlet->clearControlFiles(); ``` Filters ------- [](#filters) Post-processing filters transform the rendered output. Inspired by TOIlet. Filters are applied in order after rendering and can be chained: ``` use Bolk\TextFiglet\Filter; $figlet->addFilter(Filter::Border); echo $figlet->render('Hello'); $figlet->addFilter(Filter::Rainbow); // chained: border + rainbow echo $figlet->render('Hello'); $figlet->clearFilters(); ``` Available filters: FilterDescription`Filter::Crop`Trim blank rows and columns`Filter::Flip`Mirror horizontally`Filter::Flop`Mirror vertically`Filter::Rotate180`Rotate 180 degrees`Filter::RotateLeft`Rotate 90° counterclockwise`Filter::RotateRight`Rotate 90° clockwise`Filter::Border`Surround with a Unicode box border`Filter::Rainbow`Rainbow ANSI color effect`Filter::Metal`Metallic ANSI color effectColor filters (`Rainbow`, `Metal`) output ANSI escape codes for terminal display. Terminal width -------------- [](#terminal-width) Auto-detect the terminal width and use it for word wrapping: ``` $figlet->setWidth(Figlet::terminalWidth()); echo $figlet->render('Adapts to your terminal'); ``` `Figlet::terminalWidth()` checks `COLUMNS`, then TTY width via `ioctl`, then `tput cols`, then `stty size`, and defaults to 80. HTML output ----------- [](#html-output) ``` use Bolk\TextFiglet\ExportFormat; echo $figlet->render('Hi', ExportFormat::Html); // XHTML with echo $figlet->render('Hi', ExportFormat::Html3); // table-based with ``` `Html` produces XHTML with ``, ``, ` ` — supports both foreground and background colors via `style`. `Html3` produces a `` with `` rows — foreground via ``, background via `` — compatible with older HTML renderers and email clients. Color filters (`Rainbow`, `Metal`) are automatically converted from ANSI to the appropriate HTML tags in both modes. Font formats ------------ [](#font-formats) - `.flf` FIGlet fonts - `.tlf` TOIlet fonts (including colored glyphs: 16 / 256 / truecolor) - `.flc` control files Colored TLF fonts ----------------- [](#colored-tlf-fonts) TLF fonts can embed ANSI color escape sequences. The library supports: - **16 colors** — standard SGR codes (30-37, 40-47, 90-97, 100-107) - **256 colors** — compact codes `256..511` (`256 + N`), channel selected by SGR context, or legacy `38;5;N` / `48;5;N` sequences (our extension, not part of the original TOIlet format) - **truecolor** — compact codes `512..16777727` (`512 + bgr24`), channel selected by SGR context, decoded to 24-bit RGB inside Text\_Figlet When parsing glyph lines, verbose `38;5;N` / `48;5;N` (256-color) and `38;2;R;G;B` / `48;2;R;G;B` (truecolor) are accepted as well as the compact numeric codes above. Details: `tools/TLF_COLOR_EXTENSIONS.md`. For colored fonts the library chooses the best output tier at runtime (first match wins): - `COLORTERM=truecolor` or `COLORTERM=24bit` → emit `38;2;R;G;B` / `48;2;R;G;B` - `TERM_FEATURES` → truecolor when [iTerm2-style feature reporting](https://www.iterm2.com/feature-reporting) advertises 24-bit color (non-zero low bits in the `T` level bitmap) - `TERM` contains `256color` → emit `38;5;N` / `48;5;N` - otherwise → fall back to base-16 ANSI colors The compact 256-color and truecolor ranges are Text\_Figlet extensions. `toilet`continues to use only the 16-color subset and ignores the higher numeric codes. Standard TOIlet fonts are loaded as-is. ### Emoji font example [](#emoji-font-example) ``` $figlet = new Figlet(); $figlet->loadFont('emoji'); // emoji.tlf — 16/256-color // $figlet->loadFont('emoji-truecolor'); // truecolor variant (24-bit terminals) echo $figlet->render("\u{2764}\u{1F525}\u{2B50}"); // ❤ 🔥 ⭐ ``` ### Resetting color detection mid-process [](#resetting-color-detection-mid-process) The terminal tier is cached after the first call. If you change `TERM`, `COLORTERM`, or `TERM_FEATURES` inside a long-running process (e.g. in tests), call: ``` use Bolk\TextFiglet\AnsiColor; AnsiColor::resetCaches(); ``` Bundled fonts ------------- [](#bundled-fonts) The bundle includes 318 fonts: - Classic FIGlet fonts and redistributable community fonts - TOIlet `.tlf` fonts including `emboss`, `emboss2`, `circle`, `future`, `letter`, `pagga`, `smblock`, `smbraille`, `wideterm` - `emoji` / `emoji-truecolor` — color emoji TLF fonts (large Unicode emoji coverage, built with `tools/build_emoji_font.py`; `emoji-truecolor` adds a truecolor layer for 24-bit terminals) - JavE fonts with explicit modification/redistribution permission in their headers - One bundled CJK font: `gb16fs` (GB2312) See `fonts/THIRD_PARTY.md` for the complete asset list and licensing notes. Bundled control files: `utf8.flc`, `hz.flc`, `frango.flc`, `jis0201.flc`. Compressed fonts and control files ---------------------------------- [](#compressed-fonts-and-control-files) Gzip is detected by the `\x1f\x8b` magic bytes for both fonts and `.flc` control files, not only by a `.gz` suffix (requires `ext-zlib`). Short font names without an extension are still resolved with `.flf.gz` / `.tlf.gz` in addition to `.flf` / `.tlf`. ZIP archives are detected by the `PK` signature (requires `ext-zip`). If the archive has several members, a file named like the archive basename (`archive.flf`, `archive.tlf`, or `archive.flc`) is preferred; otherwise the first non-directory entry is used (FIGlet itself, via [zipio.c](https://github.com/cmatsuoka/figlet/blob/master/zipio.c), only reads that first local file record—no name-based lookup). TOIlet loads fonts through libcaca (`caca_canvas_set_figfont`); ZIP handling, if any, lives there—not in TOIlet’s own `src/`. FIGlet standard compliance -------------------------- [](#figlet-standard-compliance) Implements the FIGfont Version 2 specification: - All 6 horizontal smushing rules including rule 6 (hardblank smushing) - Universal smushing (overlapping) - Full\_Layout header parameter (horizontal + vertical modes and rules) - Vertical fitting and smushing (5 vertical rules) - RTL and LTR print direction - Default character (code 0) fallback - German character set (7 required Deutsch characters) - Code-tagged characters (decimal, hex, octal) - Control files with `t`/`f` commands, range mappings, encoding modes (UTF-8, HZ, Shift-JIS, DBCS), ISO 2022 - TOIlet `.tlf` fonts with 16 / 256 / truecolor ANSI support (Text\_Figlet extensions for compact palette and RGB) - Color-aware smushing (color follows the winning character) Static analysis --------------- [](#static-analysis) Run all analyzers: ``` composer analyze ``` ### Health Score 39 — LowBetter than 85% of packages Maintenance82 Actively maintained with recent releases Popularity10 Limited adoption so far Community6 Small or concentrated contributor base Maturity47 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~0 days Total 7 Last Release 97d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/51ab50857dbdd3cffeda1e055a070f4d31d096073f16d5da9338c5c1fc22e598?d=identicon)[bolknote](/maintainers/bolknote) --- Top Contributors [![bolknote](https://avatars.githubusercontent.com/u/392509?v=4)](https://github.com/bolknote "bolknote (18 commits)") --- Tags figletfiglet-fontsfiglet-toilet ### Code Quality TestsPHPUnit Static AnalysisPHPStan, Psalm, Rector Type Coverage Yes ### Embed Badge ![Health badge](/badges/bolk-text-figlet/health.svg) ``` [![Health](https://phpackages.com/badges/bolk-text-figlet/health.svg)](https://phpackages.com/packages/bolk-text-figlet) ``` PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)