Giter VIP home page Giter VIP logo

bloomplayer's Introduction

LegacyBloomPlayer

We are trying to retire this repo, which has been replaced by bloom-player. The single-page javascript is still used by the current version of BloomReader (1.X), which we are also trying to retire. Please don't use it for any new Bloom projects!

Navigate Bloom books while basking in sound and motion

  1. One output, bloomPlayer.js, is consumed by the Bloom Desktop project for the Cmd Line Interface option -hydrate. When dropped into a Bloom Book html file, it should provide a basic "player" that work in browsers and phone apps.

  2. A second output, bloomPagePlayer.js, contains only the code for dealing with a single page and is consumed by the BloomReader Android app.

The BloomPlayer handles:

  • turning pages
  • adjusting to device screens

In addition, for Bloom books with multimedia content, BloomPlayer handles:

  • playing narration (from Bloom's Talking Book Tool)
  • highlighting sentences as you listen to narration
  • Ken Burns-style animation (from Bloom's Motion Tool)
  • background music (from Bloom's Music Tool)
  • playing videos (from Bloom's Sign Language Tool)

Dependencies

Node version >= 5.0 and NPM >= 3**.

Building

npm install
webpack

For a continuous build:

webpack -w

For a production build:

npm run build:prod

Testing with a book while hacking on the code

You'll need to get a Bloom book, then add a link with a path to the bloomPlayer.js in it. There are a couple ways to do that:

If you will be using a file system URL, you can do:

<script src="path-to-bloomPlayer/output/bloomPlayer.js"></script>

But that doesn't work well if you're testing via a server. If instead you set up a hardlink so that it looks like the file is there:

mklink /H bloomPlayer.js the-path-to-the-actual-bloomPlayer.js # windows example

then you can just put

<script src="bloomPlayer.js"></script>

and it will always use your latest, whether you're running from a server or the file system.

bloomplayer's People

Contributors

andrew-polk avatar gmartin7 avatar hatton avatar johnthomson avatar rjconrad avatar stephenmcconnel avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.