firew0rks

firew0rks

Play text art animations in your terminal! This package includes several pre-made animations like fireworks and a cozy fireplace.

Installation

npx firew0rks

Usage

npx firew0rks [folder] [loops]

Parameters (all optional):

• [folder]: Folder containing text art frames (numbered 0.txt, 1.txt, etc.). Defaults to 'fireworks'
• [loops]: Number of times to loop the animation (-1 for infinite). Defaults to 20

Examples

Run with defaults (fireworks animation, 20 loops):

npx firew0rks

Play the fireworks animation with custom loops:

npx firew0rks fireworks 3

Enjoy a cozy fireplace forever:

npx firew0rks fireplace -1

Local Development

To run the package locally:

• Clone the repository
• Run directly with Node:

node index.js
# Or with custom parameters:
node index.js fireplace 5

Creating Your Own Animations

• Create a new folder for your animation
• Add text art frames as numbered .txt files (0.txt, 1.txt, 2.txt, etc.)
• Run firew0rks with your folder name

Acknowledgments

This project is a JavaScript port of text_art_animations by rvizzz. Thank you for the inspiration and the amazing ASCII art animations!

License

MIT