https://github.com/robertmarsal/lolcatjs

For the lols
https://github.com/robertmarsal/lolcatjs

lol

Last synced: 2 months ago
JSON representation

For the lols

• Host: GitHub
• URL: https://github.com/robertmarsal/lolcatjs
• Owner: robertmarsal
• License: other
• Created: 2015-04-18T12:16:53.000Z (almost 10 years ago)
• Default Branch: main
• Last Pushed: 2023-12-09T22:34:29.000Z (about 1 year ago)
• Last Synced: 2024-11-07T02:15:31.499Z (3 months ago)
• Topics: lol
• Language: JavaScript
• Size: 389 KB
• Stars: 110
• Watchers: 2
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-ascii - lolcatjs

README

        
![lolcatjs](/assets/banner.png)

> For when you need the lols but don't have the rubies.

This is a node port of the famous [lolcat](https://github.com/busyloop/lolcat) gem. It implements all the original functionality and behaviour.

## Installation

```javascript

npm install -g lolcatjs

```

## Usage

**Command Line**

```javascript

lolcatjs [OPTION]... [FILE]...

Concatenate FILE(s), or standard input, to standard output.

With no FILE, or when FILE is -, read standard input.

    --spread, -p :   Rainbow spread (default: 8.0)

      --freq, -F :   Rainbow frequency (default: 0.3)

      --seed, -S :   Rainbow seed, 0 = random (default: 0)

       --animate, -a:   Enable psychedelics

  --duration, -d :   Animation duration (default: 12)

     --speed, -s :   Animation speed (default: 20.0)

         --force, -f:   Force color even when stdout is not a tty

       --version, -v:   Print version and exit

          --help, -h:   Show this message


Examples:

  lolcatjs f - g     Output f's contents, then stdin, then, g's contents.

  lolcatjs           Copy standard input to standard output.

  fortune | lolcatjs Display a rainbow cookie.

```

**NPM Module**

```javascript

const lolcatjs = require('lolcatjs');

lolcatjs.options.seed = Math.round(Math.random() * 1000);

lolcatjs.options.colors = true;

lolcatjs.fromString('I can has Cheezburger?');

```

## Demo

![lolcatjs](/assets/demo.gif)

## Thanks

Nur Ortega Marsal for creating the banner

## License

WTFPL © Robert Marsal