asciify-engine 1.0.28 → 1.0.30

package/README.md

@@ -1,20 +1,26 @@
 # asciify-engine
 
-Framework-agnostic ASCII art engine. Convert images, videos, and GIFs into ASCII art rendered on HTML canvas — plus 10 animated ASCII background effects.
+<p align="left">
+  <a href="https://www.npmjs.com/package/asciify-engine"><img src="https://img.shields.io/npm/v/asciify-engine?color=d4ff00&labelColor=0a0a0a&style=flat-square" alt="npm version" /></a>
+  <a href="https://www.npmjs.com/package/asciify-engine"><img src="https://img.shields.io/npm/dm/asciify-engine?color=d4ff00&labelColor=0a0a0a&style=flat-square" alt="downloads" /></a>
+  <a href="https://github.com/ayangabryl/asciify/blob/main/packages/asciify-engine/LICENSE"><img src="https://img.shields.io/badge/license-MIT-d4ff00?labelColor=0a0a0a&style=flat-square" alt="MIT license" /></a>
+  <a href="https://www.buymeacoffee.com/asciify"><img src="https://img.shields.io/badge/buy_me_a_coffee-support-d4ff00?labelColor=0a0a0a&style=flat-square" alt="Buy Me A Coffee" /></a>
+</p>
+
+> Convert images, videos, and GIFs into ASCII art on HTML canvas. 13 art styles, 4 color modes, 10 animated backgrounds, interactive hover effects — zero dependencies.
+
+**[▶ Live Playground](https://asciify.org) · [npm](https://www.npmjs.com/package/asciify-engine) · [Support the project ☕](https://www.buymeacoffee.com/asciify)**
 
 ## Features
 
-- **Image → ASCII** — single-frame conversion
-- **Video → ASCII** — extract frames from `<video>` elements
-- **GIF → ASCII** — parse and convert animated GIFs
-- **Canvas rendering** — render ASCII frames to any `<canvas>`
-- **6 art styles** — Classic, Particles, Letters, Box Drawing, Dense Art, Terminal
-- **Color modes** — Grayscale, Full Color, Matrix, Accent
-- **Hover effects** — Spotlight, Magnify, Repel, Glow, Color Shift
+- **Media → ASCII** — images, videos, and animated GIFs
+- **13 art styles** — Standard, Blocks, Circles, Braille, Katakana, Dense, and more
+- **4 color modes** — Grayscale, Full Color, Matrix, Accent
 - **10 animated backgrounds** — Wave, Rain, Stars, Pulse, Noise, Grid, Aurora, Silk, Void, Morph
-- **Light & dark mode** — all backgrounds adapt via `lightMode` option or `colorScheme: 'auto'`
-- **Embed code generation** — self-contained HTML output
-- **Zero framework dependencies** — works with React, Angular, Vue, Svelte, vanilla JS
+- **Interactive hover effects** — Spotlight, Flashlight, Magnifier, Force Field, Neon, Fire, Ice, Gravity, Shatter, Ghost
+- **Light & dark mode** — via `colorScheme: 'auto'` or explicit `light` / `dark`
+- **Embed generation** — self-contained HTML output (static or animated)
+- **Zero dependencies** — works with React, Vue, Angular, Svelte, Next.js, or vanilla JS
 
 ## Install
 
@@ -236,43 +242,52 @@ setInterval(() => {
 }, 1000 / fps);
 ```
 
-## API
+## API Reference
 
 ### Core Functions
 
-| Function | Description |
-|---|---|
-| `imageToAsciiFrame(source, options, targetWidth?, targetHeight?)` | Convert an image/video/canvas to a single ASCII frame; returns `{ frame, cols, rows }` |
-| `renderFrameToCanvas(ctx, frame, options, width, height, time?, hoverPos?)` | Render an ASCII frame onto a canvas context |
-| `gifToAsciiFrames(buffer, options, targetWidth, targetHeight, onProgress?)` | Convert a GIF `ArrayBuffer` to animated frames; returns `{ frames, cols, rows, fps }` |
-| `videoToAsciiFrames(video, options, targetWidth, targetHeight, fps?, maxDuration?, onProgress?)` | Convert a `<video>` to animated frames; returns `{ frames, cols, rows, fps }` |
-| `generateEmbedCode(frame, options)` | Generate self-contained HTML embed string |
-| `generateAnimatedEmbedCode(frames, options, fps)` | Generate animated HTML embed string |
-| `asciiBackground(selector, options)` | Mount an animated ASCII background on an element; returns a cleanup function |
-
-### Art Styles
-
-| Style | Charset | Color Mode |
+| Function | Returns | Description |
 |---|---|---|
-| `classic` | ` .:-=+*#%@` | Grayscale |
-| `particles` | Dots mode | Full Color |
-| `letters` | A-Z a-z | Full Color |
-| `claudeCode` | Box drawing `╔╗╚╝║═...` | Accent |
-| `art` | Dense 70-char set | Full Color |
-| `terminal` | ` .:-=+*#%@` | Matrix green |
+| `imageToAsciiFrame(source, options, w?, h?)` | `{ frame, cols, rows }` | Convert an image, video frame, or canvas to ASCII |
+| `renderFrameToCanvas(ctx, frame, options, w, h, time?, hoverPos?)` | `void` | Render an ASCII frame to a 2D canvas context |
+| `gifToAsciiFrames(buffer, options, w, h, onProgress?)` | `{ frames, cols, rows, fps }` | Parse an animated GIF `ArrayBuffer` into ASCII frames |
+| `videoToAsciiFrames(video, options, w, h, fps?, maxDuration?, onProgress?)` | `{ frames, cols, rows, fps }` | Extract and convert video frames to ASCII |
+| `asciiBackground(selector, options)` | `() => void` | Mount a live animated ASCII background; returns a cleanup function |
+| `generateEmbedCode(frame, options)` | `string` | Self-contained static HTML embed |
+| `generateAnimatedEmbedCode(frames, options, fps)` | `string` | Self-contained animated HTML embed |
 
-### Options
+### Key Options (`AsciiOptions`)
 
-See `AsciiOptions` type for full configuration. Key options:
+| Option | Type | Default | Description |
+|---|---|---|---|
+| `fontSize` | `number` | `10` | Character cell size in px |
+| `colorMode` | `'grayscale' \| 'fullcolor' \| 'matrix' \| 'accent'` | `'grayscale'` | Color output mode |
+| `renderMode` | `'ascii' \| 'dots'` | `'ascii'` | Render as characters or dot particles |
+| `charset` | `string` | standard ramp | Custom character density ramp |
+| `brightness` | `number` | `0` | Brightness adjustment (-1 → 1) |
+| `contrast` | `number` | `1` | Contrast multiplier |
+| `invert` | `boolean` | `false` | Invert luminance mapping |
+| `hoverEffect` | `string` | `'none'` | Interactive effect name |
+| `hoverStrength` | `number` | `0.8` | Effect intensity |
+| `hoverRadius` | `number` | `0.3` | Effect radius (0–1 relative to canvas) |
+
+### Background Options
 
-- `fontSize` — character size in pixels (default: 10)
-- `colorMode` — `'grayscale' | 'fullcolor' | 'matrix' | 'accent'`
-- `renderMode` — `'ascii' | 'dots'`
-- `charset` — character ramp string
-- `brightness` / `contrast` — image adjustments
-- `invert` — invert luminance mapping
-- `hoverEffect` / `hoverStrength` / `hoverRadius` — interactive hover
+| Option | Type | Default | Description |
+|---|---|---|---|
+| `type` | `string` | `'wave'` | Background renderer |
+| `colorScheme` | `'auto' \| 'light' \| 'dark'` | `'dark'` | Theme; `'auto'` follows OS preference |
+| `fontSize` | `number` | `13` | Character size |
+| `speed` | `number` | `1` | Animation speed multiplier |
+| `density` | `number` | `0.55` | Fraction of cells active (0–1) |
+| `accentColor` | `string` | varies | Highlight / head colour |
 
 ## License
 
-MIT
+MIT © [asciify.org](https://asciify.org)
+
+---
+
+<p align="left">
+  <a href="https://www.buymeacoffee.com/asciify">☕ Buy me a coffee — if this saved you time, I'd appreciate it!</a>
+</p>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "asciify-engine",
-  "version": "1.0.28",
+  "version": "1.0.30",
   "description": "Framework-agnostic ASCII art engine. Convert images, videos, and GIFs into ASCII art rendered on canvas.",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -39,6 +39,7 @@
   ],
   "author": "ayangabryl",
   "license": "MIT",
+  "homepage": "https://asciify.org",
   "repository": {
     "type": "git",
     "url": "https://github.com/ayangabryl/asciify"