Skip to content

Latest commit

 

History

History
209 lines (154 loc) · 6.5 KB

README.md

File metadata and controls

209 lines (154 loc) · 6.5 KB
Raw
             .,-:;//;:=,                
          . :H@@@MM@M#H/.,+%;,          
       ,/X+ +M@@M@MM%=,-%HMMM@X/,       
     -+@MM; $M@@MH+-,;XMMMM@MMMM@+-     
    ;@M@@M- XM@X;, -+XXXXXHHH@M@M#@/.   
  ,%MM@@MH ,@%=            .---=-=:=,.  
  =@#@@@MX .,              -%HX$$%%%+;  
 =-./@M@M$                  .;@MMMM@MM: 
 X@/ -$MM/                    .+MM@@@M$ 
,@M@H: :@:                    . =X#@@@@-
,@@@MMX, .                    /H- ;@M@M=
.H@@@@M@+,                    @MM+..%#$.
 /MMMM@MMH/.                  XM@MH; =; 
  /%+%$XHH@$=              , .H@@@@MX,  
   .=--------.           -%H.,@@@@@MX,  
   .%MM@@@HHHXX$$$%+- .:$MMX =M@@MM%.   
     =XMMM@MM@MM#H;,-+HMM@M+ /MMMX=     
       ,:+$+-,/H#MMMMMMMMM@= =,         
             =++%%%%+/:-.               


$ echo 'An useless but fun way to show text-based art!'

Let's revive the ASCII art!

Nincat is community-driven project that loads an ASCII art centred in your terminal.

Features:

  • Fast as it can be and lightweight.
  • Self adapt with the terminal size to print only ASCII arts that fit.
  • Supports any external program such as lolcat.
  • Supports HEX colour foreground/background arts and 256 colours, 88 colours, 16 colours.
  • Skip empty ASCII art files.
  • You can select an art directly (by option).
  • List all ASCII art's paths (by option).
  • Print the name of printed art (by option).
  • Modular folder containing the ASCII arts.

Installing

By Github

Click in Code in this repository and then Download ZIP. Extract it using your favourite tool and then in your terminal:

> cd PUT_HERE_THE_PATH_OF_NINCAT
> nincat random

By Git

From your terminal, you can clone in your preferred folder:

> git clone 'https://github.com/ninecath/nincat'
> cd nincat
> use ./nincat.nu
> nincat random

Tips

Loading when your terminal emulator open.

That is, when your shell is loaded. There are many shells out there, a very famous one is bash.

Anyway, all you need to do is add one line in your shell-r that runs nincat, then you'll be able to load it when the terminal opens :)

To verify what shell-rc you should have, run $env.SHELL or echo $SHELL (POSIX) in your terminal.

  • For zsh the rc is put in ~/.zshrc;
  • For bash the rc is put in ~/.bashrc;
  • For fish the config is put in ~/.config/fish/config.fish;
  • For nu the config is put in ~/.config/nushell/config.nu.
> nincat random

Creating ASCII/ANSI/TEXT-BASED art.

Tools that can be used to make easier this type of art can be found on Internet, here's a few of them:

Colours*

Give a look at this site for 256, 88, 16 colours in your ASCII arts. And obviously, you should utilize \033 instead of \e.

For RGB colours, I'd recommend this lecture-commentary.

Preview of one ASCII art with lolcat.

Contributing/Adding ASCII arts:

File names are made in this format: <name-of-art>. The spaces are important since we use them to rule out what arts should be printed.

The art files are put in the /assets/. You can make a separate folder to add your own arts. Of course, update the list after with:

$ nincat setup

Please, do not fill all the lines with spaces to close all columns. A good and simple example should be: And do not use tabs, instead you should use spaces.

# Your wonderful username/name and/or extra information about authority (author).
   (   )
: ) o_o ( :

Please, contribute!

It would be lovely that for every art you add, you add it here, too! Remember to put your name in the first line, so your contribution is never forgotten :)

  • By Github's Pull Request (recommended)

Clone this project, add your art in a file in either manually with Github or with git, then send a pull request here comparing both branches.

  • By Github's Issue

Create a new issue in the New art type of issue and put your art there.

Dependencies:

  • nushell

Acknowledgements:

You can find alternatives in the web, here are some with their initial commits:

GPL3 License