https://github.com/bram-bolt/terminal-fire
A fireplace for in your CLI/terminal
https://github.com/bram-bolt/terminal-fire
ascii-art cli-app shell terminal-app
Last synced: 9 months ago
JSON representation
A fireplace for in your CLI/terminal
- Host: GitHub
- URL: https://github.com/bram-bolt/terminal-fire
- Owner: Bram-Bolt
- License: mit
- Created: 2024-09-13T11:42:52.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-30T15:23:37.000Z (over 1 year ago)
- Last Synced: 2025-03-28T18:51:57.228Z (about 1 year ago)
- Topics: ascii-art, cli-app, shell, terminal-app
- Language: Python
- Homepage:
- Size: 256 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## 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](https://github.com/Bram-Bolt/terminal-fire/releases).
```bash
git clone https://github.com/bram-bolt/terminal-fire.git
```
Use `pip` to install it locally:
```bash
cd terminal-fire
pip install .
```
### Usage
After installing run:
```bash
terminal-fire
```
#### Enable sound
You can enable sound by using:
```bash
terminal-fire --sound
```
... or
```bash
terminal-fire -s
```
#### Set FPS
You can set the FPS by:
```bash
terminal-fire --fps [fps]
```
... or
```bash
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`.
```bash
git clone https://github.com/bram-bolt/terminal-fire.git
cd terminal-fire
python -m terminal_fire.app.main
```
### Road Map
- [x] 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 [contact@brambolt.me](mailto:contact@brambolt.me).
## License
Distributed under the MIT License. See [LICENSE](https://github.com/Bram-Bolt/terminal-fire/blob/main/LICENSE) for more information.