fireworkrs
| Crates.io | fireworkrs |
| lib.rs | fireworkrs |
| version | 0.2.1 |
| created_at | 2025-01-01 16:22:51.846721+00 |
| updated_at | 2025-01-01 16:28:28.025038+00 |
| description | Play text art animations in your terminal! This package includes several pre-made animations like fireworks and a cozy fireplace that are embedded in the binary. |
| homepage | https://github.com/crisidev/fireworkrs |
| repository | https://github.com/crisidev/fireworkrs |
| max_upload_size | |
| id | 1500894 |
| size | 16,848,530 |
Matteo Bigoi (crisidev)
documentation
README
🦀 firework(r)s 🦀
Play text art animations in your terminal! This package includes several pre-made animations like fireworks and a cozy fireplace that are embedded in the binary.
If the folder name is found on disk, firework(r)s will prefer it over the embedded animation. See below how to create your own animation :)
Installation
cargo install fireworkrs
Usage
fireworkrs [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):
fireworkrs
Play the fireworks animation with custom loops:
fireworkrs fireworks 3
Enjoy a cozy fireplace forever:
fireworkrs fireplace -1
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 fireworkrs with your folder name
Acknowledgments
This project is a Rust port of firew0rks by addyosmani. Thank you for the inspiration and the amazing ASCII art animations!
License
MIT