/README.org

  1* Nyan Mode - Turn your Emacs into Nyanmacs! :)
  2
  3[[https://github.com/TeMPOraL/nyan-mode][file:https://badge.fury.io/gh/TeMPOraL%2Fnyan-mode.svg]]
  4[[http://www.nyan.cat/][file:https://img.shields.io/badge/nyan-nyan-ff00ff.svg]]
  5[[https://stable.melpa.org/#/nyan-mode][file:https://stable.melpa.org/packages/nyan-mode-badge.svg]]
  6[[https://melpa.org/#/nyan-mode][file:https://melpa.org/packages/nyan-mode-badge.svg]]
  7[[https://doi.org/10.5281/zenodo.164185][file:https://zenodo.org/badge/DOI/10.5281/zenodo.164185.svg]] *WARNING, MIND DUMBING CONTENT INSIDE.*
  8
  9#+BEGIN_QUOTE
 10"Nyan-mode. It's things like this that make me proud to be an emacs user." - [[http://twitter.com/#!/mitchellh/status/104931263479156736][mitchellh]]
 11#+END_QUOTE
 12
 13#+BEGIN_QUOTE
 14"Everything that's wrong (or right) with Emacs." - [[https://youtu.be/NBArWrn6FnY?t=756][wasamasa]]
 15#+END_QUOTE
 16
 17Nyanmacs is expanding!! [[http://jacek.zlydach.pl/blog/2011-08-25-introducing-nyan-mode-el-turn-your-emacs-into-nyanmacs.html][Read the story so far]]! :).
 18
 19[[file:screenshot.png]]
 20
 21Nyan Mode is an analog indicator of your position in the buffer. The
 22Cat should go from left to right in your mode-line, as you move your
 23point from 0% to 100%.
 24
 25** Features
 26   - *NEW!* You can scroll the buffer by clicking in the Nyan Cat area!
 27   - *NEW!* You can customize the minimum window width below which Nyan Mode will be disabled.
 28   - Mind dumbing content included,
 29   - Animation (=M-x nyan-start-animation=, =M-x nyan-stop-animation=),
 30   - Wavy rainbow (=M-x nyan-toggle-wavy-trail=),
 31   - Music, mplayer is needed (=M-x nyan-start-music=, =M-x nyan-stop-music=) (thanks, George Leontiev!),
 32   - Customizable properties.
 33
 34** Customizations
 35
 36   - =nyan-animate-nyancat= - =t= to have it animated, =nil= for a static version.
 37   - =nyan-animation-frame-interval= - number of seconds between animation frames. Accepts fractional values.
 38   - =nyan-bar-length= - length of nyan-mode bar, in 8px-wide units.
 39   - =nyan-cat-face-number= - choose a cat face for the console mode.
 40   - =nyan-wavy-trail= - =t= to make the trail wavy; works even better when animation is enabled!
 41   - =nyan-minimum-window-width= - minimum width of the window, below
 42     which Nyan Mode will be disabled. This is important because Nyan
 43     Mode will otherwise push out more relevant information from the
 44     modelilne.
 45
 46** Using Nyan Mode with custom modeline
 47For those who were asking, or are planning to, [[http://web.archive.org/web/20120131133230/http://friendfeed.com/amitp/b4097da0/nyan-mode-turn-your-emacs-into-nyanmacs][Amit Patel shared]]
 48some tips on how to make nyan-mode work with custom modeline.
 49
 50He changed his mode-line-format to appear like the following:
 51#+begin_src emacs-lisp
 52(setq mode-line-format
 53      (list
 54       '(:eval (list (nyan-create)))
 55       ))
 56#+end_src
 57
 58** Known issues
 59It's my second attempt to write a minor mode in Emacs, so there will
 60definiely be some bugs.
 61
 62This version uses XPM images, which should be supported by default by
 63most Emacs 23 installations, Windows included. In case it doesn't
 64work, try switching to master-png branch. This branch, however, may
 65have it's own issues:
 66
 67There was a problem with displaying PNG images, which require libpng
 68to be available for Emacs. The lib is sometimes missing (e.g. some
 69Windows installation). To make it work on Windows, one needs to
 70download a proper DLL and put it into emacs bin/ folder. To see which
 71DLL is needed, do: =M-x describe-variable <ret> image-library-alist <ret>=.
 72
 73+Customizing nyan-animate-nyancat is broken; don't do it.+
 74I think it works now; please report issues if there are problems with it.
 75
 76** Credits
 77Thanks to everyone contributing patches, bug repots and ideas! The Emacs world is forever in your debt!
 78
 79Code and idea inspired by sml-modeline.el, written by Lennart Borgman.
 80See: http://bazaar.launchpad.net/~nxhtml/nxhtml/main/annotate/head%3A/util/sml-modeline.el
 81
 82For animated Nyan Cat, I used frames [[http://media.photobucket.com/image/nyan%20cat%20sprites/DryBowser455/th_NyanCatSprite.png?t=1304659408][by DryBowser455]].
 83
 84** Other editors
 85For many years only the [[https://www.gnu.org/software/emacs/][One True Editor]] was blessed with the presence
 86of the Nyan Cat. Since its inception, however, daring souls have brought
 87Nyanness to the lands of Lesser Editors.
 88
 89Here are the examples I've tracked down so far:
 90
 91- Vim - nefo-mi's [[https://github.com/nefo-mi/nyan-modoki.vim][nyan-modoki.vim]] (text-only, it seems)
 92- Vim - edvb54's [[https://github.com/edvb54/catium.vim][catium.vim]] (also text, apparently)
 93- Sublime Text - wiggin15's [[https://github.com/wiggin15/SublimeNyan][SublimeNyan]]
 94- Atom - dz's [[https://github.com/dz/atom-nyancat][atom-nyancat]]
 95- qutebrowser - [[https://github.com/jgkamat/qutenyan][qutenyan]]
 96
 97If you've seen others in the wild, please submit.
 98
 99** Related
100
101Check out Aaron Miller's [[https://github.com/aaron-em/weatherline-mode.el][weatherline.el]], partially inspired by Nyan Mode.
102
103Also check out [[https://github.com/wasamasa/zone-nyan][zone-nyan]] by Vasilij Schneidermann if you want the Nyan
104Cat to visit your Emacs when you step away from the keyboard!
105
106Nyanyanyanyanyanyanya! ♬ ♫ ♪ ♩