https://github.com/piotrmurach/tty-font
Terminal fonts
https://github.com/piotrmurach/tty-font
console font ruby rubygem terminal tty
Last synced: 5 months ago
JSON representation
Terminal fonts
- Host: GitHub
- URL: https://github.com/piotrmurach/tty-font
- Owner: piotrmurach
- License: mit
- Created: 2017-12-17T17:21:47.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-04-24T19:38:04.000Z (almost 3 years ago)
- Last Synced: 2024-10-31T13:53:18.508Z (6 months ago)
- Topics: console, font, ruby, rubygem, terminal, tty
- Language: Ruby
- Homepage: http://ttytoolkit.org
- Size: 81.1 KB
- Stars: 60
- Watchers: 3
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- Open-Source-Ruby-and-Rails-Apps - tty-font - Terminal fonts 🔥 ✅ 🚀 (Happy Exploring 🤘)
README
# TTY::Font [][gitter]
[][gem]
[][gh_actions_ci]
[][appveyor]
[][codeclimate]
[][coverage]
[][inchpages]
[gitter]: https://gitter.im/piotrmurach/tty
[gem]: http://badge.fury.io/rb/tty-font
[gh_actions_ci]: https://github.com/piotrmurach/tty-font/actions?query=workflow%3ACI
[appveyor]: https://ci.appveyor.com/project/piotrmurach/tty-font
[codeclimate]: https://codeclimate.com/github/piotrmurach/tty-font/maintainability
[coverage]: https://coveralls.io/github/piotrmurach/tty-font
[inchpages]: http://inch-ci.org/github/piotrmurach/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](https://github.com/piotrmurach/tty) toolkit.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'tty-font'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install tty-font
## Usage
Initialize font out of [available](#fonts) fonts:
```ruby
font = TTY::Font.new(:doom)
```
and then print text out to console:
```ruby
puts font.write("DOOM")
# =>
# ______ _____ _____ ___ ___
# | _ \| _ || _ || \/ |
# | | | || | | || | | || . . |
# | | | || | | || | | || |\/| |
# | |/ / \ \_/ /\ \_/ /| | | |
# |___/ \___/ \___/ \_| |_/
#
```
To adjust the spacing between all the letters in a piece of text use `:letter_spacing` option:
```ruby
puts font.write("DOOM", letter_spacing: 4)
# =>
# ______ _____ _____ ___ ___
# | _ \ | _ | | _ | | \/ |
# | | | | | | | | | | | | | . . |
# | | | | | | | | | | | | | |\/| |
# | |/ / \ \_/ / \ \_/ / | | | |
# |___/ \___/ \___/ \_| |_/
```
If you wish to print text in color use [pastel](https://github.com/piotrmurach/pastel):
```ruby
pastel = Pastel.new
puts pastel.yellow(font.write("DOOM"))
```
## Fonts
The list of the available fonts: (select link to see font face)
* [3d](fonts/3d.md)
* [block](fonts/block.md)
* [doom](fonts/doom.md)
* [standard](fonts/standard.md)
* [starwars](fonts/starwars.md)
* [straight](fonts/straight.md)
## 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](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://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](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## 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](https://github.com/piotrmurach/tty-font/blob/master/CODE_OF_CONDUCT.md).
## Copyright
Copyright (c) 2017 Piotr Murach. See LICENSE for further details.