{"id":13592883,"url":"https://github.com/johanvts/emacs-fireplace","last_synced_at":"2025-04-09T02:31:39.359Z","repository":{"id":48558670,"uuid":"48233764","full_name":"johanvts/emacs-fireplace","owner":"johanvts","description":"A cozy fireplace for emacs.","archived":false,"fork":false,"pushed_at":"2021-07-20T17:08:15.000Z","size":541,"stargazers_count":732,"open_issues_count":6,"forks_count":21,"subscribers_count":16,"default_branch":"master","last_synced_at":"2024-11-06T14:40:46.104Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Emacs Lisp","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/johanvts.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-12-18T12:17:36.000Z","updated_at":"2024-11-04T19:33:28.000Z","dependencies_parsed_at":"2022-08-27T21:20:14.814Z","dependency_job_id":null,"html_url":"https://github.com/johanvts/emacs-fireplace","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johanvts%2Femacs-fireplace","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johanvts%2Femacs-fireplace/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johanvts%2Femacs-fireplace/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johanvts%2Femacs-fireplace/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/johanvts","download_url":"https://codeload.github.com/johanvts/emacs-fireplace/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247965552,"owners_count":21025397,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T16:01:14.289Z","updated_at":"2025-04-09T02:31:34.329Z","avatar_url":"https://github.com/johanvts.png","language":"Emacs Lisp","funding_links":[],"categories":["Emacs Lisp"],"sub_categories":[],"readme":"emacs-fireplace\n================\n\n.. image:: https://api.travis-ci.org/johanvts/emacs-fireplace.svg\n   :target: https://travis-ci.org/johanvts/emacs-fireplace\n.. image:: https://coveralls.io/repos/johanvts/emacs-fireplace/badge.svg\n   :target: https://coveralls.io/r/johanvts/emacs-fireplace\n.. image:: http://melpa.org/packages/fireplace-badge.svg\n   :target: http://melpa.org/#/fireplace\n.. image:: http://stable.melpa.org/packages/fireplace-badge.svg\n   :target: http://stable.melpa.org/#/fireplace\n.. image:: https://img.shields.io/github/tag/johanvts/emacs-fireplace.svg\n   :target: https://github.com/johanvts/emacs-fireplace/tags\n.. image:: http://img.shields.io/:license-gpl3-blue.svg\n   :target: http://www.gnu.org/licenses/gpl-3.0.html\n\n.. |br| raw:: html\n\n.. image:: https://raw.github.com/johanvts/emacs-fireplace/master/img/fireplace.gif\n\n..\n\n     A cozy fireplace for emacs.\n\nUsage\n-----\n\nAfter you installed the `fireplace` package from `melpa \u003chttp://melpa.org/#/\u003e`_\nyou can start the fire using ``M-x fireplace``.\n\n\nThe fireplace will try to fill the current window with a new buffer.\nTo put the fire out use ``M-x fireplace-off`` or hotkey ``q``.\n\n\n========================= ================================\nKey bind                  Function\n========================= ================================\n``C-+``                   Move fire up\n``C--``                   Move fire down\n``C-*``                   Toggle smoke\n``C-=``                   Toggle sound (requires ffplay)\n``q``                     Turn off fire\n========================= ================================\n\nUse ``M-x customize-group RET fireplace RET`` to view and change the user defined variables and read their documentation.\n\nConfiguration\n-------------\n\nYou can tweak the setting of ``fireplace`` the way you please with the ``customize-group``\n``fireplace`` and ``fireplace-faces``.\n\nAmong the options, the name of the buffer, the frequency of refresh, the smoke char,\nor the faces used in the fireplace.\n\nManual Installation\n-------------------\n\nIf you don't want to use melpa to install this package, follow these steps:\n\nDownload ``fireplace.el`` and place it somewhere in your ``.emacs.d`` directory, say in ``.emacs.d/fireplace/``.\nCompile the file using ``M-x byte-compile-file``.\nPut ``(load \"~/.emacs.d/fireplace/fireplace\")`` in your init file (``.emacs``).\n\nNote that there is a significant performance difference between the compiled and non-compiled fireplace.\n\nAcknowledgment\n--------------\n\nA big thanks to Dan Torop for his `emacs animation guide\n\u003chttp://dantorop.info/project/emacs-animation/\u003e`_ and Vasilij Schneidermann for the `xbm-life \u003chttps://github.com/wasamasa/xbm-life\u003e`_ package.\nThe code relies heavily on these two sources.\n\nContribution\n------------\n\nPlease feel free to do whatever you want with this code.\n\nIdeas and pull requests are very welcome. I can be reached through johanvts@gmail.com\nor on twitter @johanvts.\n\n\nTo-Do\n-----\n- Better status bar\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohanvts%2Femacs-fireplace","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjohanvts%2Femacs-fireplace","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohanvts%2Femacs-fireplace/lists"}