diff --git a/Home.md b/Home.md index 2d7cf72..53cd501 100644 --- a/Home.md +++ b/Home.md @@ -1,51 +1,93 @@ -# Welcome to the Project-HomeFlix wiki! - -## Installation - -Download the compiled .jar file and execute it, HomeFlix will ask for the first source you want to add, and load all films found in there. Additional sources can be added via the settings window. - -## Player -Since version 0.7.0 "toothless dragon", HomeFlix uses the JavaFX Media-Player to play your films. Currently this player only supports videos with h264 as codec and mp4 as container. All other videos are played with your standard video player (Windows and OS X) or vlc(Linux). The integrated Player supports features such as Auto-play for series or saving your progress for each film. - -## Streaming -In HomeFlix 0.3.7 "plasma bucket" a basic streaming support has been integrated. This allows you to sort your favorite streaming title in HomeFlix. -The streaming URL and a few other parameters are saved in a .json file. -Here is a example of this file: -``` json -{ - "entries":[ - { - "title":"Big Buck Bunny", - "season":"", - "episode":"", - "streamUrl":"http://distribution.bbb3d.renderfarming.net/video/mp4/bbb_sunflower_2160p_60fps_normal.mp4" - }, - { - "title":"Caminandes", - "season":"1", - "episode":"1", - "streamUrl":"http://www.caminandes.com/download/01_llama_drama_1080p.mp4" - }, - { - "title":"Caminandes", - "season":"1", - "episode":"2", - "streamUrl":"http://www.caminandes.com/download/02_gran_dillama_1080p.mp4" - } -] -} -``` - -## FAQ -* HomeFlix isn't starting after update. - * Delete the _config.xml_ file and start HomeFlix again **(your settings will be deleted!)**. -* I can't choose a main color. - * Try restarting HomeFlix. -* HomeFlix hangs or doesn't response. - * Try restarting HomeFlix. and check the movie names. -* I can't start HomeFlix under Linux. - * Check your Java version. Oracle Java 9 is required. -* The Updater doesn't work. - * We changed the update URL so you have to download HomeFlix again. -* Are my settings saved if I'm going to update or reinstall? +# Welcome to the Project-HomeFlix wiki! + +## Installation + +Download the compiled .jar file and execute it, HomeFlix will ask for the first source you want to add, and load all films found in there. Additional sources can be added via the settings window. + +## Player +Since version 0.7.0 "toothless dragon", HomeFlix uses the JavaFX Media-Player to play your films. Currently this player only supports videos with h264 as codec and mp4 as container. All other videos are played with your standard video player (Windows and OS X) or vlc(Linux). The integrated Player supports features such as Auto-play for series or saving your progress for each film. + +## Streaming +In HomeFlix 0.3.7 "plasma bucket" a basic streaming support has been integrated. This allows you to sort your favorite streaming title in HomeFlix. +The streaming URL and a few other parameters are saved in a .json file. +Here is a example of this file: +``` json +{ + "entries":[ + { + "title":"Big Buck Bunny", + "season":"", + "episode":"", + "streamUrl":"http://distribution.bbb3d.renderfarming.net/video/mp4/bbb_sunflower_2160p_60fps_normal.mp4" + }, + { + "title":"Caminandes", + "season":"1", + "episode":"1", + "streamUrl":"http://www.caminandes.com/download/01_llama_drama_1080p.mp4" + }, + { + "title":"Caminandes", + "season":"1", + "episode":"2", + "streamUrl":"http://www.caminandes.com/download/02_gran_dillama_1080p.mp4" + } +] +} +``` + +## Series support +The series support is divided in two parts. +1. Series support for local files +If you want HomeFlix to automatically detect the series correctly you must use the following **folder** structure: +* **Main Film-Directory** + * Film 1 + * Film 2 + * **Series Name** + * **Season 1** + * Episode 1 + * Episode 2 + * **Season 2** + * Film 3 + +2. Series support for streaming +If you want to add a new series using the HomeFlix streaming support, you have to use the following scheme: + +``` +{ +[ + { + "title":"Caminandes", + "season":"1", + "episode":"1", + "streamUrl":"http://www.caminandes.com/download/01_llama_drama_1080p.mp4" + }, + { + "title":"Caminandes", + "season":"1", + "episode":"2", + "streamUrl":"http://www.caminandes.com/download/02_gran_dillama_1080p.mp4" + }, + { + "title":"Caminandes", + "season":"1", + "episode":"3", + "streamUrl":"http://www.caminandes.com/download/03_caminandes_llamigos_1080p.mp4" + } +] +} +``` + +## FAQ +* HomeFlix isn't starting after update. + * Delete the _config.xml_ file and start HomeFlix again **(your settings will be deleted!)**. +* I can't choose a main color. + * Try restarting HomeFlix. +* HomeFlix hangs or doesn't response. + * Try restarting HomeFlix. and check the movie names. +* I can't start HomeFlix under Linux. + * Check your Java version. Oracle Java 9 is required. +* The Updater doesn't work. + * We changed the update URL so you have to download HomeFlix again. +* Are my settings saved if I'm going to update or reinstall? * As long as you don't delete the HomeFlix folder or the _config.xml_ file, yes. \ No newline at end of file