kailashsr38/ascii-magic-art

选用指南

AI 根据 README 整理 · 2026/10/25 07:55:57

使用方式

可通过npx命令在终端浏览和播放，也可通过HTML标签嵌入网页，或作为ES模块在代码中使用。

查看 README 依据

## Add one to your project in one prompt ```bash npx ascii-magic-art ``` Browse all 634 pieces live in your terminal. Arrow keys move between pieces and categories, `s` changes the look (halftone dots, ASCII, binary, dither and more) and `a` redraws text and line art too. Press enter and a prompt for that piece, in that look, is copied to your clipboard: paste it into Claude Code, Cursor, Copilot or any coding agent and it adds the piece to your site. Or skip the browsing: ```bash npx ascii-magic-art prompt matrix-rain ``` ## Play one in your terminal ```bash

npx ascii-magic-art moonlit-sea npx ascii-magic-art --list npx ascii-magic-art matrix-rain --seconds=3 # stop on its own, for shell startup npx ascii-magic-art sleeping-cat --frame # print one still frame, for a MOTD ``` Any key stops it. Add `--look=dots` (or `ascii`, `numbers`, `binary`...) or `--chars=" .oO@"` to redraw it in other characters. Colour turns off when output is piped or `NO_COLOR` is set. ## Put one on a web page ```html <script type="module" src="https://www.ascii-magic.com/ascii/ascii.js"></script> <ascii-art piece="moonlit-sea"></ascii-art> ``` Attributes:

Every piece is one small ES module with no dependencies apart from `lib/kit.js`. It exports `meta` and a `create()` function that returns `draw(t)`, a function from seconds to a frame: ```js import create, { meta } from "ascii-magic-art/pieces/spinning-torus.js"; const draw = create(); const frame = draw(1.5); // a string, or { text, color } console.log(frame.text ?? frame); ```

部署要求

使用npm安装或npx运行，需要Node.js环境；网页嵌入需支持ES模块的浏览器。

查看 README 依据

## Add one to your project in one prompt ```bash npx ascii-magic-art ``` Browse all 634 pieces live in your terminal. Arrow keys move between pieces and categories, `s` changes the look (halftone dots, ASCII, binary, dither and more) and `a` redraws text and line art too. Press enter and a prompt for that piece, in that look, is copied to your clipboard: paste it into Claude Code, Cursor, Copilot or any coding agent and it adds the piece to your site. Or skip the browsing: ```bash npx ascii-magic-art prompt matrix-rain ``` ## Play one in your terminal ```bash

npx ascii-magic-art moonlit-sea npx ascii-magic-art --list npx ascii-magic-art matrix-rain --seconds=3 # stop on its own, for shell startup npx ascii-magic-art sleeping-cat --frame # print one still frame, for a MOTD ``` Any key stops it. Add `--look=dots` (or `ascii`, `numbers`, `binary`...) or `--chars=" .oO@"` to redraw it in other characters. Colour turns off when output is piped or `NO_COLOR` is set. ## Put one on a web page ```html <script type="module" src="https://www.ascii-magic.com/ascii/ascii.js"></script> <ascii-art piece="moonlit-sea"></ascii-art> ``` Attributes:

| `mono` | one colour instead of the piece's palette | | `all` | with `look` or `chars`, redraw text and line work too, not only shading | | `contrast`| 0 to 100, default 0 | | `dot-size`| halftone dot size for the `dots` look, 25 to 120, default 51 | | `density` | halftone dot spacing, 40 to 250, default 131 (more dots, same size) | | `steps` | halftone dot sizes: `3`, `5`, or `0` for smooth | The element plays only while it is on screen, and holds a still frame for visitors who prefer reduced motion. ## Use a piece in your own code ```bash npm install ascii-magic-art ```

已知限制

两个基于照片的场景（ocean-sunset和starry-ridge）使用Unsplash许可证，其他作品为MIT许可。

查看 README 依据

## Licence MIT. Use the pieces anywhere, including commercial work. A link back is appreciated, not required. Two photo-based scenes, `ocean-sunset` and `starry-ridge`, keep the Unsplash License of their source photos; see [NOTICE](NOTICE). Want your own photo, logo or video as animated ASCII? That is what [ASCII Magic](https://www.ascii-magic.com) does.