About The Project

Terminal-Fire is a python app that runs in your CLI and generates an ASCII animation of a fireplace. To create this effect, an OOP approach with numpy is used.

Set Up

Installation

To install the package, clone the repository or download it from the release page.

git clone https://github.com/bram-bolt/terminal-fire.git

Use pip to install it locally:

cd terminal-fire
pip install .

Usage

After installing run:

terminal-fire

Enable sound

You can enable sound by using:

terminal-fire --sound

... or

terminal-fire -s

Set FPS

You can set the FPS by:

terminal-fire --fps [fps]

... or

terminal-fire -f [fps]

the default is 10.

Contributing

Contributions are welcome! Please submit a pull request or open an issue to discuss potential changes or improvements.

Quick Testing

For quick testing of the package , run it is as a module using -m.

git clone https://github.com/bram-bolt/terminal-fire.git
cd terminal-fire
python -m terminal_fire.app.main

Road Map

• Add sound
• Add more dynamic fire start
• Add developer docs
• Add a better fire sound

Docs

comming soon.

Contact

Questions? Feel free to reach out to [email protected].

License

Distributed under the MIT License. See LICENSE for more information.