https://github.com/wyatt915/fireplace

A cozy fireplace in your terminal
https://github.com/wyatt915/fireplace

cli fireplace fun terminal terminal-based

Last synced: 3 months ago
JSON representation

A cozy fireplace in your terminal

• Host: GitHub
• URL: https://github.com/wyatt915/fireplace
• Owner: Wyatt915
• License: mit
• Created: 2017-10-14T19:13:40.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2024-10-20T22:27:59.000Z (about 1 year ago)
• Last Synced: 2024-10-21T02:41:10.424Z (about 1 year ago)
• Topics: cli, fireplace, fun, terminal, terminal-based
• Language: C
• Size: 19.5 MB
• Stars: 74
• Watchers: 3
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Fireplace

A cozy fireplace in your terminal

![A gif of what to expect](demo.gif?raw=true "Cozy")

## Build and Run

* Install ncurses

    * Including the development packages (usually called libncurses5-dev or something similar)

* `make`

* `./fireplace`

### Options

```

Usage: ./fireplace [options]

        -c character    An ASCII character to draw the flames. Default is '@'.

        -h              Print this message.

        -f framerate    Set the framerate in frames/sec. Default is 20.

                        A framerate of zero will make frames spit out as soon as they are ready.

        -t temp         Set the maximum temperature of the flames. Default is 10.

                        A higher temp means taller flames. Press the up/down arrows

                        to change the temperature at any time.

        -r              print random characters

Press ^C or q at any time to douse the flames.^C

```

## Docker build and run

* `docker build . -t fireplace:latest`

* `docker run -it --rm fireplace`

### Run with arguments:

* `docker run -it --rm fireplace -t 7`