Skip to content

About

Egatari (絵語り): a file format for narrated, animated lessons — one HTML that plays offline and carries its own editable source

Resources

Stars

2 stars

Watchers

0 watching

Forks

Repository files navigation

Egatari logo: the hiragana え (e, picture) in Japanese corner brackets, its first stroke drawn as a sun

Egatari specification

Egatari (絵語り, "narrating with pictures") is a file format that bundles slides, script, audio and a book into a single HTML file. The file plays offline, narrating itself, and carries its own source so it can be reopened, edited one step at a time, and saved again.

File Content
egatari-1.0.md The format: what a document is and how it is stored in one file (Editor's Draft)
egatari-player-1.0.md Players: display modes, layouts, playback, links, learner data, tracking, embedding (Editor's Draft, versioned separately)
CHANGES.md Dated snapshots (wd-YYYY-MM-DD) and what changed in each
schema/ JSON Schemas (draft 2020-12) for the index, audio records, metadata and deck-meta
bindings/scorm12.md Packaging an Egatari file as a SCORM 1.2 package
extensions.md Registry of extension names (platform-specific data, §9A)
fixtures/ Conformance fixtures and test vectors

The format is named separately from its reference implementation, Egatari Studio (authoring and quality check, at studio.egatari.org), which bundles Egatari Player in the files it writes. The name is written Egatari (絵語り). Files use the extension .ega.html.

The published text is served at https://egatari.org/ from the egatari/egatari.org repository (since 2026-11-13), which builds it from a pinned tag of this repository. Every URL stays as it was, except the front page of the specification, which is now at https://egatari.org/spec/.

Status: Editor's Draft (a working draft by the specification's editors, as in W3C usage) — anything may change before 1.0. Feedback is welcome in Issues.

Check the schemas against the fixtures with npm ci && npm test.

The specification text is licensed under CC BY 4.0; schemas and fixtures under the repository's MIT license.

The logo files are in logo/. They are not covered by the CC BY or MIT licenses: you may use them unmodified to refer to Egatari or to software that reads or writes Egatari files.

About

Egatari (絵語り): a file format for narrated, animated lessons — one HTML that plays offline and carries its own editable source

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages