A website for selecting shows to watch on VLC locally
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
client
readme Add images to README #30 Feb 7, 2019
server Added missing null check Feb 18, 2019
.gitignore Add react frontend, updating project structure Jan 14, 2018
.travis.yml
LICENSE Initial commit Jan 14, 2018
README.md Allow user to update MAL source from UI #57 Feb 17, 2019
VideoViewer.bat
package-lock.json Minimise webpack bundle #55 Feb 19, 2019
package.json Minimise webpack bundle #55 Feb 19, 2019
webpack.config.coffee Minimise webpack bundle #55 Feb 19, 2019

README.md

Web-VLC

Build Status

A website for selecting shows to watch locally on VLC.

Mobile Friendly List Your Shows! Control VLC Remotely!

Features

  • Configure a list of video locations
  • Automatically recognise series and seasons
  • Automatically load poster art, plot and more from IMDB and MyAnimeList
  • Volume and seek controls from your browser
  • Play next video without leaving your seat
  • Modern UI and design, perfect for any device
  • Download episodes through your browser
  • So many configuration options

Configuration

There are a couple mandatory settings required to make this app work on your system.

  1. Enable the VLC API as per the VLC configuration section below.
  2. Set up the minimal App configuration: vlc.command and files.locations.
  3. Compile and run the app with npm i; npm run complete.
  4. Check the command line output for more information.

There are a ton of configuration options, please read the below carefully if you want to play with the options.

VLC configuration

VLC must be configured to expose it's web API.

To do this, check the following setting.

  1. Tools > Preferences
  2. At the bottom for Show settings, check All
  3. Interface > Main interfaces
  4. Check the web checkbox
  5. Interface > Main interfaces > Lua
  6. Enter a password into Lua HTTP > Password. (This password goes into the app configuration below)
  7. Save
  8. Close and re-open VLC
  9. Accept the network prompt if shown
  10. Navigate to http://localhost:8080 to see if it worked

App configuration

Copy server/config.example.yaml to server/config.yaml.

Edit server/config.yaml with your defaults.

Ensure the vlc.command works in your console.

Copy the paths to your videos into files.locations as per below.

Setting up Folders and API Data

The for the app to pick up your videos you need to add a list of folders to the configuration. This is stored in the files.locations section.

The folders should be separated by the API you would like to use. For example, I have a folder containing all anime, and another containing all movies / traditional TV series so that one can use the MAL API and the other IMDB (via OMBd). See below for more information about APIs.

Example:

files:
  watch: true
  # The locations of the video files
  locations:
    - folder: "E:\\Videos\\Anime"
      api: "mal"
    - folder: "C:\\Users\\MichaelSta\\Videos"
      api: "omdb"

If you do not specify an api, none will be used.

See Video file structure section below for information about how to store the videos on your disk.

Folder Watching

The application watches for changes in the supplied folders by default. To disable this, change the value at files.watch to false.

Ignore Hidden Folders and Files

Hidden folders and files can be ignored. This can be changed with the value at files.ignoreHidden, and is enabled by default.

Secure HTTPS

To ensure HTTPS set the value of server.secure in server/config.yaml to true.

Copy your private key to server/cert/private.pem. Copy your certificate to server/cert/public.pem.

For more information on how to generate these keys for your site you can check out this blog post about Let's Encrypt.

Enable downloading

To enable a download ⤓ button for each video, set the value of client.downloadEnabled in server/config.yaml to true.

Enable streaming

To enable a stream ≋ button for each video, set the value of client.streamEnabled in server/config.yaml to true.

Skip amount

The skip forward / backward buttons on the app are configurable with the parameter client.skipSeconds.

The default value is 20 for 20 seconds.

Edit API Source

Sometimes the API show detection is not accurate. Enabling this flag will let the user correct the API source from the application.

This feature is enabled by default.

This feature currently only supports MAL API sources.

API - OMDb

OMDb is an API for IMDb. Using this feature will add plot and rating information for each of your shows.

This feature is disabled by default.

To enable this feature, optain a key from the OMDb website and add it to the setting api.omdb.key, then set the api.omdb.enabled flag to enabled.

API - MAL

MyAnimeList is by far the best source of anime information. Using this feature will add plot and rating information for each of your shows.

This feature is disabled by default.

To enable this feature, set the api.mal.enabled flag to enabled.

Please note that MyAnimeList has a very relaxed search feature which may result in poor matches.

API - Cache Period

Data returned from the APIs are cached for a number of days.

This number of days is configurable with the configuration parameter api.cacheDays.

This feature is set to 30 by default.

Video file structure

Files must be organised like so:

Show Name
  - Season x
    - video_episode_xx.ext

Season folder may be omitted. There is some intelligence to detect episode number, otherwise the video name can be anything.

Usage

Install dependencies.

npm i

Edit server/config.yaml with your defaults.

Build everything and run in a single command, because you are lazy.

npm run complete

Navigate to the application at http://localhost:3000. Note your path may be different if you changed the config.

Development

Watch for CoffeeScript changes.

npm run coffee-watch

Watch for Webpack changes.

npm run webpack-watch

Run server watching for changes.

npm run start-watch

Support on Beerpay

Hey dude! Help me out for a couple of 🍻!

Beerpay Beerpay