diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fd101f01..8813035c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing -Thank you for contributing to `h5p-offline-player`. +Thank you for contributing to `h5p-toolkit`. ## Before you start @@ -24,8 +24,8 @@ dedicated worker. For architectural constraints and security boundaries, read ## Local setup ```bash -git clone https://github.com/missing-elements/h5p-offline-player.git -cd h5p-offline-player +git clone https://github.com/missing-elements/h5p-toolkit.git +cd h5p-toolkit pnpm install --frozen-lockfile pnpm --filter @missing-elements/h5p-offline-player exec playwright install chromium ``` diff --git a/README.md b/README.md index aac67886..04543ffd 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # @missing-elements/h5p-offline-player [![npm](https://img.shields.io/npm/v/%40missing-elements%2Fh5p-offline-player)](https://www.npmjs.com/package/@missing-elements/h5p-offline-player) -[![licence](https://img.shields.io/npm/l/%40missing-elements%2Fh5p-offline-player)](https://github.com/missing-elements/h5p-offline-player/blob/main/LICENSE) +[![licence](https://img.shields.io/npm/l/%40missing-elements%2Fh5p-offline-player)](https://github.com/missing-elements/h5p-toolkit/blob/main/LICENSE) Self-hosted [H5P](https://h5p.org) without an H5P server. One web component plays `.h5p` files from your own URLs or from disk, on static hosting you control: no Moodle, WordPress or Lumi, no @@ -13,7 +13,7 @@ backend, and no service of ours or H5P Group's between your learners and your co [Lovable example](https://embed-h5p-file.lovable.app/) · [VS Code extension](https://marketplace.visualstudio.com/items?itemName=MissingElements.h5p-preview) -Version 1 since October 2026; [Compatibility](https://github.com/missing-elements/h5p-offline-player/blob/main/docs/compatibility.md) +Version 1 since October 2026; [Compatibility](https://github.com/missing-elements/h5p-toolkit/blob/main/docs/compatibility.md) says what a version number promises. **Every week** a job rebuilds the library pack from the H5P hub and the interface strings from Moodle's translations, opens a pull request when either changed, and plays every content type in the pack, trusted and untrusted. @@ -21,32 +21,32 @@ changed, and plays every content type in the pack, trusted and untrusted. ## Features - **Plays the packages people have.** Large ones stream, and exports without their libraries, as - h5p.com and h5p.org make them, play against a [library pack](https://github.com/missing-elements/h5p-offline-player/blob/main/docs/libraries.md) + h5p.com and h5p.org make them, play against a [library pack](https://github.com/missing-elements/h5p-toolkit/blob/main/docs/libraries.md) of the 53 content types the H5P hub serves. -- **Plays packages you did not make** with [`untrusted`](https://github.com/missing-elements/h5p-offline-player/blob/main/docs/untrusted.md): none of their +- **Plays packages you did not make** with [`untrusted`](https://github.com/missing-elements/h5p-toolkit/blob/main/docs/untrusted.md): none of their code runs, and their content is checked by a port of H5P's own validator. - **Reports results you can audit:** xAPI statements that name the - [build of the package](https://github.com/missing-elements/h5p-offline-player/blob/main/docs/revision.md) they came from, [cmi5](https://github.com/missing-elements/h5p-offline-player/blob/main/docs/cmi5.md), [resume](https://github.com/missing-elements/h5p-offline-player/blob/main/docs/resume.md), and a - [SCORM zip](https://github.com/missing-elements/h5p-offline-player/tree/main/packages/embed#a-scorm-package-for-an-lms): SCORM 1.2, checked in + [build of the package](https://github.com/missing-elements/h5p-toolkit/blob/main/docs/revision.md) they came from, [cmi5](https://github.com/missing-elements/h5p-toolkit/blob/main/docs/cmi5.md), [resume](https://github.com/missing-elements/h5p-toolkit/blob/main/docs/resume.md), and a + [SCORM zip](https://github.com/missing-elements/h5p-toolkit/tree/main/packages/embed#a-scorm-package-for-an-lms): SCORM 1.2, checked in Moodle, ILIAS, OpenOLAT, Chamilo, SCORM Cloud and Frappe LMS, or 2004, checked in Moodle and SCORM Cloud. - **No tracking:** no account, cookies or telemetry, and nothing it stores leaves the learner's browser. The library pack comes from jsDelivr unless you serve a copy - ([privacy](https://github.com/missing-elements/h5p-offline-player/blob/main/docs/privacy.md)). + ([privacy](https://github.com/missing-elements/h5p-toolkit/blob/main/docs/privacy.md)). - **Works offline, in the content's language:** an installable app, and H5P's own buttons in English and 56 other languages. - **Tested in Chromium, Firefox and WebKit** on every change, and in Safari on macOS and iOS by - hand ([browsers](https://github.com/missing-elements/h5p-offline-player/blob/main/docs/compatibility.md#browsers)). -- **Comes with tools:** [`h5p-verify`](https://github.com/missing-elements/h5p-offline-player/blob/main/docs/verify.md) checks that a package plays, - [`h5p-normalize`](https://github.com/missing-elements/h5p-offline-player/blob/main/docs/streaming-video.md) makes its video stream, and - [`h5p-author`](https://github.com/missing-elements/h5p-offline-player/tree/main/packages/author#readme) builds one from a short JSON source, which a - Moodle site accepts as an upload too. [`h5p-mcp`](https://github.com/missing-elements/h5p-offline-player/tree/main/packages/mcp#readme) + hand ([browsers](https://github.com/missing-elements/h5p-toolkit/blob/main/docs/compatibility.md#browsers)). +- **Comes with tools:** [`h5p-verify`](https://github.com/missing-elements/h5p-toolkit/blob/main/docs/verify.md) checks that a package plays, + [`h5p-normalize`](https://github.com/missing-elements/h5p-toolkit/blob/main/docs/streaming-video.md) makes its video stream, and + [`h5p-author`](https://github.com/missing-elements/h5p-toolkit/tree/main/packages/author#readme) builds one from a short JSON source, which a + Moodle site accepts as an upload too. [`h5p-mcp`](https://github.com/missing-elements/h5p-toolkit/tree/main/packages/mcp#readme) brings the build and the check to an app with no shell, such as Claude Desktop. It is a player, not an editor, and it stores no results: its events go wherever your page sends them. Coming from [h5p-standalone](https://github.com/tunapanda/h5p-standalone)? This player reads the `.h5p` itself, with nothing to unzip, and -[takes its options by the same names](https://github.com/missing-elements/h5p-offline-player/blob/main/docs/h5p-standalone.md). +[takes its options by the same names](https://github.com/missing-elements/h5p-toolkit/blob/main/docs/h5p-standalone.md). ## Quick start @@ -77,45 +77,45 @@ carries its libraries plays as it is; one exported without them, as h5p.com expo Packages you did not make, or a site with signed-in users: play every package `untrusted`, or embed the player from a domain of its own, as -[Which setup](https://github.com/missing-elements/h5p-offline-player/blob/main/docs/setup.md#which-setup) explains. -[Setting up the player](https://github.com/missing-elements/h5p-offline-player/blob/main/docs/setup.md) also covers a page without a bundler, Rollup and +[Which setup](https://github.com/missing-elements/h5p-toolkit/blob/main/docs/setup.md#which-setup) explains. +[Setting up the player](https://github.com/missing-elements/h5p-toolkit/blob/main/docs/setup.md) also covers a page without a bundler, Rollup and esbuild, and the one-prompt install on Lovable; -[the element's API](https://github.com/missing-elements/h5p-offline-player/blob/main/docs/api.md) lists every attribute, property and event. +[the element's API](https://github.com/missing-elements/h5p-toolkit/blob/main/docs/api.md) lists every attribute, property and event. ## Documentation -- **Set up:** [Setting up the player](https://github.com/missing-elements/h5p-offline-player/blob/main/docs/setup.md) · - [The element's API](https://github.com/missing-elements/h5p-offline-player/blob/main/docs/api.md) · - [Troubleshooting](https://github.com/missing-elements/h5p-offline-player/blob/main/docs/troubleshooting.md) · - [Single-worker hosts and upgrades](https://github.com/missing-elements/h5p-offline-player/blob/main/docs/single-worker.md) · - [Coming from h5p-standalone](https://github.com/missing-elements/h5p-offline-player/blob/main/docs/h5p-standalone.md) -- **Packages:** [Libraries](https://github.com/missing-elements/h5p-offline-player/blob/main/docs/libraries.md) · - [Packages you did not make](https://github.com/missing-elements/h5p-offline-player/blob/main/docs/untrusted.md) · - [Video that cannot stream](https://github.com/missing-elements/h5p-offline-player/blob/main/docs/streaming-video.md) · - [Verifying a package](https://github.com/missing-elements/h5p-offline-player/blob/main/docs/verify.md) · - [The frame's CSP](https://github.com/missing-elements/h5p-offline-player/blob/main/docs/frame-csp.md) -- **Results:** [Resume](https://github.com/missing-elements/h5p-offline-player/blob/main/docs/resume.md) · - [Which build a learner completed](https://github.com/missing-elements/h5p-offline-player/blob/main/docs/revision.md) · - [cmi5](https://github.com/missing-elements/h5p-offline-player/blob/main/docs/cmi5.md) · - [A SCORM package](https://github.com/missing-elements/h5p-offline-player/tree/main/packages/embed#a-scorm-package-for-an-lms) -- **Policies:** [Compatibility](https://github.com/missing-elements/h5p-offline-player/blob/main/docs/compatibility.md) · - [Privacy and data protection](https://github.com/missing-elements/h5p-offline-player/blob/main/docs/privacy.md) · - [Accessibility](https://github.com/missing-elements/h5p-offline-player/blob/main/ACCESSIBILITY.md) · - [Security](https://github.com/missing-elements/h5p-offline-player/blob/main/SECURITY.md) +- **Set up:** [Setting up the player](https://github.com/missing-elements/h5p-toolkit/blob/main/docs/setup.md) · + [The element's API](https://github.com/missing-elements/h5p-toolkit/blob/main/docs/api.md) · + [Troubleshooting](https://github.com/missing-elements/h5p-toolkit/blob/main/docs/troubleshooting.md) · + [Single-worker hosts and upgrades](https://github.com/missing-elements/h5p-toolkit/blob/main/docs/single-worker.md) · + [Coming from h5p-standalone](https://github.com/missing-elements/h5p-toolkit/blob/main/docs/h5p-standalone.md) +- **Packages:** [Libraries](https://github.com/missing-elements/h5p-toolkit/blob/main/docs/libraries.md) · + [Packages you did not make](https://github.com/missing-elements/h5p-toolkit/blob/main/docs/untrusted.md) · + [Video that cannot stream](https://github.com/missing-elements/h5p-toolkit/blob/main/docs/streaming-video.md) · + [Verifying a package](https://github.com/missing-elements/h5p-toolkit/blob/main/docs/verify.md) · + [The frame's CSP](https://github.com/missing-elements/h5p-toolkit/blob/main/docs/frame-csp.md) +- **Results:** [Resume](https://github.com/missing-elements/h5p-toolkit/blob/main/docs/resume.md) · + [Which build a learner completed](https://github.com/missing-elements/h5p-toolkit/blob/main/docs/revision.md) · + [cmi5](https://github.com/missing-elements/h5p-toolkit/blob/main/docs/cmi5.md) · + [A SCORM package](https://github.com/missing-elements/h5p-toolkit/tree/main/packages/embed#a-scorm-package-for-an-lms) +- **Policies:** [Compatibility](https://github.com/missing-elements/h5p-toolkit/blob/main/docs/compatibility.md) · + [Privacy and data protection](https://github.com/missing-elements/h5p-toolkit/blob/main/docs/privacy.md) · + [Accessibility](https://github.com/missing-elements/h5p-toolkit/blob/main/ACCESSIBILITY.md) · + [Security](https://github.com/missing-elements/h5p-toolkit/blob/main/SECURITY.md) ## Packages | Package | What it is | |---|---| | [`@missing-elements/h5p-offline-player`](https://www.npmjs.com/package/@missing-elements/h5p-offline-player) | The `` element and its workers | -| [`@missing-elements/h5p-runtime`](https://github.com/missing-elements/h5p-offline-player/tree/main/packages/runtime#readme) | The H5P core the player loads in its frame, GPL-3.0 | -| [`@missing-elements/h5p-libraries`](https://github.com/missing-elements/h5p-offline-player/tree/main/packages/libraries#readme) | The library pack: the runtime libraries of every content type the H5P hub serves | -| [`@missing-elements/h5p-embed`](https://github.com/missing-elements/h5p-offline-player/tree/main/packages/embed#readme) | The player page as a static site, and a package as a SCORM zip | -| [`@missing-elements/h5p-verify`](https://github.com/missing-elements/h5p-offline-player/tree/main/packages/verify#readme) | Plays a package headless and reports whether it works, or opens it in your browser | -| [`@missing-elements/h5p-normalize`](https://github.com/missing-elements/h5p-offline-player/tree/main/packages/normalize#readme) | Rewrites a package so its video streams | -| [`@missing-elements/h5p-author`](https://github.com/missing-elements/h5p-offline-player/tree/main/packages/author#readme) | Builds a package of any content type from a short JSON source | -| [`@missing-elements/h5p-mcp`](https://github.com/missing-elements/h5p-offline-player/tree/main/packages/mcp#readme) | A local MCP server: an app such as Claude Desktop builds a package onto your disk, checks it and opens it in your browser | -| [`@missing-elements/h5p-cmi5`](https://github.com/missing-elements/h5p-offline-player/tree/main/packages/cmi5#readme) | Makes a page holding the element a cmi5 assignable unit | +| [`@missing-elements/h5p-runtime`](https://github.com/missing-elements/h5p-toolkit/tree/main/packages/runtime#readme) | The H5P core the player loads in its frame, GPL-3.0 | +| [`@missing-elements/h5p-libraries`](https://github.com/missing-elements/h5p-toolkit/tree/main/packages/libraries#readme) | The library pack: the runtime libraries of every content type the H5P hub serves | +| [`@missing-elements/h5p-embed`](https://github.com/missing-elements/h5p-toolkit/tree/main/packages/embed#readme) | The player page as a static site, and a package as a SCORM zip | +| [`@missing-elements/h5p-verify`](https://github.com/missing-elements/h5p-toolkit/tree/main/packages/verify#readme) | Plays a package headless and reports whether it works, or opens it in your browser | +| [`@missing-elements/h5p-normalize`](https://github.com/missing-elements/h5p-toolkit/tree/main/packages/normalize#readme) | Rewrites a package so its video streams | +| [`@missing-elements/h5p-author`](https://github.com/missing-elements/h5p-toolkit/tree/main/packages/author#readme) | Builds a package of any content type from a short JSON source | +| [`@missing-elements/h5p-mcp`](https://github.com/missing-elements/h5p-toolkit/tree/main/packages/mcp#readme) | A local MCP server: an app such as Claude Desktop builds a package onto your disk, checks it and opens it in your browser | +| [`@missing-elements/h5p-cmi5`](https://github.com/missing-elements/h5p-toolkit/tree/main/packages/cmi5#readme) | Makes a page holding the element a cmi5 assignable unit | | [H5P Preview](https://marketplace.visualstudio.com/items?itemName=MissingElements.h5p-preview) | Plays `.h5p` files in VS Code, and from [Open VSX](https://open-vsx.org/extension/MissingElements/h5p-preview) in Cursor and VSCodium | ## Agent skills @@ -127,40 +127,40 @@ with [skills](https://skills.sh/); add `--skill ` for one of them. None ne key or an H5P server. ```bash -npx skills add missing-elements/h5p-offline-player +npx skills add missing-elements/h5p-toolkit ``` | Skill | What it does | |---|---| -| [`h5p-author`](https://github.com/missing-elements/h5p-offline-player/tree/main/skills/h5p-author) | Turns a prompt or a lesson into H5P content of any of 28 types, chosen with you first, checks it in the real player and opens it for you to play | -| [`h5p-verify`](https://github.com/missing-elements/h5p-offline-player/tree/main/skills/h5p-verify) | Checks that a package plays, and opens it in your browser for you to try | -| [`h5p-to-scorm`](https://github.com/missing-elements/h5p-offline-player/tree/main/skills/h5p-to-scorm) | Turns a package into a SCORM zip that an LMS plays, grades and resumes, and says what to set in yours | -| [`h5p-player-setup`](https://github.com/missing-elements/h5p-offline-player/tree/main/skills/h5p-player-setup) | Puts H5P on a website, from the player on the site itself or framed from a domain of your own | -| [`h5p-normalize`](https://github.com/missing-elements/h5p-offline-player/tree/main/skills/h5p-normalize) | Rewrites a package whose video will not stream | +| [`h5p-author`](https://github.com/missing-elements/h5p-toolkit/tree/main/skills/h5p-author) | Turns a prompt or a lesson into H5P content of any of 28 types, chosen with you first, checks it in the real player and opens it for you to play | +| [`h5p-verify`](https://github.com/missing-elements/h5p-toolkit/tree/main/skills/h5p-verify) | Checks that a package plays, and opens it in your browser for you to try | +| [`h5p-to-scorm`](https://github.com/missing-elements/h5p-toolkit/tree/main/skills/h5p-to-scorm) | Turns a package into a SCORM zip that an LMS plays, grades and resumes, and says what to set in yours | +| [`h5p-player-setup`](https://github.com/missing-elements/h5p-toolkit/tree/main/skills/h5p-player-setup) | Puts H5P on a website, from the player on the site itself or framed from a domain of your own | +| [`h5p-normalize`](https://github.com/missing-elements/h5p-toolkit/tree/main/skills/h5p-normalize) | Rewrites a package whose video will not stream | A chat app takes `h5p-author` as a zip that you upload or attach. Download it from [missing-elements.github.io/h5p/create-with-ai/#install](https://missing-elements.github.io/h5p/create-with-ai/#install), which says where it goes in each app. The zip holds the same h5p-author release as the site's -build page runs. In Claude Desktop, [`h5p-mcp`](https://github.com/missing-elements/h5p-offline-player/tree/main/packages/mcp#readme) +build page runs. In Claude Desktop, [`h5p-mcp`](https://github.com/missing-elements/h5p-toolkit/tree/main/packages/mcp#readme) builds onto your disk instead. ## Contributing -A pnpm workspace: see [CONTRIBUTING.md](https://github.com/missing-elements/h5p-offline-player/blob/main/CONTRIBUTING.md), -[docs/development.md](https://github.com/missing-elements/h5p-offline-player/blob/main/docs/development.md) -and [AGENTS.md](https://github.com/missing-elements/h5p-offline-player/blob/main/AGENTS.md) with [design/](https://github.com/missing-elements/h5p-offline-player/tree/main/design), which hold +A pnpm workspace: see [CONTRIBUTING.md](https://github.com/missing-elements/h5p-toolkit/blob/main/CONTRIBUTING.md), +[docs/development.md](https://github.com/missing-elements/h5p-toolkit/blob/main/docs/development.md) +and [AGENTS.md](https://github.com/missing-elements/h5p-toolkit/blob/main/AGENTS.md) with [design/](https://github.com/missing-elements/h5p-toolkit/tree/main/design), which hold the design and the reasons behind it. Report vulnerabilities privately, as -[SECURITY.md](https://github.com/missing-elements/h5p-offline-player/blob/main/SECURITY.md) describes. +[SECURITY.md](https://github.com/missing-elements/h5p-toolkit/blob/main/SECURITY.md) describes. ## Licence -The player is MIT ([LICENSE](https://github.com/missing-elements/h5p-offline-player/blob/main/LICENSE)); +The player is MIT ([LICENSE](https://github.com/missing-elements/h5p-toolkit/blob/main/LICENSE)); its Service Worker bundles [zip.js](https://github.com/gildas-lormeau/zip.js), BSD-3-Clause -([NOTICE.md](https://github.com/missing-elements/h5p-offline-player/blob/main/packages/player/NOTICE.md)). +([NOTICE.md](https://github.com/missing-elements/h5p-toolkit/blob/main/packages/player/NOTICE.md)). The H5P runtime the frame loads, the H5P core from [h5p-php-library](https://github.com/h5p/h5p-php-library) and the script that boots it, is GPL-3.0 and published separately as [`@missing-elements/h5p-runtime`](https://www.npmjs.com/package/@missing-elements/h5p-runtime); the player talks to it only over HTTP and `postMessage`, and its -[NOTICE.md](https://github.com/missing-elements/h5p-offline-player/blob/main/packages/runtime/NOTICE.md) +[NOTICE.md](https://github.com/missing-elements/h5p-toolkit/blob/main/packages/runtime/NOTICE.md) says what serving it entails. Whether the copyleft reaches the page around the player is a legal question this README does not answer. diff --git a/apps/demo/app/index.html b/apps/demo/app/index.html index 289c65b7..c863e5b0 100644 --- a/apps/demo/app/index.html +++ b/apps/demo/app/index.html @@ -30,7 +30,7 @@ "offers": { "@type": "Offer", "price": "0", "priceCurrency": "USD" }, "isAccessibleForFree": true, "featureList": ["Plays .h5p files with no network once installed", "Opens .h5p files from the file manager", "Carries the H5P libraries for every H5P hub content type", "Nothing is uploaded"], - "sameAs": ["https://github.com/missing-elements/h5p-offline-player"], + "sameAs": ["https://github.com/missing-elements/h5p-toolkit"], "author": { "@type": "Organization", "name": "missing-elements", "url": "https://github.com/missing-elements" } } @@ -164,16 +164,16 @@

What it keeps on this device, and what it does not

  • Where you were. When a file is open, the content saves its own state — the slide or chapter reached, the answers given so far, the position in a video, whatever that content type keeps — in this browser's storage, on this device only. Open the same file again (same name, size and date) and it picks up there; Start over, the circular arrow at the top, forgets it. On a shared device, the next person to open the file finds where the last one left it, so press Start over first. The app sends none of it anywhere. A package's own scripts can read it, though, including what other packages saved here, so the app asks before opening a package from another site's link; open only packages you trust.
  • The files you opened. The list of recent files names each one and when it was opened, and unless the app was installed from Chrome or Edge on the desktop, it holds a copy of each file, its size beside it. Remove a file from the list, or clear the list, and the copy goes with it; on a shared device, clear it before you hand the device on. Like the saved state, it stays on this device, and a package's own scripts can read it.
  • Not results. The scores and completions the content reports as xAPI statements are neither stored on this device nor sent anywhere, so nothing here is a record that a course was completed.
  • -
  • For results that are recorded — a class, a course, a compliance record — wrap the file as a SCORM package for your LMS, which Moodle, ILIAS, OpenOLAT and Chamilo grade, or use the player component on a site that sends its xAPI statements to an LRS or an LMS.
  • +
  • For results that are recorded — a class, a course, a compliance record — wrap the file as a SCORM package for your LMS, which Moodle, ILIAS, OpenOLAT and Chamilo grade, or use the player component on a site that sends its xAPI statements to an LRS or an LMS.
  • @@ -191,11 +191,11 @@

    H5P Offline Player by Missing Elements

    installed from Chrome or Edge on the desktop, it keeps a copy of each, and removing one from the list deletes its copy. It keeps no scores and sends nothing anywhere.

    The player's own code is MIT; the H5P runtime it loads is GPL-3.0, see - NOTICE.md. + NOTICE.md. The H5P libraries it carries are listed with their licences in - libraries.txt.

    + libraries.txt.

    - Source code + Source code
    diff --git a/apps/demo/demo/compare.html b/apps/demo/demo/compare.html index c75a3d6b..e6e039c9 100644 --- a/apps/demo/demo/compare.html +++ b/apps/demo/demo/compare.html @@ -89,7 +89,7 @@

    What only this player does

    @@ -114,7 +114,7 @@

    Data and trust

    player keeps, in the browser on that device, the packages’ files and a list of what was played, and the content’s own saved state only when resume is set. Statements are not stored at all. - What is stored and sent + What is stored and sent has the details.

    @@ -131,7 +131,7 @@

    Data and trust

    from the pack you chose, its content folder serves the plugins’ list of file types and nothing else, and its content is checked against each library’s field definitions by a port of the plugins’ own validator, compared with the original on 98 cases. - Packages you did not make + Packages you did not make has the details. Embed adds a domain on top: a package then runs apart from your site altogether, where a hostile one cannot touch your logins, though it can read what other packages stored on that domain. @@ -140,7 +140,7 @@

    Data and trust

    Facts about the other options are from their documentation as of October 2026 and may have changed; corrections are welcome as - issues. + issues.

    diff --git a/apps/demo/demo/index.html b/apps/demo/demo/index.html index 6b8b7a1c..a5846274 100644 --- a/apps/demo/demo/index.html +++ b/apps/demo/demo/index.html @@ -126,8 +126,8 @@

    More ways to host it

    diff --git a/apps/demo/demo/normalize.html b/apps/demo/demo/normalize.html index f28a24d1..00884cba 100644 --- a/apps/demo/demo/normalize.html +++ b/apps/demo/demo/normalize.html @@ -235,7 +235,7 @@

    What normalizing cannot do

    The details — what was measured, and why each rule is the way it is — are in the repository's - design notes, + design notes, in the normalizer's file and in the invariants about deflated video under serving archives.

    @@ -244,7 +244,7 @@

    What normalizing cannot do

    Player page Setting it up All examples - Source and README + Source and README diff --git a/apps/demo/demo/og-image.png b/apps/demo/demo/og-image.png index 7811113b..c7a5c264 100644 Binary files a/apps/demo/demo/og-image.png and b/apps/demo/demo/og-image.png differ diff --git a/apps/demo/demo/player-page.js b/apps/demo/demo/player-page.js index 2e413006..17327224 100644 --- a/apps/demo/demo/player-page.js +++ b/apps/demo/demo/player-page.js @@ -388,7 +388,7 @@ for (const button of document.querySelectorAll('.samples button')) { * issue is public. GitHub fills a form's fields from the query by their `id`; it refuses `labels` * from a visitor who may not set them, and the form adds `bug` itself. */ -const REPORT_FORM = 'https://github.com/missing-elements/h5p-offline-player/issues/new' +const REPORT_FORM = 'https://github.com/missing-elements/h5p-toolkit/issues/new' /** GitHub answers a longer address with a 414, so the log is cut from its middle to fit. */ const REPORT_MAX_LENGTH = 7000 diff --git a/apps/demo/demo/setup.html b/apps/demo/demo/setup.html index fe0a6270..2ae5c677 100644 --- a/apps/demo/demo/setup.html +++ b/apps/demo/demo/setup.html @@ -64,7 +64,7 @@

    Which setup

    runs: it plays with the library pack's code, and its content is checked against each library's field definitions before it is shown, as the H5P CMS plugins check an author's upload, which makes it as contained as in an H5P plugin on the same site. - Packages you did not make + Packages you did not make sets the two modes beside the plugins'. Embedded, a package runs on the player domain and never sees your page, cookies, storage or APIs; results reach you as relayed xAPI, and storage is kept per embedding site. In every setup the package is named by src — the element's @@ -239,7 +239,7 @@

    Embed

    nginx.conf and an .htaccess for a server of your own, and the files Netlify, Cloudflare Pages and Vercel read. --packages limits the hosts packages may come from, and --ancestors the sites that may frame it; - the package's README + the package's README has the rest. Then, on your site:

    <iframe src="https://h5p-player.example.net/?src=https://alekswebnet.github.io/h5p/gh-normalized.h5p&xapi=https://your-site.example"
    @@ -264,7 +264,7 @@ 

    Requirements

  • h5p-sw.js is on the page's own origin. With a bundler that is automatic.
  • The package's host sends CORS headers, or no browser can read the file. Without them the element reports error: no-cors, and your page can offer a file picker instead.
  • Range support on the host is optional. With it a 300 MB package starts after a few kilobytes; without it the archive is downloaded once and played from the browser's cache, booting as soon as its libraries have arrived.
  • -
  • Licences: the player is MIT. The H5P core runtime it loads is GPL-3.0, which is why it is a package of its own, @missing-elements/h5p-runtime, whose dist/ carries its LICENSE.txt and NOTICE.txt; keep them with it when you copy or serve it. The runtime's NOTICE.md has the full account.
  • +
  • Licences: the player is MIT. The H5P core runtime it loads is GPL-3.0, which is why it is a package of its own, @missing-elements/h5p-runtime, whose dist/ carries its LICENSE.txt and NOTICE.txt; keep them with it when you copy or serve it. The runtime's NOTICE.md has the full account.
  • Listening to it

    @@ -309,9 +309,9 @@

    Attributes

    The element's whole API is in - docs/api.md; when something goes wrong, see - Troubleshooting, and for a site - with one Service Worker, single-worker hosts. + docs/api.md; when something goes wrong, see + Troubleshooting, and for a site + with one Service Worker, single-worker hosts.

    diff --git a/apps/demo/demo/stars.js b/apps/demo/demo/stars.js index 666c9842..b4c71c68 100644 --- a/apps/demo/demo/stars.js +++ b/apps/demo/demo/stars.js @@ -18,7 +18,7 @@ ;(() => { if (matchMedia('(display-mode: standalone), (display-mode: window-controls-overlay)').matches) return - const API = 'https://api.github.com/repos/missing-elements/h5p-offline-player' + const API = 'https://api.github.com/repos/missing-elements/h5p-toolkit' const KEY = 'h5p-demo-stars' const FRESH_MS = 60 * 60 * 1000 const RETRY_MS = 10 * 60 * 1000 diff --git a/apps/demo/index.html b/apps/demo/index.html index 29829c74..3f21fe90 100644 --- a/apps/demo/index.html +++ b/apps/demo/index.html @@ -55,7 +55,7 @@ "Exports without their libraries play against a pinned library pack", "Packages played untrusted run none of their own code, and their content is checked" ], - "sameAs": ["https://github.com/missing-elements/h5p-offline-player", "https://www.npmjs.com/package/@missing-elements/h5p-offline-player"], + "sameAs": ["https://github.com/missing-elements/h5p-toolkit", "https://www.npmjs.com/package/@missing-elements/h5p-offline-player"], "author": { "@type": "Organization", "name": "missing-elements", "url": "https://github.com/missing-elements" } } ] @@ -78,9 +78,9 @@

    Self-hosted H5P in one web component

    page. No file yet? The build page turns what an AI chat wrote with the - h5p-author skill + h5p-author skill into one, in your browser; in Claude Desktop, the - h5p-mcp server + h5p-mcp server builds one onto your disk.

    @@ -208,7 +208,7 @@

    Standalone, headless, offline

    opens a .h5p in an editor tab and plays it, offline; Cursor and VSCodium install it from Open VSX. In CI, - h5p-verify + h5p-verify plays a package in a headless browser and says whether it works.

    @@ -226,7 +226,7 @@

    Standalone, headless, offline

    Local file iframe embed Two on one page - Source on GitHub + Source on GitHub npm

    @@ -234,7 +234,7 @@

    Standalone, headless, offline

    H5P hub (MIT). The video is Big Buck Bunny, © Blender Foundation, CC BY 3.0. The player is MIT; the H5P core runtime it loads is GPL-3.0 and a package of its own, see its - NOTICE.md. + NOTICE.md.

    diff --git a/apps/demo/partials/topbar-icons.html b/apps/demo/partials/topbar-icons.html index 5d34199f..307188d3 100644 --- a/apps/demo/partials/topbar-icons.html +++ b/apps/demo/partials/topbar-icons.html @@ -4,7 +4,7 @@ - + Star diff --git a/apps/demo/scripts/build-og-image.mjs b/apps/demo/scripts/build-og-image.mjs index 8e68dc43..3fd7450b 100644 --- a/apps/demo/scripts/build-og-image.mjs +++ b/apps/demo/scripts/build-og-image.mjs @@ -41,7 +41,7 @@ const html = `

    Self-hosted H5P.
    No H5P server, no unpacking.

    A web component that reads a .h5p in place and serves it to the H5P runtime with a Service Worker.

    -
    github.com/missing-elements/h5p-offline-playerMIT
    +
    github.com/missing-elements/h5p-toolkitMIT
    ` diff --git a/design/licensing.md b/design/licensing.md index d8976424..5fc90328 100644 --- a/design/licensing.md +++ b/design/licensing.md @@ -83,9 +83,10 @@ Applied to this repository: generator so that the weekly refresh sees no change. Left as they are: the npm names, whose scope names the author, and which the policy treats as -names in code; descriptive uses ("Self-hosted H5P …"), which it allows as a "secondary -identifier"; the `— h5p-offline-player` at the end of the page titles; and the title inside the -pack's archives, "H5P Offline Player library pack", which nobody sees. Changing that one changes +names in code, and so the repository's name, `missing-elements/h5p-toolkit`; descriptive uses +("Self-hosted H5P …"), which it allows as a "secondary identifier"; the `— h5p-offline-player` +at the end of the page titles; and the title inside the pack's archives, "H5P Offline Player +library pack", which nobody sees. Changing that one changes every part's bytes, so every package's `libraries` revision, and every learner's saved state starts over once; it goes with the next pack release that rewrites every part anyway. The VS Code extension and the MCP server, "H5P Author MCP by Missing Elements", were named to the rule from diff --git a/docs/cmi5.md b/docs/cmi5.md index 43f8cb33..560af8fa 100644 --- a/docs/cmi5.md +++ b/docs/cmi5.md @@ -4,12 +4,12 @@ cmi5 is xAPI with a launch contract: the LMS opens content by URL, hands it a on and an LRS, and the content sends its statements there. It suits this player: the package stays on a static host, the LMS imports only a small course structure, no LRS credentials sit in page code, and every statement keeps `context.revision`. An LMS that speaks only SCORM takes the -package [`h5p-embed --scorm`](https://github.com/missing-elements/h5p-offline-player/tree/main/packages/embed#a-scorm-package-for-an-lms) +package [`h5p-embed --scorm`](https://github.com/missing-elements/h5p-toolkit/tree/main/packages/embed#a-scorm-package-for-an-lms) writes instead, which carries the player and the package into the LMS and reports the score, the result and the learner's place to it. The element does not change for it. The wiring is a package of its own with no dependencies, -[`@missing-elements/h5p-cmi5`](https://github.com/missing-elements/h5p-offline-player/tree/main/packages/cmi5): +[`@missing-elements/h5p-cmi5`](https://github.com/missing-elements/h5p-toolkit/tree/main/packages/cmi5): ```js import '@missing-elements/h5p-offline-player' diff --git a/docs/compatibility.md b/docs/compatibility.md index 4b3bdf74..01c6c378 100644 --- a/docs/compatibility.md +++ b/docs/compatibility.md @@ -13,12 +13,12 @@ Two kinds of fix ship in any release, a patch included: - **Security.** A fix that refuses something hostile, even when it refuses a package that played before. Which releases receive one is in - [SECURITY.md](https://github.com/missing-elements/h5p-offline-player/blob/main/SECURITY.md). + [SECURITY.md](https://github.com/missing-elements/h5p-toolkit/blob/main/SECURITY.md). - **Conformance.** A fix that brings what a package sends or writes into line with the standard it implements — xAPI, cmi5, the zip format — even when a system downstream accepted the old form. -Each release's notes, on [GitHub](https://github.com/missing-elements/h5p-offline-player/releases), +Each release's notes, on [GitHub](https://github.com/missing-elements/h5p-toolkit/releases), list a breaking change, or a fix of either kind, first, with what to do about it. ## What is covered @@ -26,7 +26,7 @@ list a breaking change, or a fix of either kind, first, with what to do about it ### The player, `@missing-elements/h5p-offline-player` - **The element.** ``, and every attribute, property, method and event in - [the element's API](https://github.com/missing-elements/h5p-offline-player/blob/main/docs/api.md), with the + [the element's API](https://github.com/missing-elements/h5p-toolkit/blob/main/docs/api.md), with the values and `detail` shapes given there. A new error `code` or `progress` phase can come in a minor: treat one you do not know as the general case. - **The files.** The package's exports — `.`, the element, and `./sw`, `mountH5P` — and the four @@ -37,7 +37,7 @@ list a breaking change, or a fix of either kind, first, with what to do about it left to the network, or to the host's own handlers. - **What statements carry.** `context.platform` is `h5p-offline-player `, and `context.revision` is `sha256:`, followed by `; libraries` and the fingerprint of what - supplied libraries, a bundle's or the pack's archives' ([Which build a learner completed](https://github.com/missing-elements/h5p-offline-player/blob/main/docs/revision.md)). + supplied libraries, a bundle's or the pack's archives' ([Which build a learner completed](https://github.com/missing-elements/h5p-toolkit/blob/main/docs/revision.md)). The recipe behind the hash does not change within a major, and a major that changes it gives the new value a prefix of its own, so an audit can always tell which recipe to recompute with. - **What names a package.** `activity-id` defaults to the package URL, and the statements' @@ -52,7 +52,7 @@ list a breaking change, or a fix of either kind, first, with what to do about it - **Versions side by side.** Within a major, an element plays with a Service Worker from an older release: it updates its own worker before the first load, and logs a warning where it cannot — a stale copy of `h5p-sw.js` on the host, or a host's worker with the routes mounted. A worker - serves an element from an older release too. [Upgrading](https://github.com/missing-elements/h5p-offline-player/blob/main/docs/single-worker.md#upgrading) + serves an element from an older release too. [Upgrading](https://github.com/missing-elements/h5p-toolkit/blob/main/docs/single-worker.md#upgrading) says what a host does about it. ### The runtime, `@missing-elements/h5p-runtime` @@ -90,7 +90,7 @@ library's `editorDependencies` and `dynamicDependencies` beside its `preloadedDe - **The command's options**, and the files it writes for each kind of host. - **The page's interface**: its query parameters and the messages it posts, as its - [README](https://github.com/missing-elements/h5p-offline-player/tree/main/packages/embed#readme) + [README](https://github.com/missing-elements/h5p-toolkit/tree/main/packages/embed#readme) lists them: what a snippet, or a page that reads `report`, is built on. - **`buildSite()`**, the command as a function, and **`startEmbed()`**, the page as one, with their options and their types; and `resizer.js`, which speaks H5P's own resizer protocol. @@ -114,7 +114,7 @@ the LMS. ### cmi5, `@missing-elements/h5p-cmi5` `startCmi5()`, `isCmi5Launch()` and `createCmi5Client()`, with the options and the session's and -client's methods its [README](https://github.com/missing-elements/h5p-offline-player/tree/main/packages/cmi5#readme) +client's methods its [README](https://github.com/missing-elements/h5p-toolkit/tree/main/packages/cmi5#readme) lists, and their types. The statements it sends are cmi5's, so a fix that brings one into line with the specification is a conformance fix. diff --git a/docs/development.md b/docs/development.md index 750d33f5..6aab1654 100644 --- a/docs/development.md +++ b/docs/development.md @@ -35,4 +35,4 @@ The demo deploys to Vercel from `vercel.json`. Its `/app/` page is the player as app that plays `.h5p` files with no network, libraries included; `/app/?src=` opens a package from the web in it. -Working on the code? Start with [AGENTS.md](https://github.com/missing-elements/h5p-offline-player/blob/main/AGENTS.md). +Working on the code? Start with [AGENTS.md](https://github.com/missing-elements/h5p-toolkit/blob/main/AGENTS.md). diff --git a/docs/privacy.md b/docs/privacy.md index b162b3a0..2c15345d 100644 --- a/docs/privacy.md +++ b/docs/privacy.md @@ -12,7 +12,7 @@ and the content you play have their own answers. This is not legal advice. - Nothing it stores leaves the learner's browser. It stores no xAPI statements and no results. - Results reach your page as `xapi` events. Where they go from there is your decision. - Self-hosted, the only processor in the learner's path is your own hosting. That stays true if - you use [`@missing-elements/h5p-embed`](https://github.com/missing-elements/h5p-offline-player/tree/main/packages/embed#readme) + you use [`@missing-elements/h5p-embed`](https://github.com/missing-elements/h5p-toolkit/tree/main/packages/embed#readme) on a player domain you run. It is not true for a public service in the learner's path. ## What is stored, on the learner's device @@ -69,7 +69,7 @@ The element emits each statement as an `xapi` event and keeps nothing. - With [`@missing-elements/h5p-cmi5`](cmi5.md), statements go to the LMS's LRS, under the launch's learner and registration. The launch token stays in memory unless you choose `storage`. - In a SCORM package written by - [`h5p-embed --scorm`](https://github.com/missing-elements/h5p-offline-player/tree/main/packages/embed#a-scorm-package-for-an-lms), + [`h5p-embed --scorm`](https://github.com/missing-elements/h5p-toolkit/tree/main/packages/embed#a-scorm-package-for-an-lms), no statement leaves the page. The LMS gets, under its own record of the learner, the score out of 100, `passed`, `failed` or `completed`, the time spent, and the content's saved state in `cmi.suspend_data`, which holds the answers given so far. That state is kept in the LMS, not on diff --git a/docs/revision.md b/docs/revision.md index 9ee6cbe3..8dacca20 100644 --- a/docs/revision.md +++ b/docs/revision.md @@ -23,7 +23,7 @@ release that changes none of a package's libraries leaves its revision as it was published `.h5p`, from which anyone can recompute it. The recipe does not change within a major version of the player, and a major that changes it -gives the new value a prefix of its own ([Compatibility](https://github.com/missing-elements/h5p-offline-player/blob/main/docs/compatibility.md)). +gives the new value a prefix of its own ([Compatibility](https://github.com/missing-elements/h5p-toolkit/blob/main/docs/compatibility.md)). It identifies a build; it does not seal one, since a CRC can be forged on purpose. It also cannot say *when* a build was current — that belongs in your LMS, LRS or document control, against which diff --git a/docs/setup.md b/docs/setup.md index 8110cc64..5f5ac812 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -12,7 +12,7 @@ An H5P package is JavaScript, and the player runs it on the origin that serves t | Cannot host a file (page builder, hosted CMS, LMS page) | **Embed** | Installed, you get the whole API, and a package played as it is runs as your site. Embedded, the -player page that [`@missing-elements/h5p-embed`](https://github.com/missing-elements/h5p-offline-player/tree/main/packages/embed#readme) +player page that [`@missing-elements/h5p-embed`](https://github.com/missing-elements/h5p-toolkit/tree/main/packages/embed#readme) writes is framed from a domain that holds nothing else, so a package never sees your site's cookies, storage or page, and you get its results as relayed xAPI. `untrusted` plays a package as data, none of its own code running and its content checked, as an H5P plugin checks an author's diff --git a/docs/single-worker.md b/docs/single-worker.md index de7da789..e5215dd5 100644 --- a/docs/single-worker.md +++ b/docs/single-worker.md @@ -12,7 +12,7 @@ mountH5P(self); // call before Workbox routing so h5p/* is Routes then live under `h5p/`, and the element uses them instead of registering its own worker. Upgrading the package means rebuilding the host's worker. -**An app that must work offline needs this setup.** The frame's requests for the runtime, `h5p.css` and the fonts go to the worker that mounts the routes, so that worker must also precache them with your app shell, and the page must be controlled by it before the element loads anything — on a first visit, wait for `controllerchange` after registering. Worked example: the demo's installable app, [`apps/demo/app/sw.js`](https://github.com/missing-elements/h5p-offline-player/blob/main/apps/demo/app/sw.js) and [`app.js`](https://github.com/missing-elements/h5p-offline-player/blob/main/apps/demo/app/app.js). +**An app that must work offline needs this setup.** The frame's requests for the runtime, `h5p.css` and the fonts go to the worker that mounts the routes, so that worker must also precache them with your app shell, and the page must be controlled by it before the element loads anything — on a first visit, wait for `controllerchange` after registering. Worked example: the demo's installable app, [`apps/demo/app/sw.js`](https://github.com/missing-elements/h5p-toolkit/blob/main/apps/demo/app/sw.js) and [`app.js`](https://github.com/missing-elements/h5p-toolkit/blob/main/apps/demo/app/app.js). ## Upgrading @@ -22,4 +22,4 @@ Routes then live under `h5p/`, and the element uses them instead of r - Installed without a build step: re-download `h5p-sw.js` after upgrading. The element logs a warning when versions differ. - Single-worker hosts update their own worker; offer a reload on `controllerchange`, as the demo's app does. -What an upgrade may change, by version number, is in [Compatibility](https://github.com/missing-elements/h5p-offline-player/blob/main/docs/compatibility.md). +What an upgrade may change, by version number, is in [Compatibility](https://github.com/missing-elements/h5p-toolkit/blob/main/docs/compatibility.md). diff --git a/docs/streaming-video.md b/docs/streaming-video.md index e232284f..21415b0a 100644 --- a/docs/streaming-video.md +++ b/docs/streaming-video.md @@ -18,7 +18,7 @@ time. It is off by default because it spends bandwidth on media the learner may Progress arrives as `progress` events with `phase: 'extract'`. The fix is to the package, with -[`@missing-elements/h5p-normalize`](https://github.com/missing-elements/h5p-offline-player/tree/main/packages/normalize): +[`@missing-elements/h5p-normalize`](https://github.com/missing-elements/h5p-toolkit/tree/main/packages/normalize): It needs Node 22 or later. diff --git a/docs/verify.md b/docs/verify.md index 15eeebb7..5a4cf9aa 100644 --- a/docs/verify.md +++ b/docs/verify.md @@ -1,6 +1,6 @@ # Checking that a package plays -[`@missing-elements/h5p-verify`](https://github.com/missing-elements/h5p-offline-player/tree/main/packages/verify) +[`@missing-elements/h5p-verify`](https://github.com/missing-elements/h5p-toolkit/tree/main/packages/verify) plays a package through the player in a headless browser and says whether it worked. It needs Node 22 or later: @@ -35,9 +35,9 @@ does the same in an editor tab, and plays the file again whenever it is rewritte library pack, so an export without its libraries plays offline. For authoring, the -[`h5p-author` skill](https://github.com/missing-elements/h5p-offline-player/tree/main/skills/h5p-author) +[`h5p-author` skill](https://github.com/missing-elements/h5p-toolkit/tree/main/skills/h5p-author) adds a prompt-to-package workflow for 28 content types, on -[`@missing-elements/h5p-author`](https://github.com/missing-elements/h5p-offline-player/tree/main/packages/author#readme). +[`@missing-elements/h5p-author`](https://github.com/missing-elements/h5p-toolkit/tree/main/packages/author#readme). It takes a short JSON source of only what differs from a type's defaults, fills the rest from the libraries' semantics and translations, includes their runtime dependencies, then requires this playback check and screenshot review, and opens the package in the preview for a person to work diff --git a/package.json b/package.json index 094b1987..2bb26bc7 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "h5p-offline-player-workspace", + "name": "h5p-toolkit-workspace", "private": true, "type": "module", "packageManager": "pnpm@10.24.0", diff --git a/packages/author/README.md b/packages/author/README.md index 266e8486..b0cd9817 100644 --- a/packages/author/README.md +++ b/packages/author/README.md @@ -39,7 +39,7 @@ the same package exported from Moodle has, because their editors bring every typ It is written for an AI agent and its tokens: the agent writes what only an author can know, and code writes everything that can be derived. The -[h5p-author skill](https://github.com/missing-elements/h5p-offline-player/tree/main/skills/h5p-author) +[h5p-author skill](https://github.com/missing-elements/h5p-toolkit/tree/main/skills/h5p-author) is the workflow around it: choosing the content type with the user, a file per type with notes, an example and the fields, then the check and the preview. diff --git a/packages/author/package.json b/packages/author/package.json index f4dbb6be..640c6b36 100644 --- a/packages/author/package.json +++ b/packages/author/package.json @@ -5,12 +5,12 @@ "license": "MIT", "repository": { "type": "git", - "url": "git+https://github.com/missing-elements/h5p-offline-player.git", + "url": "git+https://github.com/missing-elements/h5p-toolkit.git", "directory": "packages/author" }, - "homepage": "https://github.com/missing-elements/h5p-offline-player/tree/main/packages/author#readme", + "homepage": "https://github.com/missing-elements/h5p-toolkit/tree/main/packages/author#readme", "bugs": { - "url": "https://github.com/missing-elements/h5p-offline-player/issues" + "url": "https://github.com/missing-elements/h5p-toolkit/issues" }, "publishConfig": { "access": "public" diff --git a/packages/cmi5/README.md b/packages/cmi5/README.md index e90dc59e..fc826a9c 100644 --- a/packages/cmi5/README.md +++ b/packages/cmi5/README.md @@ -1,6 +1,6 @@ # @missing-elements/h5p-cmi5 -cmi5 for [h5p-offline-player](https://github.com/missing-elements/h5p-offline-player): turns a +cmi5 for [h5p-offline-player](https://github.com/missing-elements/h5p-toolkit): turns a page holding `` into a cmi5 assignable unit, so an LMS can launch an `.h5p` package and record the result. The package stays on your static host; the LMS imports a small course structure naming your page. No dependencies. @@ -98,8 +98,8 @@ and the launch's `launchParameters`, `launchData`, `learnerPreferences`, `return device. A working page with a simulated LMS is the demo's -[cmi5 example](https://github.com/missing-elements/h5p-offline-player/blob/main/apps/demo/demo/cmi5-page.js); -the full guide is [docs/cmi5.md](https://github.com/missing-elements/h5p-offline-player/blob/main/docs/cmi5.md). +[cmi5 example](https://github.com/missing-elements/h5p-toolkit/blob/main/apps/demo/demo/cmi5-page.js); +the full guide is [docs/cmi5.md](https://github.com/missing-elements/h5p-toolkit/blob/main/docs/cmi5.md). ## Licence diff --git a/packages/cmi5/package.json b/packages/cmi5/package.json index 643d3b6d..7780a1ae 100644 --- a/packages/cmi5/package.json +++ b/packages/cmi5/package.json @@ -5,12 +5,12 @@ "license": "MIT", "repository": { "type": "git", - "url": "git+https://github.com/missing-elements/h5p-offline-player.git", + "url": "git+https://github.com/missing-elements/h5p-toolkit.git", "directory": "packages/cmi5" }, - "homepage": "https://github.com/missing-elements/h5p-offline-player/tree/main/packages/cmi5#readme", + "homepage": "https://github.com/missing-elements/h5p-toolkit/tree/main/packages/cmi5#readme", "bugs": { - "url": "https://github.com/missing-elements/h5p-offline-player/issues" + "url": "https://github.com/missing-elements/h5p-toolkit/issues" }, "publishConfig": { "access": "public" diff --git a/packages/embed/README.md b/packages/embed/README.md index 5f7ceeff..722bb80a 100644 --- a/packages/embed/README.md +++ b/packages/embed/README.md @@ -180,9 +180,9 @@ instead. Replacing the zip with one written from another `.h5p`, or with other libraries from the pack, starts learners over, since their saved state belongs to what it was saved in. -An [agent skill](https://github.com/missing-elements/h5p-offline-player/tree/main/skills/h5p-to-scorm) +An [agent skill](https://github.com/missing-elements/h5p-toolkit/tree/main/skills/h5p-to-scorm) takes an agent through it, from checking the package to the setting each LMS needs: -`npx skills add missing-elements/h5p-offline-player --skill h5p-to-scorm`. +`npx skills add missing-elements/h5p-toolkit --skill h5p-to-scorm`. ### Options of the zip @@ -328,7 +328,7 @@ player domain, the package hosts and, only for `pack` on a site built with `--no `cdn.jsdelivr.net`. A SCORM package contacts nothing but the LMS it was uploaded to, which gets the score, the result, the time spent and the learner's saved state. What the player stores and sends, for a privacy notice or a GDPR review: -[Privacy and data protection](https://github.com/missing-elements/h5p-offline-player/blob/main/docs/privacy.md). +[Privacy and data protection](https://github.com/missing-elements/h5p-toolkit/blob/main/docs/privacy.md). ## Licences diff --git a/packages/embed/lib/build.mjs b/packages/embed/lib/build.mjs index 7c765acd..92113446 100644 --- a/packages/embed/lib/build.mjs +++ b/packages/embed/lib/build.mjs @@ -339,7 +339,7 @@ Serve it from a domain that holds nothing else, and frame it: style="width: 100%; border: 0"> -https://github.com/missing-elements/h5p-offline-player/tree/main/packages/embed +https://github.com/missing-elements/h5p-toolkit/tree/main/packages/embed ` } diff --git a/packages/embed/lib/scorm-core.mjs b/packages/embed/lib/scorm-core.mjs index 55b7fc31..fce373d8 100644 --- a/packages/embed/lib/scorm-core.mjs +++ b/packages/embed/lib/scorm-core.mjs @@ -199,7 +199,7 @@ ${ ` : '' } -https://github.com/missing-elements/h5p-offline-player/tree/main/packages/embed +https://github.com/missing-elements/h5p-toolkit/tree/main/packages/embed ` } diff --git a/packages/embed/package.json b/packages/embed/package.json index 0cb9a555..99e84b31 100644 --- a/packages/embed/package.json +++ b/packages/embed/package.json @@ -5,12 +5,12 @@ "license": "MIT", "repository": { "type": "git", - "url": "git+https://github.com/missing-elements/h5p-offline-player.git", + "url": "git+https://github.com/missing-elements/h5p-toolkit.git", "directory": "packages/embed" }, - "homepage": "https://github.com/missing-elements/h5p-offline-player/tree/main/packages/embed#readme", + "homepage": "https://github.com/missing-elements/h5p-toolkit/tree/main/packages/embed#readme", "bugs": { - "url": "https://github.com/missing-elements/h5p-offline-player/issues" + "url": "https://github.com/missing-elements/h5p-toolkit/issues" }, "publishConfig": { "access": "public" diff --git a/packages/embed/scripts/build.mjs b/packages/embed/scripts/build.mjs index bb7bc1f2..29becc43 100644 --- a/packages/embed/scripts/build.mjs +++ b/packages/embed/scripts/build.mjs @@ -26,7 +26,7 @@ async function notices() { const licence = (await readFile(resolve(zipJs, 'LICENSE'), 'utf8')).trim() if (licence.includes('*/')) throw new Error('[build] the zip.js licence would end the comment early') return ( - `/*! @missing-elements/h5p-embed ${version}, the SCORM page. Copyright (c) 2026 missing-elements. MIT (https://github.com/missing-elements/h5p-offline-player/blob/main/LICENSE). ` + + `/*! @missing-elements/h5p-embed ${version}, the SCORM page. Copyright (c) 2026 missing-elements. MIT (https://github.com/missing-elements/h5p-toolkit/blob/main/LICENSE). ` + `Bundles the library rules of @missing-elements/h5p-offline-player (MIT) and zip.js ${zip} (https://github.com/gildas-lormeau/zip.js):\n\n${licence}\n*/` ) } diff --git a/packages/libraries/package.json b/packages/libraries/package.json index 60daaf6e..9dad57a9 100644 --- a/packages/libraries/package.json +++ b/packages/libraries/package.json @@ -5,12 +5,12 @@ "license": "SEE LICENSE IN libraries.txt", "repository": { "type": "git", - "url": "git+https://github.com/missing-elements/h5p-offline-player.git", + "url": "git+https://github.com/missing-elements/h5p-toolkit.git", "directory": "packages/libraries" }, - "homepage": "https://github.com/missing-elements/h5p-offline-player/tree/main/packages/libraries#readme", + "homepage": "https://github.com/missing-elements/h5p-toolkit/tree/main/packages/libraries#readme", "bugs": { - "url": "https://github.com/missing-elements/h5p-offline-player/issues" + "url": "https://github.com/missing-elements/h5p-toolkit/issues" }, "publishConfig": { "access": "public" diff --git a/packages/mcp/package.json b/packages/mcp/package.json index d7a48478..2e08b1ca 100644 --- a/packages/mcp/package.json +++ b/packages/mcp/package.json @@ -5,12 +5,12 @@ "license": "MIT", "repository": { "type": "git", - "url": "git+https://github.com/missing-elements/h5p-offline-player.git", + "url": "git+https://github.com/missing-elements/h5p-toolkit.git", "directory": "packages/mcp" }, - "homepage": "https://github.com/missing-elements/h5p-offline-player/tree/main/packages/mcp#readme", + "homepage": "https://github.com/missing-elements/h5p-toolkit/tree/main/packages/mcp#readme", "bugs": { - "url": "https://github.com/missing-elements/h5p-offline-player/issues" + "url": "https://github.com/missing-elements/h5p-toolkit/issues" }, "publishConfig": { "access": "public" diff --git a/packages/normalize/README.md b/packages/normalize/README.md index 34a41ba8..9dde571c 100644 --- a/packages/normalize/README.md +++ b/packages/normalize/README.md @@ -1,7 +1,7 @@ # @missing-elements/h5p-normalize Rewrites an `.h5p` package once, where it is published, so that it streams well through -[h5p-offline-player](https://github.com/missing-elements/h5p-offline-player). Only the zip +[h5p-offline-player](https://github.com/missing-elements/h5p-toolkit). Only the zip container changes: media is stored rather than deflated, an mp4 with its index at the end is remuxed (not re-encoded) to put it first, content media goes last, and stored scripts, styles and JSON are deflated. Everything else is copied byte for byte. @@ -66,7 +66,7 @@ fewer at its end, so it runs on a file in Node or a `Blob` in a page. It reads a few small atoms, never the media. Why deflated video cannot stream: the demo's -[normalize page](https://github.com/missing-elements/h5p-offline-player/blob/main/apps/demo/demo/normalize.html). +[normalize page](https://github.com/missing-elements/h5p-toolkit/blob/main/apps/demo/demo/normalize.html). ## Licence diff --git a/packages/normalize/package.json b/packages/normalize/package.json index 117be373..4c319426 100644 --- a/packages/normalize/package.json +++ b/packages/normalize/package.json @@ -5,12 +5,12 @@ "license": "MIT", "repository": { "type": "git", - "url": "git+https://github.com/missing-elements/h5p-offline-player.git", + "url": "git+https://github.com/missing-elements/h5p-toolkit.git", "directory": "packages/normalize" }, - "homepage": "https://github.com/missing-elements/h5p-offline-player/tree/main/packages/normalize#readme", + "homepage": "https://github.com/missing-elements/h5p-toolkit/tree/main/packages/normalize#readme", "bugs": { - "url": "https://github.com/missing-elements/h5p-offline-player/issues" + "url": "https://github.com/missing-elements/h5p-toolkit/issues" }, "publishConfig": { "access": "public" diff --git a/packages/player/package.json b/packages/player/package.json index 43457847..5da24a48 100644 --- a/packages/player/package.json +++ b/packages/player/package.json @@ -5,12 +5,12 @@ "license": "MIT", "repository": { "type": "git", - "url": "git+https://github.com/missing-elements/h5p-offline-player.git", + "url": "git+https://github.com/missing-elements/h5p-toolkit.git", "directory": "packages/player" }, - "homepage": "https://github.com/missing-elements/h5p-offline-player#readme", + "homepage": "https://github.com/missing-elements/h5p-toolkit#readme", "bugs": { - "url": "https://github.com/missing-elements/h5p-offline-player/issues" + "url": "https://github.com/missing-elements/h5p-toolkit/issues" }, "publishConfig": { "access": "public" diff --git a/packages/player/scripts/lib/worker-bundle.mjs b/packages/player/scripts/lib/worker-bundle.mjs index ec99b6cb..46452a96 100644 --- a/packages/player/scripts/lib/worker-bundle.mjs +++ b/packages/player/scripts/lib/worker-bundle.mjs @@ -58,7 +58,7 @@ async function zipJsNotice() { */ export async function playerNotice() { const { version } = JSON.parse(await readFile(resolve(rootDir, 'package.json'), 'utf8')) - return `/*! @missing-elements/h5p-offline-player ${version}. Copyright (c) 2026 missing-elements. MIT (https://github.com/missing-elements/h5p-offline-player/blob/main/LICENSE). */` + return `/*! @missing-elements/h5p-offline-player ${version}. Copyright (c) 2026 missing-elements. MIT (https://github.com/missing-elements/h5p-toolkit/blob/main/LICENSE). */` } async function shared() { diff --git a/packages/runtime/NOTICE.md b/packages/runtime/NOTICE.md index 99f38f5b..db3c2bc5 100644 --- a/packages/runtime/NOTICE.md +++ b/packages/runtime/NOTICE.md @@ -20,7 +20,7 @@ file under a licence comment and minified. `h5p.css` is the core's stylesheets, `H5PCore::$styles` names, joined and rebuilt so that it stands alone: its icon fonts and image inlined as data URLs, its Inter and Open Sans faces moved to `fonts/` and listed in `MANIFEST.json` for the player's frame document to declare. `vendor/h5p-core/` in the -[repository](https://github.com/missing-elements/h5p-offline-player/tree/main/packages/runtime) +[repository](https://github.com/missing-elements/h5p-toolkit/tree/main/packages/runtime) holds the files as upstream has them, and `scripts/sync-core.mjs` takes them from upstream. Until 2026-10-18 the core came by way of [h5p-standalone](https://github.com/tunapanda/h5p-standalone), @@ -70,7 +70,7 @@ it departs from the original, the file's leading comment says how and why. strings for its own H5P support, and `core_h5p\framework::t()` in Moodle says which of its strings is which. Copyright Moodle and its translators, under the **GNU General Public License v3.0 or later**, which this package's GPL-3.0 accepts. `l10n/index.json` in the -[repository](https://github.com/missing-elements/h5p-offline-player/tree/main/packages/runtime/l10n) +[repository](https://github.com/missing-elements/h5p-toolkit/tree/main/packages/runtime/l10n) names the pack each language came from, the date they were taken and the strings left in English, where a pack had none or one that broke a placeholder. The file opens with a comment naming its source. diff --git a/packages/runtime/package.json b/packages/runtime/package.json index 1bb9c7bd..7eef11fc 100644 --- a/packages/runtime/package.json +++ b/packages/runtime/package.json @@ -5,12 +5,12 @@ "license": "GPL-3.0-only", "repository": { "type": "git", - "url": "git+https://github.com/missing-elements/h5p-offline-player.git", + "url": "git+https://github.com/missing-elements/h5p-toolkit.git", "directory": "packages/runtime" }, - "homepage": "https://github.com/missing-elements/h5p-offline-player/tree/main/packages/runtime#readme", + "homepage": "https://github.com/missing-elements/h5p-toolkit/tree/main/packages/runtime#readme", "bugs": { - "url": "https://github.com/missing-elements/h5p-offline-player/issues" + "url": "https://github.com/missing-elements/h5p-toolkit/issues" }, "publishConfig": { "access": "public" diff --git a/packages/runtime/scripts/build.mjs b/packages/runtime/scripts/build.mjs index 84e04b68..300a3177 100644 --- a/packages/runtime/scripts/build.mjs +++ b/packages/runtime/scripts/build.mjs @@ -340,7 +340,7 @@ l10n.js Corresponding source for the GPL parts as built: ${core.repository}/tree/${core.commit} (js/ and styles/), and -https://github.com/missing-elements/h5p-offline-player/tree/main/packages/runtime, whose +https://github.com/missing-elements/h5p-toolkit/tree/main/packages/runtime, whose vendor/h5p-core/ holds the same files and scripts/ the build that joins them. ` } diff --git a/packages/runtime/scripts/sync-core.mjs b/packages/runtime/scripts/sync-core.mjs index 6b8b7a6d..0cf27e9b 100644 --- a/packages/runtime/scripts/sync-core.mjs +++ b/packages/runtime/scripts/sync-core.mjs @@ -36,7 +36,7 @@ const fail = (message) => { /** GitHub's API, with a token when the environment has one: sixty requests an hour without. */ async function api(path) { - const headers = { accept: 'application/vnd.github+json', 'user-agent': 'h5p-offline-player core sync' } + const headers = { accept: 'application/vnd.github+json', 'user-agent': 'h5p-toolkit core sync' } if (process.env.GITHUB_TOKEN) headers.authorization = `Bearer ${process.env.GITHUB_TOKEN}` const response = await fetch(`https://api.github.com/repos/${REPOSITORY}/${path}`, { headers }) if (!response.ok) fail(`GitHub answered ${response.status} for ${path}`) diff --git a/packages/verify/README.md b/packages/verify/README.md index b524211b..b6d25065 100644 --- a/packages/verify/README.md +++ b/packages/verify/README.md @@ -1,7 +1,7 @@ # @missing-elements/h5p-verify Plays an `.h5p` package in a headless browser through -[h5p-offline-player](https://github.com/missing-elements/h5p-offline-player) and reports whether +[h5p-offline-player](https://github.com/missing-elements/h5p-toolkit) and reports whether it works. Needs Node 22 or later; write `@latest`, since without it npm on an older Node quietly installs the last version that supported it. @@ -32,7 +32,7 @@ accessibility or licensing: look at the screenshot. ## Played untrusted A site that plays packages it did not make plays them -[`untrusted`](https://github.com/missing-elements/h5p-offline-player/blob/main/docs/untrusted.md), +[`untrusted`](https://github.com/missing-elements/h5p-toolkit/blob/main/docs/untrusted.md), as the H5P plugins treat an upload: none of the package's own code runs, its libraries come only from the site's pack, and its content is checked against each library's `semantics.json`. `--untrusted` plays it that way: @@ -123,9 +123,9 @@ its `url`, `close()`, and a `closed` promise that settles with `closed` once its opens an address in the default browser, false where no opener started. An [agent skill](https://agentskills.io) for it ships in the repository: -`npx skills add missing-elements/h5p-offline-player --skill h5p-verify`. +`npx skills add missing-elements/h5p-toolkit --skill h5p-verify`. ## Licence MIT. It runs the player, whose H5P runtime is GPL-3.0; see the player's -[NOTICE.md](https://github.com/missing-elements/h5p-offline-player/blob/main/packages/player/NOTICE.md). +[NOTICE.md](https://github.com/missing-elements/h5p-toolkit/blob/main/packages/player/NOTICE.md). diff --git a/packages/verify/package.json b/packages/verify/package.json index 80a75573..8a89d629 100644 --- a/packages/verify/package.json +++ b/packages/verify/package.json @@ -5,12 +5,12 @@ "license": "MIT", "repository": { "type": "git", - "url": "git+https://github.com/missing-elements/h5p-offline-player.git", + "url": "git+https://github.com/missing-elements/h5p-toolkit.git", "directory": "packages/verify" }, - "homepage": "https://github.com/missing-elements/h5p-offline-player/tree/main/packages/verify#readme", + "homepage": "https://github.com/missing-elements/h5p-toolkit/tree/main/packages/verify#readme", "bugs": { - "url": "https://github.com/missing-elements/h5p-offline-player/issues" + "url": "https://github.com/missing-elements/h5p-toolkit/issues" }, "publishConfig": { "access": "public" diff --git a/packages/vscode/README.md b/packages/vscode/README.md index 59d777de..62b277a6 100644 --- a/packages/vscode/README.md +++ b/packages/vscode/README.md @@ -74,11 +74,11 @@ VS Code 1.90 or later, on the desktop. VS Code for the Web cannot run the server ## Related -- [h5p-offline-player](https://github.com/missing-elements/h5p-offline-player): the player, a web +- [h5p-offline-player](https://github.com/missing-elements/h5p-toolkit): the player, a web component that plays H5P on any website you host, with no H5P server. -- [h5p-verify](https://github.com/missing-elements/h5p-offline-player/tree/main/packages/verify): +- [h5p-verify](https://github.com/missing-elements/h5p-toolkit/tree/main/packages/verify): checks from the command line that a package plays; `--preview` opens it in your browser. -- [h5p-normalize](https://github.com/missing-elements/h5p-offline-player/tree/main/packages/normalize): +- [h5p-normalize](https://github.com/missing-elements/h5p-toolkit/tree/main/packages/normalize): rewrites a package so that its video streams. ## Licence diff --git a/packages/vscode/package.json b/packages/vscode/package.json index f62a871e..cfb635ca 100644 --- a/packages/vscode/package.json +++ b/packages/vscode/package.json @@ -9,12 +9,12 @@ "icon": "icon.png", "repository": { "type": "git", - "url": "https://github.com/missing-elements/h5p-offline-player.git", + "url": "https://github.com/missing-elements/h5p-toolkit.git", "directory": "packages/vscode" }, - "homepage": "https://github.com/missing-elements/h5p-offline-player/tree/main/packages/vscode#readme", + "homepage": "https://github.com/missing-elements/h5p-toolkit/tree/main/packages/vscode#readme", "bugs": { - "url": "https://github.com/missing-elements/h5p-offline-player/issues" + "url": "https://github.com/missing-elements/h5p-toolkit/issues" }, "engines": { "vscode": "^1.90.0" diff --git a/packages/vscode/scripts/build.mjs b/packages/vscode/scripts/build.mjs index 4630f576..1b12963c 100644 --- a/packages/vscode/scripts/build.mjs +++ b/packages/vscode/scripts/build.mjs @@ -111,7 +111,7 @@ await writeFile( H5P is a trademark of H5P Group. This extension is made by Missing Elements and is not affiliated with or endorsed by H5P Group. -https://github.com/missing-elements/h5p-offline-player/tree/main/packages/vscode +https://github.com/missing-elements/h5p-toolkit/tree/main/packages/vscode ` ) diff --git a/packages/vscode/scripts/package.mjs b/packages/vscode/scripts/package.mjs index 49490d7d..2d5c22a3 100644 --- a/packages/vscode/scripts/package.mjs +++ b/packages/vscode/scripts/package.mjs @@ -17,7 +17,7 @@ const require = createRequire(import.meta.url) const vsce = join(dirname(require.resolve('@vscode/vsce/package.json')), 'vsce') const { name, version } = JSON.parse(await readFile(join(root, 'package.json'), 'utf8')) const out = `${name}-${version}.vsix` -const folder = 'https://github.com/missing-elements/h5p-offline-player' +const folder = 'https://github.com/missing-elements/h5p-toolkit' // As the other packages' prepack does: the repository's licence, in the package. await cp(join(root, '..', '..', 'LICENSE'), join(root, 'LICENSE')) diff --git a/skills/h5p-player-setup/SKILL.md b/skills/h5p-player-setup/SKILL.md index 77e61563..9dc732b7 100644 --- a/skills/h5p-player-setup/SKILL.md +++ b/skills/h5p-player-setup/SKILL.md @@ -143,7 +143,7 @@ attribute, in the browser's storage on that device (or handed to the host with `resume="host"`), never sent. And if they generate or rewrite packages, `npx @missing-elements/h5p-verify@latest course.h5p` checks a package plays before it is published. -The element's API and events: https://github.com/missing-elements/h5p-offline-player/blob/main/docs/api.md -Each install path in full: https://github.com/missing-elements/h5p-offline-player/blob/main/docs/setup.md -Every symptom and its fix: https://github.com/missing-elements/h5p-offline-player/blob/main/docs/troubleshooting.md -Single-worker hosts and upgrades: https://github.com/missing-elements/h5p-offline-player/blob/main/docs/single-worker.md +The element's API and events: https://github.com/missing-elements/h5p-toolkit/blob/main/docs/api.md +Each install path in full: https://github.com/missing-elements/h5p-toolkit/blob/main/docs/setup.md +Every symptom and its fix: https://github.com/missing-elements/h5p-toolkit/blob/main/docs/troubleshooting.md +Single-worker hosts and upgrades: https://github.com/missing-elements/h5p-toolkit/blob/main/docs/single-worker.md diff --git a/skills/h5p-player-setup/references/embed.md b/skills/h5p-player-setup/references/embed.md index 78359bdf..1c5c105e 100644 --- a/skills/h5p-player-setup/references/embed.md +++ b/skills/h5p-player-setup/references/embed.md @@ -59,4 +59,4 @@ browser would connect to an origin the organisation has no data processing agree a GDPR or security review will not pass. For the site's privacy notice, or a reviewer's questions about what is stored, what is sent and -to whom: https://github.com/missing-elements/h5p-offline-player/blob/main/docs/privacy.md +to whom: https://github.com/missing-elements/h5p-toolkit/blob/main/docs/privacy.md diff --git a/skills/h5p-player-setup/references/options.md b/skills/h5p-player-setup/references/options.md index df068211..d27c3177 100644 --- a/skills/h5p-player-setup/references/options.md +++ b/skills/h5p-player-setup/references/options.md @@ -25,7 +25,7 @@ Formulas need `H5P.MathDisplay` in the package, or `libraries="pack"`, which car A site moving from h5p-standalone finds its options here under the same names; the full mapping, including the ones the `.h5p` or the events replace: -https://github.com/missing-elements/h5p-offline-player/blob/main/docs/h5p-standalone.md +https://github.com/missing-elements/h5p-toolkit/blob/main/docs/h5p-standalone.md ## Resume, only when asked for @@ -42,4 +42,4 @@ still not stored. With `resume="host"` and each save sent to a server, `save-int spaces the saves as the H5P plugins do; the default is 10 seconds. The element's full API and events: -https://github.com/missing-elements/h5p-offline-player/blob/main/docs/api.md +https://github.com/missing-elements/h5p-toolkit/blob/main/docs/api.md diff --git a/skills/h5p-player-setup/references/troubleshooting.md b/skills/h5p-player-setup/references/troubleshooting.md index 27bc2390..a02d08f6 100644 --- a/skills/h5p-player-setup/references/troubleshooting.md +++ b/skills/h5p-player-setup/references/troubleshooting.md @@ -16,4 +16,4 @@ | "This content has changed since you last used it. You'll be starting over." | the package at that URL was replaced since the state was saved; the state is keyed by the build | expected, H5P's own dialog; OK drops the old state and the content saves afresh under the new build | Every symptom and its fix, in more detail: -https://github.com/missing-elements/h5p-offline-player/blob/main/docs/troubleshooting.md +https://github.com/missing-elements/h5p-toolkit/blob/main/docs/troubleshooting.md