https://github.com/addyosmani/firew0rks
Fireworks in your terminal 🎆
https://github.com/addyosmani/firew0rks
ascii-fireworks fireworks fireworks-algorithm fireworks-animation
Last synced: about 1 month ago
JSON representation
Fireworks in your terminal 🎆
- Host: GitHub
- URL: https://github.com/addyosmani/firew0rks
- Owner: addyosmani
- License: mit
- Created: 2024-12-31T21:39:29.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-12-31T23:23:12.000Z (10 months ago)
- Last Synced: 2025-01-11T23:04:50.746Z (9 months ago)
- Topics: ascii-fireworks, fireworks, fireworks-algorithm, fireworks-animation
- Language: JavaScript
- Homepage:
- Size: 1.75 MB
- Stars: 504
- Watchers: 2
- Forks: 26
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# firew0rks
Play text art animations in your terminal! This package includes several pre-made animations like fireworks and a cozy fireplace.
## Installation
```bash
npx firew0rks
```
## Usage
```bash
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):
```bash
npx firew0rks
```
Play the fireworks animation with custom loops:
```bash
npx firew0rks fireworks 3
```
Enjoy a cozy fireplace forever:
```bash
npx firew0rks fireplace -1
```
## Local Development
To run the package locally:
1. Clone the repository
2. Run directly with Node:
```bash
node index.js
# Or with custom parameters:
node index.js fireplace 5
```
## Creating Your Own Animations
1. Create a new folder for your animation
2. Add text art frames as numbered .txt files (0.txt, 1.txt, 2.txt, etc.)
3. Run firew0rks with your folder name
## Acknowledgments
This project is a JavaScript port of [text_art_animations](https://github.com/rvizzz/text_art_animations) by rvizzz. Thank you for the inspiration and the amazing ASCII art animations!
## License
MIT