{"id":13533125,"url":"https://github.com/marcinruszkiewicz/doomfire","last_synced_at":"2025-10-25T04:31:25.578Z","repository":{"id":53753930,"uuid":"188424058","full_name":"marcinruszkiewicz/doomfire","owner":"marcinruszkiewicz","description":"Puts your console on fire. Use a truecolor console for best effect.","archived":false,"fork":false,"pushed_at":"2023-02-17T12:12:39.000Z","size":582,"stargazers_count":16,"open_issues_count":2,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-03-14T16:48:10.492Z","etag":null,"topics":["fire","hacktoberfest","iterm2","ruby","sdl2","terminal"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/marcinruszkiewicz.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2019-05-24T13:11:44.000Z","updated_at":"2023-11-13T23:37:31.000Z","dependencies_parsed_at":"2024-01-14T02:20:57.902Z","dependency_job_id":"84ca6275-ed51-4ee5-91b3-660afe2b21c0","html_url":"https://github.com/marcinruszkiewicz/doomfire","commit_stats":{"total_commits":22,"total_committers":2,"mean_commits":11.0,"dds":"0.045454545454545414","last_synced_commit":"8a7251ee0188bba281474f22c425095d5c3a54b5"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcinruszkiewicz%2Fdoomfire","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcinruszkiewicz%2Fdoomfire/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcinruszkiewicz%2Fdoomfire/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcinruszkiewicz%2Fdoomfire/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/marcinruszkiewicz","download_url":"https://codeload.github.com/marcinruszkiewicz/doomfire/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":229767261,"owners_count":18121042,"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":["fire","hacktoberfest","iterm2","ruby","sdl2","terminal"],"created_at":"2024-08-01T07:01:16.777Z","updated_at":"2025-10-25T04:31:25.524Z","avatar_url":"https://github.com/marcinruszkiewicz.png","language":"Ruby","readme":"![Build Status](https://github.com/marcinruszkiewicz/doomfire/actions/workflows/rspec.yml/badge.svg)\n[![Gem Version](https://badge.fury.io/rb/doomfire.svg)](https://badge.fury.io/rb/doomfire)\n\n# Doomfire\n\nPut your terminal on fire.\n\n![terminal example](examples/terminal.png)\n\nThis gem implements the [Doom fire algorithm](https://fabiensanglard.net/doom_fire_psx/) in Ruby, because why not, and outputs it into the terminal. Right now it requires the terminal to be able to display 24-bit colors, so it will either not work at all or not work properly on terminals that can't do that, for example on MacOS's default `Terminal.app` - in which case you should probably install a better terminal application (like [iTerm](https://www.iterm2.com) or whatever else you like).\n\nYou can check the list of terminals supporting 24-bit color [here](https://github.com/termstandard/colors).\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'doomfire'\n```\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install doomfire\n\n## Usage\n\nThe most basic way to run this is to run it directly from the command line:\n\n    $ doomfire\n\nPressing `CTRL`-`C` will stop the program gracefully after a few extra frames to let it end nicely.\n\nAlternatively you can use it for amusement while running some long rake tasks.\n\n```ruby\nrequire 'doomfire'\n\ndesc 'some long running task'\ntask :long do\n  fire = Doomfire::Spinner.new\n  fire.run\n\n  5.times do\n    sleep 1\n  end\n\n  fire.stop\nend\n```\n\nThis will run the fire in a separate thread while your rake tasks works in the main thread, and at the end of the task it will gracefully extinguish the fire and clear the terminal.\n\n## SDL\n\nNow with actual pixel manipulation! You can set the output to use the SDL2 library, which will put the output in a graphical window. It's a bit restricted right now to a small window and sometimes blows up, so I consider it a bit of an experiment.\n\nYou need [libSDL2](http://www.libsdl.org/download-2.0.php) installed on your system (most likely through Homebrew, apt or whatever your system uses). The doomfire executable script will complain if you don't have it.\n\n    $ brew install sdl2\n\nThen you can run the executable:\n\n    $ doomfire --sdl\n\nAnd the output should be shown in a separate window. Closing the window will end the program after a few seconds of the ending animation.\n\n![SDL example](examples/sdl.png)\n\nIf running on a Ruby interpreter on the JVM, you will need the `-XstartOnFirstThread` option.\n\n## Benchmarks\n\n    $ bundle exec bench/micro.rb\n    $ bundle exec bench/macro.rb\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/marcinruszkiewicz/doomfire.\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n","funding_links":[],"categories":["Awesome Ruby CLIs"],"sub_categories":["Miscellaneous"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarcinruszkiewicz%2Fdoomfire","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarcinruszkiewicz%2Fdoomfire","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarcinruszkiewicz%2Fdoomfire/lists"}