{"id":18605595,"url":"https://github.com/lolcommits/lolcommits-loltext","last_synced_at":"2025-04-10T20:31:04.907Z","repository":{"id":56882189,"uuid":"88295408","full_name":"lolcommits/lolcommits-loltext","owner":"lolcommits","description":"Lolcommits commit message annotation plugin","archived":false,"fork":false,"pushed_at":"2021-03-03T23:27:29.000Z","size":340,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-04-26T22:23:11.873Z","etag":null,"topics":["fun","git","git-addons","humours","lolcommits","lolcommits-plugin","ruby","selfie","webcam"],"latest_commit_sha":null,"homepage":"https://lolcommits.github.io","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lolcommits.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-04-14T19:09:52.000Z","updated_at":"2021-03-03T23:27:31.000Z","dependencies_parsed_at":"2022-08-20T23:10:43.284Z","dependency_job_id":null,"html_url":"https://github.com/lolcommits/lolcommits-loltext","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lolcommits%2Flolcommits-loltext","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lolcommits%2Flolcommits-loltext/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lolcommits%2Flolcommits-loltext/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lolcommits%2Flolcommits-loltext/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lolcommits","download_url":"https://codeload.github.com/lolcommits/lolcommits-loltext/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248290017,"owners_count":21078923,"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":["fun","git","git-addons","humours","lolcommits","lolcommits-plugin","ruby","selfie","webcam"],"created_at":"2024-11-07T02:22:13.344Z","updated_at":"2025-04-10T20:31:04.887Z","avatar_url":"https://github.com/lolcommits.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Lolcommits Loltext\n\n[![CI](https://img.shields.io/github/actions/workflow/status/lolcommits/lolcommits-loltext/ci.yml?branch=main\u0026style=flat\u0026label=CI)](https://github.com/lolcommits/lolcommits-loltext/actions/workflows/ci.yml)\n[![Gem](https://img.shields.io/gem/v/lolcommits-loltext.svg?style=flat)](http://rubygems.org/gems/lolcommits-loltext)\n[![Depfu](https://img.shields.io/depfu/lolcommits/lolcommits-loltext.svg?style=flat)](https://depfu.com/github/lolcommits/lolcommits-loltext)\n\n[lolcommits](https://lolcommits.github.io/) takes a snapshot with your\nwebcam every time you git commit code, and archives a lolcat style image\nwith it. Git blame has never been so much fun!\n\nThis plugin annotates each lolcommit with the commit message and sha text. You\ncan style and position these however you like, or add a transparent overlay\ncolor that covers the entire image.\n\nBy default your lolcommit will look something like this (maybe without the\nhorse):\n\n![horse\ncommit](https://github.com/lolcommits/lolcommits-loltext/blob/main/assets/images/horse.jpg)\n\nYou can easily change the plugin options to achieve something like this:\n\n![hipster\ncommit](https://github.com/lolcommits/lolcommits-loltext/blob/main/assets/images/hipster.jpg)\n\nSee [below](https://github.com/lolcommits/lolcommits-loltext#configuration) for\nmore information on the options available.\n\n## Requirements\n\n* Ruby \u003e= 3.1\n* A webcam\n* [ImageMagick](http://www.imagemagick.org)\n* [ffmpeg](https://www.ffmpeg.org) (optional) for animated gif capturing\n\n## Installation\n\nBy default, this plugin is automatically included with the main lolcommits gem.\nIf you have uninstalled this gem, install it again with:\n\n    $ gem install lolcommits-loltext\n\nThat's it! Every lolcommit will now be stamped with your commit message and sha.\nThis plugin is enabled by default (if no configuration for it exists). To\ndisable (so no text or overlay is applied) use:\n\n    $ lolcommits --config -p loltext\n    # and set enabled to `false`\n\n### Configuration\n\nConfigure this plugin with:\n\n    $ lolcommits --config -p loltext\n    # set enabled to `true` (then set your own options or choose the defaults)\n\nThe following options are available:\n\n* text color\n* text font\n* text position\n* uppercase text?\n* size (point size for the font)\n* stroke color (font outline color, or none)\n* transparent overlay (cover lolcommit with a random background color)\n* transparent overlay % (sets the fill colorize strength)\n\nPlease note that:\n\n* The message and sha text can have different text options\n* Any blank options will use the default (indicated when prompted for an option)\n* Always use the full absolute path to font files\n* Valid text positions are NE, NW, SE, SW, S, C (centered)\n* Colors can be hex values (#FC0) or strings (white, red etc.)\n* You can set one or more `overlay_colors` to pick from, separated with commas\n\nWith these options it is possible to create your own unique lolcommit format.\nTo achieve these '[hipster\nstyled](https://twitter.com/matthutchin/status/738411190343368704)' 🕶 commits,\ntry the following:\n\n```\nloltext:\n  :enabled: true\n  :message:\n    :color: white\n    :font: \"/Users/matt/Library/Fonts/Raleway-Light.ttf\"\n    :position: C\n    :size: 30\n    :stroke_color: none\n    :uppercase: true\n  :sha:\n    :color: white\n    :font: \"/Users/matt/Library/Fonts/Raleway-Light.ttf\"\n    :position: S\n    :size: 20\n    :stroke_color: none\n    :uppercase: false\n  :overlay:\n    :enabled: true\n  :border:\n    :enabled: false\n```\n\n**NOTE**: you can grab the '_Raleway-Light_' font for free from\n[fontsquirrel](https://www.fontsquirrel.com/fonts/Raleway).\n\n## Development\n\nCheck out this repo and run `bin/setup`, to install all dependencies and\ngenerate docs. Run `bundle exec rake` to run all tests.\n\nYou can also run `bin/console` for an interactive prompt that will allow you to\nexperiment with the gem code.\n\n## Tests\n\nMiniTest is used for testing. Run the test suite with:\n\n    $ rake test\n\n## Docs\n\nGenerate docs for this gem with:\n\n    $ rake rdoc\n\n## Troubles?\n\nIf you think something is broken or missing, please raise a new\n[issue](https://github.com/lolcommits/lolcommits-loltext/issues). Take a moment\nto check it hasn't been raised in the past (and possibly closed).\n\n## Contributing\n\nBug [reports](https://github.com/lolcommits/lolcommits-loltext/issues) and [pull\nrequests](https://github.com/lolcommits/lolcommits-loltext/pulls) are welcome on\nGitHub.\n\nWhen submitting pull requests, remember to add tests covering any new behaviour,\nand ensure all tests are passing. Read the [contributing\nguidelines](https://github.com/lolcommits/lolcommits-loltext/blob/master/CONTRIBUTING.md)\nfor more details.\n\nThis project is intended to be a safe, welcoming space for collaboration, and\ncontributors are expected to adhere to the [Contributor\nCovenant](http://contributor-covenant.org) code of conduct.  See\n[here](https://github.com/lolcommits/lolcommits-loltext/blob/master/CODE_OF_CONDUCT.md)\nfor more details.\n\n## License\n\nThe gem is available as open source under the terms of\n[LGPL-3](https://opensource.org/licenses/LGPL-3.0).\n\n## Links\n\n* [CI](https://github.com/lolcommits/lolcommits-loltext/actions/workflows/ci.yml)\n* [RDoc](https://rubydoc.info/gems/lolcommits-loltext)\n* [Issues](http://github.com/lolcommits/lolcommits-loltext/issues)\n* [Report a bug](http://github.com/lolcommits/lolcommits-loltext/issues/new)\n* [Gem](http://rubygems.org/gems/lolcommits-loltext)\n* [GitHub](https://github.com/lolcommits/lolcommits-loltext)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flolcommits%2Flolcommits-loltext","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flolcommits%2Flolcommits-loltext","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flolcommits%2Flolcommits-loltext/lists"}