{"id":13830119,"url":"https://github.com/kevinatown/MMM-Screencast","last_synced_at":"2025-07-09T11:32:08.573Z","repository":{"id":24328925,"uuid":"100056729","full_name":"kevinatown/MMM-Screencast","owner":"kevinatown","description":"A module to cast to the magic mirror","archived":false,"fork":false,"pushed_at":"2024-12-07T20:01:00.000Z","size":2104,"stargazers_count":166,"open_issues_count":55,"forks_count":34,"subscribers_count":11,"default_branch":"master","last_synced_at":"2024-12-07T21:16:55.529Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/kevinatown.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":"2017-08-11T17:40:45.000Z","updated_at":"2024-12-07T20:00:57.000Z","dependencies_parsed_at":"2024-01-15T17:38:58.712Z","dependency_job_id":"c1fb60c2-3033-4edc-80ca-7d3241125652","html_url":"https://github.com/kevinatown/MMM-Screencast","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/kevinatown/MMM-Screencast","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevinatown%2FMMM-Screencast","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevinatown%2FMMM-Screencast/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevinatown%2FMMM-Screencast/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevinatown%2FMMM-Screencast/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kevinatown","download_url":"https://codeload.github.com/kevinatown/MMM-Screencast/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevinatown%2FMMM-Screencast/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264450550,"owners_count":23610191,"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":[],"created_at":"2024-08-04T10:00:55.930Z","updated_at":"2025-07-09T11:32:07.958Z","avatar_url":"https://github.com/kevinatown.png","language":"JavaScript","funding_links":[],"categories":["Entertainment"],"sub_categories":[],"readme":"# MMM-Screencast\nA module to cast to the [MagicMirror²](https://github.com/MichMich/MagicMirror/). Currently, only YouTube casting is supported. Hopefully, I will have time to add more casting options.\n\n**NOTE: MMM-Screencast has been updated to deal with new support, please pull from master to ensure that you have the most up-to-date version. Thanks!**\n\n## Using the module\n\n* Navigate to the modules directory via the follow command: `cd MagicMirror/modules`\n* Clone the module from github: `git clone https://github.com/kevinatown/MMM-Screencast.git`\n* Navigate to the MMM-Screencast directory: `cd MMM-Screencast`\n* Install the dependencies: `npm install`\n* Add the following configuration to the modules array in the `config/config.js` file:\n```js\nvar config = {\n    modules: [\n        {\n\t\tmodule: 'MMM-Screencast',\n\t\tposition: 'bottom_right', // This position is for a hidden \u003cdiv /\u003e and not the screencast window\n\t\tconfig: {\n\t\t\tposition: 'bottomRight',\n\t\t\theight: 300,\n\t\t\twidth: 500,\n\t\t}\n        }\n    ]\n}\n```\n\n## Configuration options for MMM-Screencast\n\n| Option    | Description\n|---------- |-----------\n| `position`| *Required* The position of the screencast window. \u003cbr\u003e**Options:** `['bottomRight', 'bottomCenter', 'bottomLeft', 'center',  'topRight', 'topCenter', 'topLeft']` \u003cbr\u003e**Type:** `string` \u003cbr\u003e**Note:** This module config actual sets the location, not the magic mirror position config. **NOTE**\n| `x`       | *Optional* (**required if y is used**) Window's left offset from screen. Takes precedence over `position`. \u003cbr\u003e**Type:** `number` (pixels)\n| `y`       | *Optional* (**required if x is used**) Window's left offset from screen. Takes precedence over `position`. \u003cbr\u003e**Type:** `number` (pixels)\n| `height`  | *Required* Height of the screencast window. \u003cbr\u003e**Type:** `number` (pixels)\n| `width`   | *Required* Width of the screencast window. \u003cbr\u003e**Type:** `number` (pixels)\n| `castName`| *Optional* The title to display in your device's cast list. \u003cbr\u003e**Type** `string` defalt `os.hostname`\n| `port`    | *Optional* A port to run the dialserver on **Type** `number` default `8569`\n| `useIPv6` | *Optional* Forces `http` to use the unassigned IPv6 address `::/0` **Type** `booelan` default `false`\n\n## Notifications\nMMM-Screencast can communicate with other modules through notifications.\n\n### Emmited Notifications\nThese notifications are emitted by MMM-Screencast.\n\n| Notification | Payload   | Description\n|------------- |-----------|------------\n| `MMM-Screencast:START-DIAL` | `{ port: \u003cORT_USED\u003e }`  | Emitted when the DIAL server is running and the port it can be found on. The cast icon should be visible in your app now.\n| `MMM-Screencast:LAUNCH-APP` | `{ app: \u003cAPP_NAME\u003e, state: \u003cAPP_STATE\u003e }` | Emitted when an app is intializing\n| `MMM-Screencast:RUN-APP` | `{ app: \u003cAPP_NAME\u003e, state: \u003cAPP_STATE\u003e }` | Emitted when the app is intialized and running\n| `MMM-Screencast:STOP-APP` | `{ app: \u003cAPP_NAME\u003e, state: \u003cAPP_STATE\u003e }` | Emitted when the app is stopped.\n| `MMM-Screencast:CONFIG-ERROR` | `{ message: \u003cMESSAGE_ABOUT_ERROR\u003e}` | Emitted when there is an issue with the config.\n\n### Listening Notifications\nThese are the notifications that can be sent to MMM-Screencast in order to control it in some way.\n\n| Notification | Expected Payload | Description\n|------------- |------------------|------------\n| `MMM-Screencast:CLOSE` | none | This informs MMM-Screencast to close the currently running app. \n\n\n## Screenshots\n\n\u003cp align=\"middle\"\u003e\n\u003cimg src=\"/screenshots/screenshot.png\" width=\"400\"\u003e\n\u003cimg src=\"/screenshots/screenshot1.png\" width=\"400\"\u003e\n\u003cimg src=\"/screenshots/screenshot2.jpg\" width=\"400\"\u003e\n\u003c/p\u003e\n\n## Special Thanks and Contributors!\n* [@Podgrade](https://github.com/Podgrade) - for the user agent fix\n* [@Poolitzer](https://github.com/Poolitzer) - for the screenshots\n* [@goldyfruit](https://github.com/goldyfruit) - for the autoclose PR\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkevinatown%2FMMM-Screencast","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkevinatown%2FMMM-Screencast","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkevinatown%2FMMM-Screencast/lists"}