Skip to content
Back to search

asciify-engine

ASCII for the web: 31 GPU-drawn interface components, backgrounds, and image, GIF and video conversion.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/ayangabryl--asciify-engine/badge.svg)](/listings/ayangabryl--asciify-engine)

HTML

<a href="/listings/ayangabryl--asciify-engine"><img src="/api/listings/ayangabryl--asciify-engine/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

npm i asciify-engine

Building with a coding agent? Add the skill, then describe what you want:

npx skills add ayangabryl/asciify-engine

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 133 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. <p align="center">
  2. <a href="https://asciify.org">
  3. <picture>
  4. <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ayangabryl/asciify-engine/main/.github/assets/logo-dark.png">
  5. <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/ayangabryl/asciify-engine/main/.github/assets/logo-light.png">
  6. <img alt="Asciify" src="https://raw.githubusercontent.com/ayangabryl/asciify-engine/main/.github/assets/logo-light.png" width="220">
  7. </picture>
  8. </a>
  9. </p>
  10. <p align="center">ASCII components, backgrounds and media for the web, drawn in real characters on the GPU.</p>
  11. <p align="center">
  12. <a href="https://www.npmjs.com/package/asciify-engine"><img alt="npm version" src="https://img.shields.io/npm/v/asciify-engine?style=flat-square&labelColor=171716&color=3d3d3a"></a>
  13. <a href="https://bundlejs.com/?q=asciify-engine"><img alt="Bundle size" src="https://img.shields.io/bundlejs/size/asciify-engine?style=flat-square&labelColor=171716&color=3d3d3a&label=gzip"></a>
  14. <a href="https://www.npmjs.com/package/asciify-engine"><img alt="Downloads" src="https://img.shields.io/npm/dm/asciify-engine?style=flat-square&labelColor=171716&color=3d3d3a"></a>
  15. <a href="https://github.com/ayangabryl/asciify-engine/blob/main/LICENSE"><img alt="MIT license" src="https://img.shields.io/npm/l/asciify-engine?style=flat-square&labelColor=171716&color=3d3d3a"></a>
  16. </p>
  17. <p align="center">
  18. <a href="https://asciify.org">Website</a> ·
  19. <a href="https://asciify.org/docs">Docs</a> ·
  20. <a href="https://asciify.org/components">Components</a> ·
  21. <a href="https://asciify.org/editor">Studio</a>
  22. </p>
  23. <p align="center">
  24. <a href="https://asciify.org">
  25. <picture>
  26. <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ayangabryl/asciify-engine/main/.github/assets/hero-dark.webp">
  27. <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/ayangabryl/asciify-engine/main/.github/assets/hero-light.webp">
  28. <img alt="The asciify.org home page: an ASCII field behind the headline and three live kit components" src="https://raw.githubusercontent.com/ayangabryl/asciify-engine/main/.github/assets/hero-light.webp" width="100%">
  29. </picture>
  30. </a>
  31. </p>
  32. Asciify is a framework-agnostic engine for ASCII on the web. Use it for interface components (loading buttons, toasts, tabs, AI states, charts, page transitions), for backgrounds behind your content, and for turning images, GIFs, video and text into characters. Components take their ink from your CSS tokens in light and dark, follow their element's size and radius, honour reduced motion and pause off screen.
  33. ## Install
  34. ```bash
  35. npm i asciify-engine
  36. ```
  37. Or try it in a terminal, with nothing installed:
  38. ```bash
  39. npx asciify-engine photo.jpg
  40. npx asciify-engine torus
  41. ```
  42. <p align="center"><img src=".github/assets/cli-knot.svg" width="448" alt="A torus knot turning, drawn in characters: the animated SVG that npx asciify-engine knot --spin -o knot.svg writes"></p>
  43. Building with a coding agent? Add the skill, then describe what you want:
  44. ```bash
  45. npx skills add ayangabryl/asciify-engine
  46. ```
  47. ## Quick start
  48. ```ts
  49. import { buttonLoading } from 'asciify-engine/kit';
  50. import { asciify } from 'asciify-engine';
  51. const save = buttonLoading(document.querySelector('#save')!);
  52. save.start('Saving');
  53. await saveDraft();
  54. save.succeed('Saved');
  55. const stop = await asciify('/photo.jpg', document.querySelector('canvas')!, {
  56. fontSize: 8,
  57. options: { colorMode: 'fullcolor' },
  58. });
  59. // On unmount: save.destroy(); stop();
  60. ```
  61. ## Features
  62. - **Kit** (`/kit`): interface components and the curated asciify.org backgrounds, one call each.
  63. - **Media** (`asciify-engine`, `/core`): images, GIFs, video, webcam and text to ASCII on a canvas, with scroll-scrubbed video, chroma key and source crop.
  64. - **GPU fields** (`/field`): full-bleed WebGL2 character fields with trail, fluid and lantern cursor responses, in any font and charset. Heroes and video can draw **in a worker** (`worker: true`), leaving the page's main thread free. Or drop in **`<asciify-field>`** (`defineAsciifyField()`), one element for React, Vue, Svelte, Astro or plain HTML. Bring your own design with **custom effects** (a few lines of GLSL for your own hovers, reveals and motion, tweenable with GSAP or Motion), and draw **live 3D**: a three.js or React Three Fiber canvas becomes characters every frame.
  65. - **Headless** (`/headless`): pixels to text with no DOM, in Node, workers and edge runtimes, for OG images, emails, CLIs and READMEs. Shape-aware: edges become `/ \ | _ ( )`, not just denser dots. Text, ANSI colour, SVG and HTML output, **animated SVG** that plays in a README with no script, and **braille, half-block, quadrant and sextant** art in two colours a cell for terminals. In the browser, `createAsciiGpu()` converts live video on the GPU, in a worker of its own, for about 0.5 ms of main thread a 1080p frame in every mode.
  66. - **3D models** (`/model`): glTF/GLB, OBJ, STL and PLY as ASCII, drawn on the CPU in any runtime or on the GPU as a live field source that turns and follows the pointer.
  67. - **Command line**: `npx asciify-engine photo.jpg`. Pictures, GIFs, video (through ffmpeg) and 3D models in your terminal, or as SVG, HTML, text and JSON, or a PNG, GIF or MP4 to post anywhere; turn a model with the mouse; many files in one run. Images decode with no dependencies (`/decode`), in Node and at the edge. Agents with the skill asciify whatever you attach.
  68. - **Hover and motion** (`/hover`): pointer effects and still-image motions for media on your page.
  69. - **Studio** (`/studio`): render styles, tonal curves, source warps, layered projects and PNG, JPEG, GIF, MP4 and WebM export.
  70. - **Agent skill**: the house design, every component's prompt and snippet, and the full API, for Claude Code, Cursor, Codex and other agents.
  71. - **Built for host pages**: no work at import, safe under SSR, tree-shaken per component, TypeScript types, ESM and CommonJS.
  72. ## How it compares
  73. Measured against the ASCII generators people use (ascii-magic.com and devault-ascii.pages.dev), aalib.js, ascii.rest (the Cloudflare-sponsored ASCII library), three.js `AsciiEffect`, the postprocessing `ASCIIEffect`, @sister.software/asciify and a naive ramp, on the same pictures and grid, with photos the engine was not tuned on: ahead of every renderer tested on photographs, line art and type, close up and at a distance (better than aalib on both measures on 16 of 20 photos), and several times faster than aalib. On the GPU, a glyph field with `FIELD_PHOTO_CHARSET` and `sample: 'shape'` is ahead of the studio WebGL heroes measured (2025.unseen.co's ASCII pass and webgl-ascii-hero) on photos, line art and type, close up and at a distance, and a playing source never makes it wait on the GPU. Method, numbers and the weak spots are in the [benchmark report](docs/benchmarks/2026-11-04-ascii-renderers.md).
  74. ## Stability
  75. How things look is part of the API: patch releases never change rendered output, and CI compares every kit component, preset and field mark with stored screenshots. See [STABILITY.md](STABILITY.md) for versioning, deprecation and the runtime promises, and [SECURITY.md](SECURITY.md) to report a vulnerability.
  76. ## Docs
  77. Everything else lives at **[asciify.org/docs](https://asciify.org/docs)**: the API reference, options, framework guides, chroma key, layering, Studio and GPU fields. The agent skill's [references](skills/asciify-engine/references) cover the same ground for agents.
  78. ## Performance
  79. Each optional entry loads only when imported, and a route that uses one kit component downloads that component, not the whole kit. What the engine promises a host page, and how it is measured, is in [performance.md](skills/asciify-engine/references/performance.md).
  80. ## Contributing
  81. Issues and pull requests are welcome. To work on the engine:
  82. ```bash
  83. npm ci
  84. npm test
  85. npm run build
  86. ```
  87. `npm run test:visual` checks the visual baselines and `npm run test:browser` serves the browser regression page; see [CONTRIBUTING.md](CONTRIBUTING.md). Changes are listed in [CHANGELOG.md](CHANGELOG.md).
  88. ## Sponsors
  89. <!-- sponsors:start -->
  90. <p align="center"><a href="https://asciify.org/sponsor"><picture><source media="(prefers-color-scheme: dark)" srcset="https://cdn.asciify.org/sponsors-dark.svg"><img src="https://cdn.asciify.org/sponsors.svg" alt="Asciify sponsors" width="720"></picture></a></p>
  91. <p align="center"><sub>Backers: <a href="https://releasetime.io/">ReleaseTime</a></sub></p>
  92. Asciify is free and open source. [Become a sponsor](https://asciify.org/sponsor).
  93. <!-- sponsors:end -->
  94. ## License
  95. [MIT](LICENSE) © ayangabryl

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.