@rune-ascii/animations 0.1.2 → 0.1.4

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.
package/README.md ADDED
@@ -0,0 +1,69 @@
1
+ # @rune-ascii/animations
2
+
3
+ Pre-generated ASCII art animation data for [`rune-ascii`](https://www.npmjs.com/package/rune-ascii). This package exists so that jsDelivr CDN mirrors it automatically, allowing the `<Rune>` component to fetch individual animations on demand without bundling them all.
4
+
5
+ **You don't need to install this package directly.** The `rune-ascii` React component fetches animations from this package via CDN automatically.
6
+
7
+ ## How it works
8
+
9
+ When you render a component like:
10
+
11
+ ```tsx
12
+ import { Rune } from "rune-ascii";
13
+
14
+ <Rune name="ghost" />;
15
+ ```
16
+
17
+ The `rune-ascii` component constructs a CDN URL like:
18
+
19
+ ```
20
+ https://cdn.jsdelivr.net/npm/@rune-ascii/animations@0.1.2/ghost.rune.json
21
+ ```
22
+
23
+ ...and fetches just that one animation. The browser caches it. You only download the animations you actually use.
24
+
25
+ ## Available animations
26
+
27
+ | Animation | Description |
28
+ | --------------- | -------------------- |
29
+ | `fire` | Flickering fire |
30
+ | `flame` | Single flame |
31
+ | `ghost` | Floating ghost |
32
+ | `earth1` | Spinning globe |
33
+ | `earth2` | Spinning globe (alt) |
34
+ | `saturn` | Saturn with rings |
35
+ | `coin` | Spinning coin |
36
+ | `orangutan` | Orangutan |
37
+ | `gorilla` | Gorilla |
38
+ | `shoes` | Shoes |
39
+ | `tuxLaptop` | Tux on a laptop |
40
+ | `rocket` | Rocket launch |
41
+ | `flowerSpinner` | Spinning flower |
42
+ | `loaderGood` | Loading spinner |
43
+ | `successCheck1` | Success checkmark |
44
+ | `error` | Error indicator |
45
+ | `warning` | Warning indicator |
46
+ | `sleepEmoji` | Sleep emoji |
47
+ | `angryEmoji` | Angry emoji |
48
+ | `geekedEmoji` | Geeked emoji |
49
+
50
+ Each animation is available in two sizes: `"m"` (90 columns, default) and `"s"` (45 columns).
51
+
52
+ ## Creating your own animations
53
+
54
+ Use the companion CLI to generate custom `.rune.json` files from any video:
55
+
56
+ ```bash
57
+ npx @rune-ascii/cli generate ./video.mp4 --name "my-animation"
58
+ ```
59
+
60
+ See [@rune-ascii/cli](https://www.npmjs.com/package/@rune-ascii/cli) for full documentation.
61
+
62
+ ## Related packages
63
+
64
+ - [`rune-ascii`](https://www.npmjs.com/package/rune-ascii) — React component for playing ASCII animations
65
+ - [`@rune-ascii/cli`](https://www.npmjs.com/package/@rune-ascii/cli) — CLI for generating `.rune.json` animations from video files
66
+
67
+ ## License
68
+
69
+ MIT