{"id":17703423,"url":"https://github.com/randoragon/brbtimer","last_synced_at":"2025-03-31T04:11:52.900Z","repository":{"id":176069837,"uuid":"268042531","full_name":"randoragon/brbtimer","owner":"randoragon","description":"A tiny animation overlay for livestream \"be right back\" screens.","archived":false,"fork":false,"pushed_at":"2025-01-27T12:43:36.000Z","size":2246,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-06T08:45:00.407Z","etag":null,"topics":["allegro5","animated","chroma-key","obs-studio","timer-clock"],"latest_commit_sha":null,"homepage":"","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/randoragon.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-05-30T08:49:02.000Z","updated_at":"2025-01-27T12:43:39.000Z","dependencies_parsed_at":null,"dependency_job_id":"76ed3698-e6fa-4e61-83b1-09a4a90b22f2","html_url":"https://github.com/randoragon/brbtimer","commit_stats":null,"previous_names":["randoragon/brbtimer"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/randoragon%2Fbrbtimer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/randoragon%2Fbrbtimer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/randoragon%2Fbrbtimer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/randoragon%2Fbrbtimer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/randoragon","download_url":"https://codeload.github.com/randoragon/brbtimer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246413234,"owners_count":20773053,"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":["allegro5","animated","chroma-key","obs-studio","timer-clock"],"created_at":"2024-10-24T20:22:57.811Z","updated_at":"2025-03-31T04:11:52.863Z","avatar_url":"https://github.com/randoragon.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"# brbtimer - a simple livestreaming timer\n\nThis is a tiny utility program that allows setting a timer in seconds,\nand then visualizes the passage of time with a simple animation sequence.\n\nIts intended use is for livestreaming, in screencasting software like OBS\nyou can create a window capture and use chroma keys to isolate the animation\nfrom the contrasting background to have a nice overlay for your recording scene.\n\nI never intended to share this software, because I created it for myself,\nbut there's no harm sharing it in an open-source manner, is there?\n\n## Usage\n\n![preview](https://github.com/Randoragon/brbtimer/blob/master/preview.gif)\n\nbrbtimer needs to be invoked from a command line interface in order to work.\nYou pass the amount of time you want it to count down via command parameters.  \nThe quickest way to understand the syntax is with examples:\n\n```sh\nbrbtimer 10s    # sets timer to 10 seconds\nbrbtimer 3m     # sets timer to 3 minutes\nbrbtimer 5h     # sets timer to 5 hours\n```\n\nYou can pass as many options as you like, the sum will be calculated:\n\n```sh\nbrbtimer 1s 2s 3s 4s   # sets timer to 10 seconds\nbrbtimer 1h 5m 10s     # sets timer to 1 hour, 5 minutes and 10 seconds\nbrbtimer 2h 3m 1h 4m   # sets timer to 3 hours, 7 minutes\n```\n\nThe default time unit is seconds, so 's' can be omitted:\n\n```sh\nbrbtimer 5      # sets timer to 5 seconds\nbrbtimer 1m 2   # sets timer to 1 minute, 2 seconds\n```\n\nOnce the program has started, you will be required to press enter once to start the countdown.\nAlternatively, you can pass the ``-n`` or ``--noconfirm`` option to begin the countdown immediately.\nOnce the countdown has finished, pressing enter again will close the program. You may also terminate\nexecution at any time with ctrl+q.\n\n## Building from source (GNU/Linux)\n\n### Prerequisites\n\n- GNU GCC compiler\n- [Allegro 5](https://liballeg.org/)\n\n### Installation\n\nRun the following (if necessary, as root):\n\n```sh\nmake install\n```\n\nNote that the installation creates a symlink inside ``/usr/local/bin`` which points to the cloned ``brbtimer`` directory.\nThis is because the executable depends on the ``brbtimer/res`` directory's contents, so you can't just delete the\ndownloaded directory afterwards.  \nThe man page, **brbtimer(1)** will be installed to ``/usr/share/man/man1/brbtimer``.\n\nTo uninstall the program, run (if necessary, as root):\n\n```sh\nmake uninstall\n```\n\n## Other Platforms\n\nbrbtimer was built using the [Allegro 5](https://liballeg.org/) library, which is cross-platform.\nThat said, I've never tried compiling for other operating systems,\nso if you're a Windows, Mac or other user, the first step would probably be looking\ninside the Makefile and figuring out how to run the appropriate commands on your system.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frandoragon%2Fbrbtimer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frandoragon%2Fbrbtimer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frandoragon%2Fbrbtimer/lists"}