`TTY::Font` ¶ ↑

Write text in large stylized characters using a variety of terminal friendly fonts.

TTY::Font provides independent terminal font rendering component for TTY toolkit.

Installation¶ ↑

Add this line to your application's Gemfile:

gem 'tty-font'

And then execute:

$ bundle

Or install it yourself as:

$ gem install tty-font

Usage¶ ↑

Initialize font out of available fonts:

font = TTY::Font.new(:doom)

and then print text out to console:

puts font.write("DOOM")
# =>
# ______  _____  _____ ___  ___
# |  _  \|  _  ||  _  ||  \/  |
# | | | || | | || | | || .  . |
# | | | || | | || | | || |\/| |
# | |/ / \ \_/ /\ \_/ /| |  | |
# |___/   \___/  \___/ \_|  |_/
#

To adjust the spacing between all the letters in a piece of text use :letter_spacing option:

puts font.write("DOOM", letter_spacing: 4)
# =>
# ______      _____      _____     ___  ___
# |  _  \    |  _  |    |  _  |    |  \/  |
# | | | |    | | | |    | | | |    | .  . |
# | | | |    | | | |    | | | |    | |\/| |
# | |/ /     \ \_/ /    \ \_/ /    | |  | |
# |___/       \___/      \___/     \_|  |_/

If you wish to print text in color use pastel:

pastel = Pastel.new
puts pastel.yellow(font.write("DOOM"))

Fonts¶ ↑

The list of the available fonts: (select link to see font face)

Development¶ ↑

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing¶ ↑

Bug reports and pull requests are welcome on GitHub at github.com/piotrmurach/tty-font. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License¶ ↑

The gem is available as open source under the terms of the MIT License.

Code of Conduct¶ ↑

Everyone interacting in the TTY::Font project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

TTY::Font ¶ ↑