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
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1030
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
     1
This is the README for MetaDataPlayer, an opensource web player with metadata support.
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
     2
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
     3
Features
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
     4
========
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
     5
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
     6
    o Reads json-converted cinelab metadata
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
     7
    o Reads from Youtube, Dailymotion and Flash backends
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
     8
    o Loads the data as JSON as well as JSONP
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
     9
    
1072
ac1eacb3aa33 Migrate source and build to vite.js
ymh <ymh.work@gmail.com>
parents: 1030
diff changeset
    10
Prerequisite
1030
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    11
============
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    12
1072
ac1eacb3aa33 Migrate source and build to vite.js
ymh <ymh.work@gmail.com>
parents: 1030
diff changeset
    13
- node + npm
ac1eacb3aa33 Migrate source and build to vite.js
ymh <ymh.work@gmail.com>
parents: 1030
diff changeset
    14
- `$ npm install`
1030
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    15
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    16
Building the library
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    17
====================
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    18
1072
ac1eacb3aa33 Migrate source and build to vite.js
ymh <ymh.work@gmail.com>
parents: 1030
diff changeset
    19
The library files are scattered in many files. 
ac1eacb3aa33 Migrate source and build to vite.js
ymh <ymh.work@gmail.com>
parents: 1030
diff changeset
    20
It is built with vite.
ac1eacb3aa33 Migrate source and build to vite.js
ymh <ymh.work@gmail.com>
parents: 1030
diff changeset
    21
- `$ npm run build`
ac1eacb3aa33 Migrate source and build to vite.js
ymh <ymh.work@gmail.com>
parents: 1030
diff changeset
    22
ac1eacb3aa33 Migrate source and build to vite.js
ymh <ymh.work@gmail.com>
parents: 1030
diff changeset
    23
The result of the build is in the dist/ folder.
1030
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    24
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    25
Running the examples
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    26
====================
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    27
1072
ac1eacb3aa33 Migrate source and build to vite.js
ymh <ymh.work@gmail.com>
parents: 1030
diff changeset
    28
- `npm dev`
ac1eacb3aa33 Migrate source and build to vite.js
ymh <ymh.work@gmail.com>
parents: 1030
diff changeset
    29
ac1eacb3aa33 Migrate source and build to vite.js
ymh <ymh.work@gmail.com>
parents: 1030
diff changeset
    30
or for building the dist:
ac1eacb3aa33 Migrate source and build to vite.js
ymh <ymh.work@gmail.com>
parents: 1030
diff changeset
    31
- `vite build -w` + `python -m http.server 5173`
ac1eacb3aa33 Migrate source and build to vite.js
ymh <ymh.work@gmail.com>
parents: 1030
diff changeset
    32
1030
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    33
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    34
The code
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    35
========
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    36
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    37
The code is scattered among several files, which are concatenated and minified during the
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    38
build process. The html templates in the templates/ directory are also "jsified" during
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    39
this process, to be used by the js code.
1072
ac1eacb3aa33 Migrate source and build to vite.js
ymh <ymh.work@gmail.com>
parents: 1030
diff changeset
    40
ac1eacb3aa33 Migrate source and build to vite.js
ymh <ymh.work@gmail.com>
parents: 1030
diff changeset
    41
**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.