{"id":24558200,"url":"https://github.com/rse/analogclock","last_synced_at":"2025-04-19T09:59:05.681Z","repository":{"id":44246975,"uuid":"332547288","full_name":"rse/analogclock","owner":"rse","description":"Analog Clock","archived":false,"fork":false,"pushed_at":"2025-04-05T00:12:16.000Z","size":245,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-15T21:55:45.937Z","etag":null,"topics":["analog","clock","obs-studio","vmix"],"latest_commit_sha":null,"homepage":"https://rse.github.io/analogclock/","language":"JavaScript","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/rse.png","metadata":{"files":{"readme":"README.md","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":"2021-01-24T20:21:10.000Z","updated_at":"2025-04-05T00:12:20.000Z","dependencies_parsed_at":"2022-09-14T07:20:57.612Z","dependency_job_id":null,"html_url":"https://github.com/rse/analogclock","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rse%2Fanalogclock","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rse%2Fanalogclock/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rse%2Fanalogclock/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rse%2Fanalogclock/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rse","download_url":"https://codeload.github.com/rse/analogclock/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249161133,"owners_count":21222470,"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":["analog","clock","obs-studio","vmix"],"created_at":"2025-01-23T05:47:38.637Z","updated_at":"2025-04-19T09:59:05.663Z","avatar_url":"https://github.com/rse.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\nAnalogClock\n===========\n\n**Analog Clock for OBS Studio or vMix**\n\nAbstract\n--------\n\n**AnalogClock** is a plain HTML/CSS/JS Browser Source layer for [OBS\nStudio](http://obsproject.com/) or [vMix](https://www.vmix.com/) for\ndisplaying a classical analog clock based timer. This is usually used as\na count-down until an event starts or as a duration for a pause.\n\n![AnalogClock screenshot](screenshot.png)\n\nDemo\n----\n\nA centrally deployed version of **AnalogClock** is available under\nthe URL https://rse.github.io/analogclock/.\n\nRemote Use\n----------\n\n1. Add your *Browser Source* source to *OBS Studio*:\n\n   - Local File: **(disabled)**\n   - URL: `https://rse.github.io/analogclock/?`*options*\n   - Width: **1920** (or whatever is your stream resolution width)\n   - Height: **1080** (or whatever is your stream resolution height)\n   - Use custom frame rate: **(disabled)**\n   - Control audio via OBS: **(disabled)**\n   - Custom CSS: **(empty)**\n   - Shutdown source when not visible: **(enabled)**\n   - Refresh browser when scene becomes active: **(enabled)**\n\n   Or add your *Web Browser* input to *vMix*:\n\n   - URL: `https://rse.github.io/analogclock/?`*options*\n   - Width: **1920** (or whatever is your stream resolution width)\n   - Height: **1080** (or whatever is your stream resolution height)\n\nLocal Use\n---------\n\n1. Install [Node.js](https://nodejs.org/) and [Git](https://git-scm.com/).\n\n2. Clone the **AnalogClock** sources:\u003cbr/\u003e\n   `git clone --depth 1 https://github.com/rse/analogclock`\u003cbr/\u003e\n   `cd analogclock`\u003cbr/\u003e\n\n3. Download all dependencies:\u003cbr/\u003e\n   `$ npm install`\n\n4. Add your *Browser Source* source to *OBS Studio*:\n\n   - Local File: **(disabled)**\n   - URL: *local-path*`/analogclock/index.html?`*options*\n   - Width: **1920** (or whatever is your stream resolution width)\n   - Height: **1080** (or whatever is your stream resolution height)\n   - Use custom frame rate: **(disabled)**\n   - Control audio via OBS: **(disabled)**\n   - Custom CSS: **(empty)**\n   - Shutdown source when not visible: **(enabled)**\n   - Refresh browser when scene becomes active: **(enabled)**\n\n   Or add your *Web Browser* input to *vMix*:\n\n   - URL: `file://`*local-path*`/analogclock/index.html?`*options*\n   - Width: **1920** (or whatever is your stream resolution width)\n   - Height: **1080** (or whatever is your stream resolution height)\n\nOptions\n-------\n\n### Time Options\n\n- **until**=*iso-time* (duration for segment display until time in ISO format `YYYY-MM-DDTHH:MM:SS`, default: none)\n- **duration**=*minutes* (duration for segment display in 1-60 minutes, default: none)\n- **fraction**=*minutes* (fraction in minutes to round up duration, default: none)\n- **autostop** (whether to automatically stop clock when timer ended, default: none)\n\nHint: if either option `duration` or `until` are given, the clock with\nshow a done/todo-segment and automatically shuts down once the ending\ntime is reached.\n\n### Size Options\n\n- **size**=*size* (width/height of clock in pixels or percentage, default: `100%`)\n- **opacity**=*number* (amount of opacity of clock in 0.0-1.0 range, default: `1.0`)\n\n### Color Options\n\n- **background0**=*color* (canvas background color, default: `transparent`)\n- **background1**=*color* (outer border color, default: `#555555`)\n- **background2**=*color* (inner background color, default: `#f0f0f0`)\n- **background3**=*color* (soft attention overlay color, default: `#ffcc66`)\n- **background4**=*color* (hard attention overlay color, default: `#ff6666`)\n- **ticks**=*color* (color of ticks, default: `#333333`)\n- **digits**=*color* (color of digits, default: `#666666`)\n- **pointer1**=*color* (color of hour pointer, default: `#000000`)\n- **pointer2**=*color* (color of minute pointer, default: `#222222`)\n- **pointer3**=*color* (color of second pointer, default: `#cc0000`)\n- **segment1**=*color* (outer color of done segment display, default: `#b06820`)\n- **segment2**=*color* (inner color of done segment display, default: `#f4dbc2`)\n- **segment3**=*color* (outer color of todo segment display, default: `#2068b0`)\n- **segment4**=*color* (inner color of todo segment display, default: `#c2dbf4`)\n- **segment5**=*color* (outer color of overrun segment display, default: `#c03000`)\n- **segment6**=*color* (inner color of overrun segment display, default: `#ff6030`)\n\n### Hint Options\n\n- **lang**=*iso-cc* (language as ISO country-code for voice messages, default: `en`)\n- **overrun** (whether to draw overrun segment, default: false)\n- **silent** (whether to avoid any voice messages or sounds, default: false)\n- **moving** (whether to move/fly in clock initially, default: true)\n\nControl\n-------\n\nFor interactively controlling **AnalogClock** press:\n\n- duration-based timer of (*N* x 10) + *M* minutes:\u003cbr/\u003e\n  \u003ckbd\u003ed\u003c/kbd\u003e \u003ckbd\u003e*N*\u003c/kbd\u003e \u003ckbd\u003e*M*\u003c/kbd\u003e (*N* = `0` ... `5`, *M* = `0` ... `9`)\n- until-based timer to (*N* x 10) + *M* minute:\u003cbr/\u003e\n  \u003ckbd\u003eu\u003c/kbd\u003e \u003ckbd\u003e*N*\u003c/kbd\u003e \u003ckbd\u003e*M*\u003c/kbd\u003e (*N* = `0` ... `5`, *M* = `0` ... `9`)\n- termination of timer:\u003cbr/\u003e\n  \u003ckbd\u003ex\u003c/kbd\u003e\n- manual attention via *N* times clock flashing:\u003cbr/\u003e\n  \u003ckbd\u003ea\u003c/kbd\u003e \u003ckbd\u003e*N*\u003c/kbd\u003e \u003ckbd\u003es\u003c/kbd\u003e (*N* = `1` ... `9`, soft/orange) or\u003cbr/\u003e\n  \u003ckbd\u003ea\u003c/kbd\u003e \u003ckbd\u003e*N*\u003c/kbd\u003e \u003ckbd\u003eh\u003c/kbd\u003e (*N* = `1` ... `9`, hard/red)\n- manual voice hints:\u003cbr/\u003e\n  \u003ckbd\u003eh\u003c/kbd\u003e \u003ckbd\u003es\u003c/kbd\u003e (slower)\u003cbr/\u003e\n  \u003ckbd\u003eh\u003c/kbd\u003e \u003ckbd\u003ef\u003c/kbd\u003e (faster)\u003cbr/\u003e\n  \u003ckbd\u003eh\u003c/kbd\u003e \u003ckbd\u003em\u003c/kbd\u003e (message)\n\nHUDS\n----\n\nAlternatively, instead of running **AnalogClock** as a standalone\napplication, it can also be run on top of [Head-Up-Display Server\n(HUDS)](https://github.com/rse/huds). The advantage is that instead\nof having to interactively control **AnalogClock**, it can be remote\ncontrolled through HTTP and MQTT.\n\nFor this, run HUDS with **AnalogClock** with:\n\n```sh\nnpx huds -a 0.0.0.0 -p 9999 -d analogclock:index-huds.html,index-huds.yaml\n```\n\nAnd then use the following URL for rending **AnalogClock** in OBS Studio or vMix:\n\n`https://localhost:9999/analogclock/`\n\nFinally, use the following URLs with HTTP `GET` requests for remote\ncontrolling **AnalogClock** from e.g. Stream Deck, Companion,\nCentralControl or ShowCockpit:\n\n- `https://localhost:9999/analogclock/event/duration.`*N* (*N* = `0`...`59`)\n- `https://localhost:9999/analogclock/event/until.`*N* (*N* = `0`...`59`)\n- `https://localhost:9999/analogclock/event/attention.`*N*`.`*type* (*N* = `1`...`9`, *type* = `soft` or `hard`)\n- `https://localhost:9999/analogclock/event/terminate`\n- `https://localhost:9999/analogclock/event/hint.slower`\n- `https://localhost:9999/analogclock/event/hint.faster`\n- `https://localhost:9999/analogclock/event/hint.message`\n\nLicense\n-------\n\nCopyright (c) 2021-2024 Dr. Ralf S. Engelschall (http://engelschall.com/)\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n\"Software\"), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be included\nin all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\nIN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\nCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\nTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frse%2Fanalogclock","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frse%2Fanalogclock","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frse%2Fanalogclock/lists"}