ruby_nyancat's Introduction

Ruby port of Nyancat CLI

A Ruby port of the original nyancat CLI by Kevin Lange. Currently only supports xterm 256-color compatible terminals, likely doesn't work on Windows and lacks any finese or optimisation.

$ gem install nyancat
$ nyancat

For options, see --help

$ nyancat --help
Usage: nyancat [options]
-s, --silent                     Don't play audio
-f, --flavour FLAVOUR            Available flavours: original
-n, --notime                     Don't show the time nyaned
-l, --listen [PORT]              Run telnet server on PORT (default 21)
-t, --timeout SECONDS            Timeout after SECONDS

Audio

Very basic audio support is provided by using mpg123. You'll need mpg123 installed and in your $PATH for audio to work.

Telnet server

If run with -l or --listen and an optional port argument, a simple socket server will be started. The server will render a loop of the 'original' animation to connected clients using ANSI escaped text until any input from the client is received, upon which the connection is closed. The server does not currently implement the telnet protocol and simply spews ANSI text to the client. A proper telnet implementation is planned for the future.

Clients can connect to the server with a telnet client, though only xterm 256-color compatible terminals are supported.