Visuado player core

Visuado player core is an HDR enabled media player that is backwards compatible with the Gen2.5 file format. It comes with a myriad of additional features including HDR support, full post-processing stack, 3D hybrid rendering system, and an improved UI with smoother user action response.

Please note, the _testdata and assets/demo folders are included for testing purposes only and does not need to be installed on the server.

Features

• HDR Support: Supports HDR through either EXR or the proprietary QHDR format.
• Full Post Processing Stack: Enhances the overall quality of media playback.
• 3D Hybrid Rendering System: Allows real-time 3D to mix with pre-rendered 3D.
• Improved UI: Offers a smoother user action response.

Dependencies

The following project and development dependencies are required:

Project Dependencies:

• three.js (Version ^0.152.2): A popular 3D library to create and display animated 3D computer graphics on a Web browser.
• pako (Version ^2.1.0): A high-speed zlib port to JavaScript, works in browser and node.js.
• jszip (Version ^3.7.1): A library for creating, reading, and editing .zip files with JavaScript.

Development Dependencies:

• webpack (Version ^5.84.1): A static module bundler for modern JavaScript applications.
• webpack-cli (Version ^5.1.1): The command line interface for Webpack.
• webpack-dev-server (Version ^4.15.0): Serves a webpack app, updates the browser on changes.
• typescript (Version ^5.0.4): A typed superset of JavaScript that compiles to plain JavaScript.
• ts-loader (Version ^9.4.3): TypeScript loader for Webpack.
• babel-loader (Version ^9.1.2): Allows transpiling JavaScript files using Babel and Webpack.
• @babel/core (Version ^7.22.1): The core compiler for Babel.
• copy-webpack-plugin (Version ^11.0.0): Copies individual files or entire directories to the build directory.
• html-webpack-plugin (Version ^5.5.1): Simplifies the creation of HTML files to serve your Webpack bundles.
• terser-webpack-plugin (Version ^5.3.9): Minifies your JavaScript.
• @types/three and @types/pako: Type definitions for three.js and pako, respectively.

Setup and Installation

To set up the project and install necessary dependencies, follow the steps below:

1. Clone the repository.

2. Navigate to the project's root directory.

3. Run the command: npm install

   This will install all the required packages.

4. To start the development server, run: npm start 4.1 This repo has some parts that use rust to compile wasm. Wasm compilation is disabled by default. If you are working on the part related to rust/ wasm, please use npm run start:wasm

5. To build the project for production, run: npm run build

Publish to npm

After you have build the project. You'll see a dist directory. The dist directory has its own package.json. Go to the dist directory and run

Run this command and you will release the latest update to npm.

Remember, this repo does not have a CI/CD builder. When you run the following command, the code is build on your own machine and everything is pushed to github repo. However, we are trying to keep the version of this library in npm and the git tag in sync. The release script should take care of that automatically.

The build command compiles the code and creates a dist folder. The dist folder is then packed and pushed to npm.

The _testdata and assets/demo folders are deleted from the library before it is published to npm.

npm run release