loomse

Logo

(Loom) (S)tory (E)ngine

Interactive storytelling for the modern web - create your script in Loom, tell multiple tales

What is LoomSE?

LoomSE is a client side HTML5 video and event manager. Events can be scheduled to fire during video playback, which your application can subscribe to and use. By interacting with the API you can then direct how the video should play, or even which video should play next.

One script, multiple stories

With loomse, content creators can tell interactive stories over the modern web. Create your script in loomse, tell multiple tales.

Quick start guide

npm i loomse
HTML
<div id="loomse"></div>

Optionally, you can also import the styles into your project

<link rel="stylesheet" href="node_modules/loomse/dist/styles.css" />
JavaScript
(async () => {
    const response = await fetch("/story-script.json");
    const json = await response.json();
    const loomse = createStory(parent, json);
})();

To learn more about building a script, see building your story

Dependencies

Under the hood, Loomse uses the RE:DOM library to handle DOM interactions.

For parsing subtitle files, Loomse uses Simple Subtitle Parser

API

Visit the API reference

Terminology

Script

Like the script in a play, a script is the blueprint for a story. Contains the story and metadata.

Story

A collection of scenes

Scene

Part of a story

The project

loomse is an engine for weaving stories together. Began by Franco Speziali in 2015, loomse was named in part as homage to the surrounding industrial history of Manchester, but also as a nod to the 1990 graphical adventure Loom.

Pronunciation

{ loom-see }