{"id":13725953,"url":"https://github.com/rickgbw/hyperterm-overlay","last_synced_at":"2025-05-07T21:30:45.336Z","repository":{"id":10037964,"uuid":"64175007","full_name":"rickgbw/hyperterm-overlay","owner":"rickgbw","description":"A complete and customizable solution for a overlay window in your Hyper.app","archived":false,"fork":false,"pushed_at":"2022-05-20T16:05:29.000Z","size":26,"stargazers_count":131,"open_issues_count":24,"forks_count":20,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-10-14T02:49:27.484Z","etag":null,"topics":["hyper","hyperterm","terminal"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/rickgbw.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":"2016-07-25T23:40:51.000Z","updated_at":"2023-10-27T06:50:49.000Z","dependencies_parsed_at":"2022-08-09T03:30:16.770Z","dependency_job_id":null,"html_url":"https://github.com/rickgbw/hyperterm-overlay","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rickgbw%2Fhyperterm-overlay","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rickgbw%2Fhyperterm-overlay/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rickgbw%2Fhyperterm-overlay/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rickgbw%2Fhyperterm-overlay/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rickgbw","download_url":"https://codeload.github.com/rickgbw/hyperterm-overlay/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224654029,"owners_count":17347656,"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":["hyper","hyperterm","terminal"],"created_at":"2024-08-03T01:02:42.821Z","updated_at":"2024-11-14T16:33:00.512Z","avatar_url":"https://github.com/rickgbw.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# HyperTerm Overlay\n\nA complete and customizable solution for a permanent / dropdown / hotkey / overlay window in your Hyper.app, accessible via hotkeys and/or toolbar icon (tray).\n\n**Important:** Designed for Hyper.app \u003e= 0.7.0\n\n![home2](https://cloud.githubusercontent.com/assets/924158/17121698/d122bcaa-52ab-11e6-876c-25a267d00e89.gif)\n\n## Install\n\nEdit your `~/.hyper.js` (`Cmd+,`) and insert the `hyperterm-overlay` in your `plugins` array:\n```js\nplugins: [\n  'hyperterm-overlay'\n],\n```\n\n## Configuration\n\nAdd `overlay` in your `~/.hyper.js` config.\nThe configuration below shows all possibilities with their respective default values.\n\n```js\nmodule.exports = {\n  config: {\n    // other configs...\n    overlay: {\n      alwaysOnTop: true,\n      animate: true,\n      hasShadow: false,\n      hideDock: false,\n      hideOnBlur: false,\n      hotkeys: ['Option+Space'],\n      position: 'top',\n      primaryDisplay: false,\n      resizable: true,\n      startAlone: false,\n      startup: false,\n      size: 0.4,\n      tray: true,\n      unique: false\n    }\n  },\n  //...\n};\n```\n\n### alwaysOnTop\n- Value: true or false\n- Default: true\n- Makes Hyperterm Overlay window stay always on top.\n\n### animate\n- Value: true or false\n- Default: true\n- Enable animation when show and hide the window.\n\n### hasShadow\n- Value: true or false\n- Default: false\n- Controls the default macOS window shadows.\n\n### hideOnBlur\n- Value: true or false\n- Default: false\n- Hides the HyperTerm Overlay when it loses focus.\n\n### hideDock\n- Value: true or false\n- Default: false\n- Removes the HyperTerm dock icon. It works only when the `unique` option is activated.\n\n### hotkeys\n- Value: array of hotkey strings\n- Default: ['Option+Space']\n- Specify one or more hotkeys to show and hide the HyperTerm Overlay (see: [`Accelerator`](https://github.com/electron/electron/blob/master/docs/api/accelerator.md))\n\n### position\n- Value: 'top', 'bottom', 'left' or 'right'\n- Default: 'top'\n- Choose where HyperTerm Overlay will be positioned: `top`, `bottom`, `left` or `right`.\n\n### primaryDisplay\n- Value: true or false\n- Default: false\n- Show HyperTerm Overlay only on primary display.\n\n### resizable\n- Value: true or false\n- Default: true\n- Allow the HyperTerm Overlay be resizable.\n\n![resize](https://cloud.githubusercontent.com/assets/924158/17121469/5281a916-52aa-11e6-92f5-fa1c3dff75c8.gif)\n\n### size\n- Value: float or number\n- Default: 0.4\n- The size of HyperTerm Overlay when it is showing.\n The possible values are a `number` or a `float`.\n If is a number, it represents the size um pixels.\n Else, if is a float, it means the percentage of the screen.\n\n### startAlone\n- Value: true or false\n- Default: false\n- Makes HyperTerm Overlay the unique window displayed when started.\n- Other windows started will be default Hyper.app windows.\n\n### startup\n- Value: true or false\n- Default: true\n- Open HyperTerm Overlay on Hyper.app startup.\n\n### tray\n- Value: true or false\n- Default: true\n- Add icon to the system notification area, for access HyperTerm Overlay.\n\n![tray](https://cloud.githubusercontent.com/assets/924158/17121470/5294b02e-52aa-11e6-9bca-9d70f186c60b.gif)\n\n### unique\n- Value: true or false\n- Default: false\n- Makes HyperTerm Overlay the unique window of Hyper.app. Any other window will be removed.\n\n## Licence\n\n[MIT](LICENSE.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frickgbw%2Fhyperterm-overlay","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frickgbw%2Fhyperterm-overlay","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frickgbw%2Fhyperterm-overlay/lists"}