asciify-engine 4.18.0 → 4.20.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -98,12 +98,10 @@ For GSAP, pass your installed `gsap` and `ScrollTrigger` instances through `scro
98
98
  ## Procedural backgrounds
99
99
 
100
100
  ```js
101
- import { asciiBackground } from './wave.js'; // 4.0–4.13: a template downloaded from asciify.org/backgrounds
102
- const background = asciiBackground(host, {
103
- type: 'aurora', fontSize: 14, speed: 0.8, density: 0.55,
104
- });
101
+ import { background, halo } from 'asciify-engine/kit';
102
+ const bg = background(host, { preset: halo, clear: headline, cursor: false });
105
103
  // On unmount:
106
- background.destroy();
104
+ bg.destroy();
107
105
  ```
108
106
 
109
- From 4.0 to 4.13, procedural backgrounds were downloadable templates at asciify.org/backgrounds, outside npm, and existing imports keep working. Newer kits ship them all as `background(host, { preset })` from `asciify-engine/kit`, Fluid included; use that for new work ([kit.md](kit.md#backgrounds), [applying-asciify.md](applying-asciify.md#9-backgrounds)).
107
+ Procedural backgrounds ship in `asciify-engine/kit` as `background(host, { preset })`, Fluid included ([kit.md](kit.md#backgrounds), [applying-asciify.md](applying-asciify.md#9-backgrounds)). From 4.0 to 4.13 they were single-file templates downloaded from asciify.org/backgrounds (`asciiBackground` from `./wave.js`); copies already in an app keep working, but the site no longer offers them.
@@ -46,7 +46,7 @@ Use one motion owner: `animationStyle` for core, `motion` for `/hover`, or `moti
46
46
 
47
47
  ## 4.0 background migration
48
48
 
49
- Remove imports from `asciify-engine/backgrounds` and generator imports from the root package. Download the chosen `.js` template from https://asciify.org/backgrounds and change the import to `./wave.js` (or your selected file). The template exports `asciiBackground`; keep calling `destroy()` on unmount. It handles resizing, hidden/offscreen suspension, reduced motion, and cleanup. A selected template contains only that generator; backgrounds.js is the optional full collection. Application-owned source templates are separate from npm updates. Existing installations can stay on 3.x while migrating. Since 4.14 the kit exports every background as `background(host, { preset })` from `asciify-engine/kit`; prefer that to a downloaded template when the installed kit has it. Text and media rendering remain supported, including text backgrounds.
49
+ Remove imports from `asciify-engine/backgrounds` and generator imports from the root package. Use `background(host, { preset })` from `asciify-engine/kit` (4.14 and later) with the closest curated preset; [kit.md](kit.md#backgrounds) maps each retired one. The single-file templates once downloadable from asciify.org/backgrounds (`asciiBackground` from `./wave.js`) are no longer offered; copies already in an app keep working and keep calling `destroy()` on unmount. Existing installations can stay on 3.x while migrating. Text and media rendering remain supported, including text backgrounds.
50
50
 
51
51
  Use `CHARACTER_SETS` from root or `/core` for the same eight choices as the editor's `STUDIO_CHARACTER_SETS`. This data-only import does not load Studio. Keep custom characters available separately; do not import the removed `CHARSETS` object.
52
52