Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/miketierney/artii

A small gem to generate ASCII art from text fed in to it
https://github.com/miketierney/artii

Last synced: 10 days ago
JSON representation

A small gem to generate ASCII art from text fed in to it

Host: GitHub
URL: https://github.com/miketierney/artii
Owner: miketierney
Created: 2010-08-26T06:51:08.000Z (about 14 years ago)
Default Branch: master
Last Pushed: 2023-01-09T22:19:58.000Z (almost 2 years ago)
Last Synced: 2024-10-31T10:08:14.916Z (13 days ago)
Language: Ruby
Homepage:
Size: 5.01 MB
Stars: 211
Watchers: 7
Forks: 30
Open Issues: 9
Metadata Files:
- Readme: README.rdoc
- Changelog: History.txt

Awesome Lists containing this project

README

        = ASCII Arty

Light-weight ASCII art generator

== Description

ASCII Arty is a little ASCII art generator that uses the Figlet library. Just feed it a string and it'll create a fancy ASCII art image.

== Features

- Figlet font library

== Examples

  # Basic usage (cli)

  $ artii 'Art!'

  # =>                 _   _ 

  # =>      /\        | | | |

  # =>     /  \   _ __| |_| |

  # =>    / /\ \ | '__| __| |

  # =>   / ____ \| |  | |_|_|

  # =>  /_/    \_\_|   \__(_)

  # =>                       

  # To use a different font

  $ artii 'Art!' --font slant

  # =>      ___         __  __

  # =>     /   |  _____/ /_/ /

  # =>    / /| | / ___/ __/ / 

  # =>   / ___ |/ /  / /_/_/  

  # =>  /_/  |_/_/   \__(_)   

  # =>                        

  # Integrated usage

  a = Artii::Base.new :font => 'slant'

  a.asciify('Art!')

  # =>      ___         __  __

  # =>     /   |  _____/ /_/ /

  # =>    / /| | / ___/ __/ / 

  # =>   / ___ |/ /  / /_/_/  

  # =>  /_/  |_/_/   \__(_)   

  # =>                        

== Requirements

None

== Install

- (sudo) gem install artii

== TODO

- Allow integrated objects to accept a print out a pre-defined text value

- Ability to load non *.flf files (fonts are available, .flc file-types seem to be an issue right now)

- Ability to set custom configurations, so you don't have to constantly set the options (like font) unless you want to

- Some nice built-in utilities (to make for easier demoing)

- Font list should show samples of the faces in addition to the names

- Font list should be able to show a given range (fonts starting with specific letters, or a range of letters)

- Font list should be searchable (a la grep)

- Font list needs to be generated from a) included fonts and b) a user-specified location (see To Do about custom configurations)

= Prior Art

== Figlet

Figlet (http://www.figlet.org) implementation written by Tim Fletcher

([email protected]). Found originally in the text gem

(http://github.com/threedaymonk/text), and re-implemented here due to

its removal.

== Note on Patches/Pull Requests

* Fork the project.

* Make your feature addition or bug fix.

* Add tests for it. This is important so I don't break it in a

  future version unintentionally.

* Commit, do not mess with rakefile, version, or history.

  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)

* Send me a pull request. Bonus points for topic branches.

== License

(The MIT License)

Copyright (c) 2016 Michael Tierney

http://miketierney.com

Permission is hereby granted, free of charge, to any person obtaining

a copy of this software and associated documentation files (the

'Software'), to deal in the Software without restriction, including

without limitation the rights to use, copy, modify, merge, publish,

distribute, sublicense, and/or sell copies of the Software, and to

permit persons to whom the Software is furnished to do so, subject to

the following conditions:

The above copyright notice and this permission notice shall be

included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,

EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.

IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY

CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,

TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE

SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.