https://github.com/akgondber/console-fun

Some console stuff to have a fun and watch some animations with texts, figures, etc.
https://github.com/akgondber/console-fun

Last synced: 2 months ago
JSON representation

Some console stuff to have a fun and watch some animations with texts, figures, etc.

• Host: GitHub
• URL: https://github.com/akgondber/console-fun
• Owner: akgondber
• Created: 2024-06-07T19:28:37.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-23T21:55:40.000Z (8 months ago)
• Last Synced: 2025-04-12T08:03:28.290Z (2 months ago)
• Language: JavaScript
• Size: 3.26 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# console-fun [![NPM version][npm-image]][npm-url]

> Some stuff in the console: utils, printing, games and other fun

## Install

```bash

$ npm install --global console-fun

```

## CLI

```

$ console-fun --help

  Some stuff in the console: utils, printing, games and other fun

  Usage

    $ console-fun

  Options

     --topic, -t  Topic, (e.g. game, print)

     --item, -i   Item to be used in context of topic (e.g. hacker-types, read-file, colored-stars-watcher)

     --subject    Subject to be used in context of some items (e.g. filename for read-file item)

     --color      Color to be used in context of some items

     --dimension  Matrix size for grid-like games

     --delay      Delay value to be used for example when reading file line-by-line

  Examples

     $ console-fun --topic game --item stars-watcher

     $ console-fun --topic game --item colored-stars-watcher

     $ console-fun --topic print --item hacker-types

     $ console-fun --topic print --item read-file --subject tmp/bar.txt

     $ console-fun --topic print --item read-file --subject tmp/bar.txt --delay 3000

```

## Demo

### colored-stars-game

![colored-stars-game-demo](media/colored-stars-game-demo.gif)

### hacker-types

Type any keys and some program text will be printed!

![hacker-types-demo](media/hacker-types-demo.gif)

### read-file

Read file line-by-line

![read-file-demo](media/read-file-demo.gif)

### animate-from-end

Animate from end (draw chars one by one from the end)

![animate-from-end](media/animate-from-end-demo.gif)

etc.

## License

MIT © [Rushan Alyautdinov](https://github.com/akgondber)

[npm-image]: https://img.shields.io/npm/v/console-fun.svg?style=flat

[npm-url]: https://npmjs.org/package/console-fun