Skip to content

Latest commit

 

History

History
62 lines (43 loc) · 2.92 KB

README.md

File metadata and controls

62 lines (43 loc) · 2.92 KB

dvd-term

CI CD Crates.io Crates.io Total Downloads GitHub Downloads (all assets, all releases) License

A bouncing ASCII art DVD logo (or custom text) for the terminal. Uses figlet-rs for converting 'logo' text into ASCII art.

example gif

Recent Changes

[v0.1.4]

  • Modified argument parsing to allow multiple -t, --text <TEXT> flags to be used, displaying multiple 'logos'.
    • Updated -h, --help message to explain new -t, --text <TEXT> usage.
  • Modified color randomization to disallow 'black' or other too-dark colors.

Installation

Cargo

  • Install the rust toolchain in order to have cargo installed by following this guide.
  • run cargo install dvd-term

Usage

Usage: dvd-term [OPTIONS]

Options:
      -t, --text <TEXT>     The custom text to use. Defaults to "DVD". Can be used multiple times to display multiple 'logos'
      -f, --font <FONT>     Specify a custom figlet font path
      -c, --color <COLOR>   Initial logo color code (0-255). Defaults to white (15). (https://ss64.com/bash/syntax-colors.html)
      -r, --random          If included, logo will randomize color when it bounces
      -s, --speed <SPEED>   The speed of the logo (how many 'cells' to move per second). Defaults to 15
      -p, --plain           If included, logo will be displayed in plain text instead of converted to ASCII art
      -a, --art <ART_PATH>  Specify the path of a plain text file with the ASCII art to display
      -h, --help            Print help
      -V, --version         Print version

Contributing (Issues/PRs)

If you encounter any bugs or problems, or you simply have a feature request, please feel free to create an issue or make a pull request, and I'll be happy to review and respond, and merge any PRs that pass a quick review.

See CONTRIBUTING for details.

License

Licensed under either of

at your option.