{"id":14990197,"url":"https://github.com/ividjs/ivid","last_synced_at":"2025-05-07T17:43:00.443Z","repository":{"id":57119685,"uuid":"163910997","full_name":"ividjs/ivid","owner":"ividjs","description":"interactive video player – \"cyoa\" like Netflix's Bandersnatch","archived":false,"fork":false,"pushed_at":"2021-12-21T02:36:12.000Z","size":91,"stargazers_count":134,"open_issues_count":1,"forks_count":11,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-02-19T02:12:05.692Z","etag":null,"topics":["bandersnatch","choose-your-own-adventure","cyoa","interactive","netflix","player","vanilla","video","webcomponent"],"latest_commit_sha":null,"homepage":"https://ividjs.github.io/ivid/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ividjs.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}},"created_at":"2019-01-03T02:02:29.000Z","updated_at":"2024-10-08T14:18:29.000Z","dependencies_parsed_at":"2022-08-23T21:10:16.116Z","dependency_job_id":null,"html_url":"https://github.com/ividjs/ivid","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ividjs%2Fivid","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ividjs%2Fivid/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ividjs%2Fivid/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ividjs%2Fivid/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ividjs","download_url":"https://codeload.github.com/ividjs/ivid/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240783138,"owners_count":19856780,"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":["bandersnatch","choose-your-own-adventure","cyoa","interactive","netflix","player","vanilla","video","webcomponent"],"created_at":"2024-09-24T14:19:41.645Z","updated_at":"2025-02-26T03:15:41.881Z","avatar_url":"https://github.com/ividjs.png","language":"JavaScript","funding_links":["https://www.patreon.com/bePatron?u=10700791"],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\r\n  \u003cimg width=\"180\" src=\"https://raw.githubusercontent.com/ividjs/ivid-assets/master/ivid.svg\" alt=\"ivid-logo\"\u003e\r\n\u003c/p\u003e\r\n\u003ch1 align=\"center\"\u003eIVID\u003c/h1\u003e\r\n\u003cp align=\"center\"\u003e\u003c \u003cb\u003ei\u003c/b\u003enteractive \u003cb\u003evid\u003c/b\u003eeo player \u003e\u003c/p\u003e\r\n\r\n\u003c/br\u003e\r\n\r\n\u003cp align=\"center\"\u003e\r\n  \u003ca href=\"https://www.npmjs.com/package/@ividjs/ivid\" title=\"npm published\"\u003e\r\n    \u003cimg src=\"https://img.shields.io/badge/published-CB3837.svg?style=for-the-badge\u0026logo=npm\u0026longCache=true\" alt=\"npm-published\" style=\"max-width:100%;\"\u003e\r\n  \u003c/a\u003e\r\n  \u003cimg src=\"https://img.shields.io/badge/vanilla-black.svg?style=for-the-badge\u0026logo=javascript\u0026longCache=true\" alt=\"vanillajs\" style=\"max-width:100%;\"\u003e\r\n  \u003ca href=\"https://www.webcomponents.org/element/@ividjs/ivid\" title=\"webcomponents.org published\"\u003e\r\n    \u003cimg src=\"https://img.shields.io/badge/published-288fcd.svg?style=for-the-badge\u0026logo=webcomponents.org\u0026logoColor=white\u0026longCache=true\" alt=\"webcomponents-publised\" style=\"max-width:100%;\"\u003e\r\n  \u003c/a\u003e\r\n\u003c/p\u003e\r\n\r\n\u003cp align=\"center\"\u003e\r\n  \u003ca href=\"https://github.com/ividjs/ivid/blob/master/LICENSE\"\u003e\r\n    \u003cimg src=\"https://img.shields.io/badge/Apache--2.0-51b9c7.svg?longCache=true\" alt=\"license-apache-2\"\u003e\r\n  \u003c/a\u003e\r\n  \u003ca href=\"https://www.patreon.com/bePatron?u=10700791\"\u003e\r\n    \u003cimg src=\"https://img.shields.io/badge/%E2%9D%A4%EF%B8%8Fdonate-ec2f10.svg?longCache=true\" alt=\"donate\"\u003e\r\n  \u003c/a\u003e\r\n\u003c/p\u003e\r\n\r\n\u003c/br\u003e\r\n\r\n## About\r\n\r\nIVID is an interactive video player for modern browsers.\r\n\r\nFull VanillaJS webcomponent. Plug-n-play ready, easy setup and use.\r\n\r\n[Try it online](https://ividjs.github.io/ivid).\r\n\r\n\u003c/br\u003e\r\n\r\n## How to use it\r\n\r\n```html\r\n\u003c!doctype html\u003e\r\n\u003chtml\u003e\r\n  \u003chead\u003e\r\n    \u003cscript src=\"//unpkg.com/@ividjs/ivid@latest/dist/ivid.min.js\" type=\"module\" async\u003e\u003c/script\u003e\r\n    \u003c!-- Optional Styles --\u003e\r\n    \u003clink href=\"//unpkg.com/@ividjs/ivid@latest/dist/ivid.min.css\" rel=\"stylesheet\"\u003e\r\n    \u003clink href=\"//fonts.googleapis.com/icon?family=Material+Icons\" rel=\"stylesheet\"\u003e\r\n\r\n    \u003cscript async\u003e\r\n      let model = { ... }; // Setup the video-map model\r\n      document.getElementById(\"sample\").setAttribute(\"model\", JSON.stringify(model));\r\n    \u003c/script\u003e\r\n  \u003c/head\u003e\r\n\r\n  \u003cbody\u003e\r\n    \u003ci-video id=\"sample\" controls autoplay playsinline\u003e\u003c/i-video\u003e\r\n  \u003c/body\u003e\r\n\u003c/html\u003e\r\n```\r\n*Also see: [IVID-model][1] and [IVID-styles][2] documentation*\r\n\r\n\u003c/br\u003e\r\n\r\n## Features\r\n\r\n- Next video selection (the interactive bit)\r\n- Simple single-setup: [ivid-model][1]\r\n- Inherited HTML5 video properties\r\n- Full video controls on-screen\r\n- Customizable controls: [ivid-styles][2]\r\n- Key-mapping for keyboard video controls\r\n  - Play/Pause: `spacebar`\r\n  - Mute/Unmute: `m`\r\n  - Fullscreen toggle: `f`\r\n  - Volume up/down: `arrow_up` / `awrrow_down`\r\n  - Forward/backward: `arrow_right` / `arrow_left`\r\n\r\n*Please take a look at the current [TODO][3] list, any contribution is welcome*\r\n\r\n\u003c/br\u003e\r\n\r\n## Development setup\r\n\r\nClone ivid\r\n```bash\r\ngit clone git@github.com:ividjs/ivid.git\r\n```\r\n\r\nInstall development dependencies\r\n```bash\r\nnpm i # or yarn\r\n```\r\n\r\nRun development server\r\n```bash\r\nnpm run dev\r\n```\r\n\r\nOpen browser on `localhost:3000`, the sandbox should be ready to play\r\n\r\n\u003c/br\u003e\r\n\r\n## Screenshots\r\n\r\n**player controls**\r\n\r\n\u003cimg style=\"border-radius: 5px\" src=\"https://raw.githubusercontent.com/ividjs/ivid-assets/master/ivid_mug.png\"\u003e\r\n\r\n\r\n**choices controls**\r\n\r\n\u003cimg style=\"border-radius: 5px\" src=\"https://raw.githubusercontent.com/ividjs/ivid-assets/master/ivid_mug2.png\"\u003e\r\n\r\n\r\n\u003c!-- LINKS --\u003e\r\n[1]: https://github.com/ividjs/ivid/blob/master/docs/ivid-model.md\r\n[2]: https://github.com/ividjs/ivid/blob/master/docs/ivid-styles.md \r\n[3]: https://github.com/ividjs/ivid/blob/master/docs/TODO.md\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fividjs%2Fivid","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fividjs%2Fivid","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fividjs%2Fivid/lists"}