fire-cli-rs 0.1.3

Terminal fire animation written in Rust.
Documentation
  • Coverage
  • 0%
    0 out of 55 items documented0 out of 40 items with examples
  • Size
  • Source code size: 39.36 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 3.07 MB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 1m 1s Average build duration of successful builds.
  • all releases: 1m 1s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • Homepage
  • horizonwiki/fire
    5 0 0
  • crates.io
  • Dependencies
  • Versions
  • Owners
  • horizonwiki

Fire >_

Terminal fire animation written in Rust.


☁️ Overview

Fire CLI is an ultra-lightweight utility written in Rust that turns your terminal into a cozy fireplace. Thanks to direct buffer manipulation and zero heavy dependencies, the animation stays smooth even on the weakest hardware.

Why is this cool?

  • OS-Agnostic: Works anywhere Rust and libc are supported — Windows, macOS, Linux distros, or BSD.
  • Zero Logic Clutter: All visuals are built on standard output streams, guaranteeing operation in minimalist environments.

✨ Key Features

Feature Description
🎚️ Customization Full control over burn speed and flame intensity.
🎨 Themes A set of preset color schemes — from classic fire to magical blue.
🌚 Monochrome A dedicated mode for fans of classic ASCII art without color.
🚀 Performance Minimal resource usage thanks to the efficient Rust engine.

[!TIP] ASCII Engine: The fire visualization is based on ANSI escape sequences. For a perfect gradient, your terminal must support 24-bit color (TrueColor).


💻 Terminal Compatibility

On legacy systems (Windows 10 and below), standard consoles like cmd.exe or PowerShell.exe often struggle with intensive dynamic output, causing several visual issues:

  • ⚠️ Artifacts: "Garbage" control characters like ←[0K appearing on top of the animation.
  • 📉 Tearing: Slow stream processing causes noticeable frame tearing and flickering.
  • 🚫 TrueColor issues: Older consoles do not support 24-bit color.

For a flawless picture, use any modern terminal with Virtual Terminal (VT) Sequence support:

  • 🎨 Recommended: Windows Terminal, Alacritty, or WezTerm.
  • 🚀 Also great: Kitty, Foot, Konsole, or any other emulator with 24-bit color support.
  • 🛠️ Key requirement: The terminal must correctly handle control codes for the Rust engine's magic to work smoothly.

[!TIP] If you see strange symbols like ←[0K or the animation stutters — your current terminal is technically outdated. Time to upgrade!


🎮 Usage & Controls

Launch the animation with the simple fire-cli command. Use the following flags for fine-tuning:

⚙️ Launch Options

Flag Full Name Description Values
-f --fps Set the frame rate 15–120 (default: 30)
-t --theme Set theme (default: std)
-n-c --no-color Disable colors (ASCII mode)
-h --help Show the help menu
-v --version Show version info

🎨 Themes

[!TIP] Usage: -t or --theme [name]

Theme Preview Description
ash ash monochrome smoke & gray fire
aurora aurora shifting green-teal northern lights
blue blue blue neon fire
classic classic alternative classic fire
copper copper turquoise copper-oxide flame
crimson crimson aggressive crimson-red fire
dusk dusk warm orange-purple sunset fire
ember ember glowing amber coals
emerald emerald deep emerald chemical fire
forest forest mystical green fire
frost frost cold blue-white icy fire
ghost ghost ethereal violet magic flame
gold gold luxury metallic golden shimmer
ice ice ice fire
magma magma viscous glow of molten lava
nebula nebula cosmic pink & blue fire
pink pink pink neon fire
plasma plasma electric indigo plasma
rainbow rainbow multicolor spectrum fire
sakura sakura soft pink cherry blossom fire
solar solar blinding white-hot solar flares
std std classic fire
sulfur sulfur ghostly blue flame
custom use a user-defined theme

Custom Theme Format:

custom:#hex.#hex.#hex.#hex

Provide 1 to 4 HEX colors separated by dots (e.g., custom:#ff0000.#00ff00)

💡 Example Commands

fire-cli -f 60

fire-cli --theme copper --fps 45

fire-cli -t custom:#ff0055.#ffcc00.#ffffff

⌨️ Controls

  • ESC or Ctrl+C — Exit the program.

📷 Captures

🔹 Screenshots

🔹 Screencasts

📄 License

This software is provided under the Apache License 2.0.