https://github.com/johanvts/emacs-fireplace

A cozy fireplace for emacs.
https://github.com/johanvts/emacs-fireplace

Last synced: 2 months ago
JSON representation

A cozy fireplace for emacs.

• Host: GitHub
• URL: https://github.com/johanvts/emacs-fireplace
• Owner: johanvts
• Created: 2015-12-18T12:17:36.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2021-07-20T17:08:15.000Z (over 3 years ago)
• Last Synced: 2024-08-02T16:46:00.291Z (6 months ago)
• Language: Emacs Lisp
• Size: 528 KB
• Stars: 730
• Watchers: 16
• Forks: 21
• Open Issues: 6
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

• my-awesome-github-stars - johanvts/emacs-fireplace - A cozy fireplace for emacs. (Emacs Lisp)

README

        
emacs-fireplace

================

.. image:: https://api.travis-ci.org/johanvts/emacs-fireplace.svg

   :target: https://travis-ci.org/johanvts/emacs-fireplace

.. image:: https://coveralls.io/repos/johanvts/emacs-fireplace/badge.svg

   :target: https://coveralls.io/r/johanvts/emacs-fireplace

.. image:: http://melpa.org/packages/fireplace-badge.svg

   :target: http://melpa.org/#/fireplace

.. image:: http://stable.melpa.org/packages/fireplace-badge.svg

   :target: http://stable.melpa.org/#/fireplace

.. image:: https://img.shields.io/github/tag/johanvts/emacs-fireplace.svg

   :target: https://github.com/johanvts/emacs-fireplace/tags

.. image:: http://img.shields.io/:license-gpl3-blue.svg

   :target: http://www.gnu.org/licenses/gpl-3.0.html

.. |br| raw:: html

.. image:: https://raw.github.com/johanvts/emacs-fireplace/master/img/fireplace.gif

..

     A cozy fireplace for emacs.

Usage

-----

After you installed the `fireplace` package from `melpa `_

you can start the fire using ``M-x fireplace``.

The fireplace will try to fill the current window with a new buffer.

To put the fire out use ``M-x fireplace-off`` or hotkey ``q``.

========================= ================================

Key bind                  Function

========================= ================================

``C-+``                   Move fire up

``C--``                   Move fire down

``C-*``                   Toggle smoke

``C-=``                   Toggle sound (requires ffplay)

``q``                     Turn off fire

========================= ================================

Use ``M-x customize-group RET fireplace RET`` to view and change the user defined variables and read their documentation.

Configuration

-------------

You can tweak the setting of ``fireplace`` the way you please with the ``customize-group``

``fireplace`` and ``fireplace-faces``.

Among the options, the name of the buffer, the frequency of refresh, the smoke char,

or the faces used in the fireplace.

Manual Installation

-------------------

If you don't want to use melpa to install this package, follow these steps:

Download ``fireplace.el`` and place it somewhere in your ``.emacs.d`` directory, say in ``.emacs.d/fireplace/``.

Compile the file using ``M-x byte-compile-file``.

Put ``(load "~/.emacs.d/fireplace/fireplace")`` in your init file (``.emacs``).

Note that there is a significant performance difference between the compiled and non-compiled fireplace.

Acknowledgment

--------------

A big thanks to Dan Torop for his `emacs animation guide

`_ and Vasilij Schneidermann for the `xbm-life `_ package.

The code relies heavily on these two sources.

Contribution

------------

Please feel free to do whatever you want with this code.

Ideas and pull requests are very welcome. I can be reached through [email protected]

or on twitter @johanvts.

To-Do

-----

- Better status bar