README.md

libvlc binding for Electron

Demos

• WebChimera.js Renderer Demo
• WebChimera.js Player - Single Video Demo
• WebChimera.js Player - Multiscreen Demo

Docs

• JavaScript API

Known issues and workarounds

• latest Electron versions is not compatible with WebChimera.js on Linux
• libvlc 2.2.x is broken on OS X
• libvlc has compatibility issue with latest Electron/NW.js versions on Windows
• libvlc 2.2.x x64 has issue with subtitles
• Webpack

Prebuilt binaries

• https://github.com/RSATom/WebChimera.js/releases

Using prebuilt on Windows

• download WebChimera.js_*_VLC_*_win.zip corresponding to your engine and extract to node_modules

Using prebuilt on Mac OS X

• download WebChimera.js_*_osx.tar.gz corresponding to your engine and extract to node_modules

Using prebuilt on Linux

• install VLC (for apt based distros: sudo apt-get install vlc)
• npm install webchimera.js --ignore-scripts
• download WebChimera.js_*_linux.zip and extract to webchimera.js\Release

Build Prerequisites

Windows

• Visual Studio Community 2019;
• VLC Player in your PATH environment variable;
• CMake;
• Electron;

Mac OS X

• Apple XCode;
• VLC Player;
• CMake;
• Node.js;
• Electron;

Linux

for apt based distros:

• $ sudo apt-get install build-essential cmake libvlc-dev

Build from sources

Windows

• git clone --recursive https://github.com/RSATom/WebChimera.js.git
• cd WebChimera.js
• build_electron.cmd

Mac OS X & Linux

• git clone --recursive https://github.com/RSATom/WebChimera.js.git
• cd WebChimera.js
• ./build_electron.sh