Skip to content

Commit

Permalink
Change Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
slaveofcode committed May 6, 2020
1 parent 9a862e0 commit 105adde
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,20 @@
<img src="https://raw.github.com/slaveofcode/voodio/master/assets/Voodio.png" align="right" />
# Voodio (Private Media Server)
Voodio is a Simple Private Media Server based on your local Movie Directories. It just a simple program doing tracking on your "Movies" folder, create an index and showing the movies as a web UI to play streamly through the browser.
Voodio is a Simple Private Media Server based on your local Movie Directories. It just a simple program doing tracking on your "Movies" folder, create an index and showing the movies via Web UI to play streamly through the browser.

## Background
I always wanted to watch my old movie collection that saved on my external hardisk or on my PC drive. But unfortunately I'am too lazy to open my computer and starting to crawl and watch those movies. I always wonder if I could see those movies as a webpage, click the detail and play, like I'm watching on the Netfl*x, but the movie is based on my collection.
I always wanted to watch my old movie collection that saved on my external hardisk or on my PC drive. But unfortunately I'am too lazy to open my computer, starting to crawl and watch those movies. I always wonder if I could see those movies as a Website, click the detail and play, like I'm watching on the Netfl*x, but the movie is on local Hard Drive.

## Application Behavior
This application will need extra space like **8-10x** of the played video which extracted from FFmpeg transcoding/transmuxing process of **HLS** files, so then you can play it streamly through your favourite device via **Browser**. The space will be cleand up after the server is turned of (killed), it will be immediatelly deletes all the generated HLS files so you can get the disk again at the end.
This application will need extra space like **8-10x** of the played video which extracted from FFmpeg transcoding/transmuxing process of **HLS** files, the space needed could be lower if there a less available resolution generated (like only for 480p or 720o), then you can play it streamly through your local network on your favourite device via **Browser**. The space will be cleand up after the server is turned of (killed), it will be immediatelly deletes all the generated HLS files so you get the space again.

## Installation

### Have FFMPEG installed on your OS

Visit [FFmpeg Official Download](https://www.ffmpeg.org/download.html) page to install based on your current OS. FFmpeg is available for **Windows**, **Mac** and **Linux**
Visit [FFmpeg Official Download](https://www.ffmpeg.org/download.html) page to install based on your current OS. FFmpeg is available for **Windows**, **Mac** and **Linux**. Please use FFmpeg with version below **4.0** or better with version **3.***.

FFmpeg with version >= 4.1 had an issue of immediatelly generate playlist file (**.m3u8**), then do update periodically at transcoding time, I don't know why that's happen, but I think there's a solution for that, just need a more time to find out.

### Using Precompiled Binary

Expand All @@ -37,7 +39,7 @@ If the configuration and steps above is complete, you can heads up to http://[yo
- `-ffmpeg-bin` (optional) The path of FFmpeg binary, if you have a different path of FFmpeg

### Screenshot
<img src="https://raw.github.com/slaveofcode/voodio/master/assets/home.jpg" align="center" />
<img src="https://raw.github.com/slaveofcode/voodio/master/assets/home.png" align="center" />
<img src="https://raw.github.com/slaveofcode/voodio/master/assets/detail.png" align="center" />
<img src="https://raw.github.com/slaveofcode/voodio/master/assets/play.png" align="center" />

Expand Down
Binary file modified assets/detail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed assets/home.jpg
Binary file not shown.
Binary file added assets/home.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/play.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 105adde

Please sign in to comment.