README.md
author ymh <ymh.work@gmail.com>
Fri, 18 Oct 2024 10:24:57 +0200
changeset 1074 231ea5ea7de4
parent 1072 ac1eacb3aa33
permissions -rw-r--r--
change http to https for default thumb

This is the README for MetaDataPlayer, an opensource web player with metadata support.

Features
========

    o Reads json-converted cinelab metadata
    o Reads from Youtube, Dailymotion and Flash backends
    o Loads the data as JSON as well as JSONP
    
Prerequisite
============

- node + npm
- `$ npm install`

Building the library
====================

The library files are scattered in many files. 
It is built with vite.
- `$ npm run build`

The result of the build is in the dist/ folder.

Running the examples
====================

- `npm dev`

or for building the dist:
- `vite build -w` + `python -m http.server 5173`


The code
========

The code is scattered among several files, which are concatenated and minified during the
build process. The html templates in the templates/ directory are also "jsified" during
this process, to be used by the js code.

**TODO:** finish the migration of the examples and widgets. Replace the JwPlayer widget with an open source js video player that can play youtube and wimeo videos. Adapt  the AdaptivePlayer accordingly.