Web-based tool to help storytellers add images and music to their stories
TypeScript JavaScript HTML CSS
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
backend
frontend
public
robohydra
views
.gitignore
LICENSE
README.md
logo.svg
lyre-big.xcf
package.json

README.md

Lyre

This is a web-based storyteller helper program. It allows a narrator to use images and music to support the storytelling.

The idea is that, for each story, the narrator will prepare a set of images and audio tracks for it. Then, when telling the story, the narrator will use a computer and the audience will use another device, maybe a tablet. As the story progresses, the narrator can play music, and also choose images that will appear on the audience's device. There's also special support for maps, which the narrator will be able to uncover bit by bit and send only the uncovered parts to the audience.

See https://emanchado.github.io/lyre for more information and examples.

Running Lyre

Unfortunately you need a server to run Lyre on. You can use your own computer, but you have to know how to make other devices connect to it (eg. find out your IP). Worst case scenario, you can use Lyre to play the music.

To get started, make sure you have Node and ImageMagick installed and then:

  1. Run npm install to get dependencies.
  2. Create backend/config/local-development.js (see below).
  3. Create the directory stories (or modify the path in the configuration).
  4. Run npm run compile.
  5. Run npm run start.

The contents of local-development.js should at least be:

module.exports = {
    secretPassphrase: "<my secret passphrase>"
};

Once that is done, you will be able to login to Lyre using the above passphrase, at:

http://localhost:3000/

TODO

  • Allow sharing of text bits? How would that work? Would that be saved for the session, so it can be sent again?
  • Allow pasting or dropping an image to share right away, without preparation
  • Change pen size with control + drag
  • Allow narrators to customise the markers per story
  • Highlight unsent map bits?
  • Maybe add security to the narrator WebSocket interaction
  • Find the reordering bug (big deal for playlists!)
  • Reorder scenes

Credits

  • Initial UI sketches by Henrik Johnsen
  • Concept, code, and logo by Esteban Manchado Velázquez
  • Compass icon by jhnri4
  • Most other icons from flaticon.com
  • Map markers by Antifarea, downloaded from opengameart.org

You can assume the good parts of the UI come from the initial sketches, and the bad parts were introduced by Esteban :-)