Installation

Ships with ESM + CJS bundles and full TypeScript declarations. Works with any bundler — Vite, webpack, Rollup, esbuild, etc.

npm

npm install asciify-engine

yarn

yarn add asciify-engine

pnpm

pnpm add asciify-engine

Note

Runs in browser environments only — requires the Canvas API. For GIF processing, gifuct-js is bundled internally — no extra install needed.

CDN — no bundler

Import directly from a CDN for quick prototyping with no build step.

index.html

<script type="module">
  import { asciify } from 'https://esm.sh/asciify-engine';
  await asciify('photo.jpg', document.querySelector('canvas'));
</script>