diff --git a/Documentation.md b/Documentation.md index 5d161c0..9bfa174 100644 --- a/Documentation.md +++ b/Documentation.md @@ -1,82 +1,82 @@ -## Build -Project-HomeFlix uses maven to manage all dependencies and to build the Software. In order to build Project-HomeFlix -make sure you have installed [Maven](https://maven.apache.org/). - -Clone Project-HomeFlix -`git clone https://github.com/Seil0/Project-HomeFlix.git` - -go to the root folder of Project-HomeFlix and execute the following command -`mvn package` - -The final package can be found in /target. - -If you want to use the omdb API you'll need to add a `apiKeys.json` in /resources -``` json -{ - "omdbAPIKey":"YOURKEY", - "tmdbAPIKey":"YOURKEY" -} -``` - -## Used libraries and apis -* JFoenix: https://github.com/jfoenixadmin/JFoenix -* minimal-json: https://github.com/ralfstx/minimal-json -* sqlite-jdbc: https://github.com/xerial/sqlite-jdbc -* apache commons io: https://commons.apache.org/proper/commons-io/ -* Apache Log4j 2: https://logging.apache.org/log4j/2.x/ -* OMDb API: https://www.omdbapi.com/ - -## Series support -The series support is currently wip, it 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" - } -] -} -``` - -## Naming-schema since HomeFlix 0.7 -New HomeFlix (major) release series are named after a special naming schema. The name must be connected to a movie or a series (it shouldn't be to obvious). The name should have to parts, at first a verb like "toothless" and as second part a noun like "dragon". If there is more than one suggestion, we will vote which one we will taken. A new name is always used with a new version, but a new version doesn't always get a new code name. - -Code Names: -* bucket (0.3.7 - 0.4.0) -* cow (0.5.0 - 0.5.2) -* vampire (0.6 series) -* toothless dragon (0.7 series) -* fearless trollhunter (0.8 series) -* hidden klimpaloon (0.9 series) - +## Build +Project-HomeFlix uses maven to manage all dependencies and to build the Software. In order to build Project-HomeFlix +make sure you have installed [Maven](https://maven.apache.org/). + +Clone Project-HomeFlix +`git clone https://github.com/Seil0/Project-HomeFlix.git` + +go to the root folder of Project-HomeFlix and execute the following command +`mvn package` + +The final package can be found in /target. + +If you want to use the omdb API you'll need to add a `apiKeys.json` in /resources +``` json +{ + "omdbAPIKey":"YOURKEY", + "tmdbAPIKey":"YOURKEY" +} +``` + +## Used libraries and apis +* JFoenix: https://github.com/jfoenixadmin/JFoenix +* minimal-json: https://github.com/ralfstx/minimal-json +* sqlite-jdbc: https://github.com/xerial/sqlite-jdbc +* apache commons io: https://commons.apache.org/proper/commons-io/ +* Apache Log4j 2: https://logging.apache.org/log4j/2.x/ +* OMDb API: https://www.omdbapi.com/ + +## Series support +The series support is currently wip, it 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" + } +] +} +``` + +## Naming-schema since HomeFlix 0.7 +New HomeFlix (major) release series are named after a special naming schema. The name must be connected to a movie or a series (it shouldn't be to obvious). The name should have to parts, at first a verb like "toothless" and as second part a noun like "dragon". If there is more than one suggestion, we will vote which one we will taken. A new name is always used with a new version, but a new version doesn't always get a new code name. + +Code Names: +* bucket (0.3.7 - 0.4.0) +* cow (0.5.0 - 0.5.2) +* vampire (0.6 series) +* toothless dragon (0.7 series) +* fearless trollhunter (0.8 series) +* hidden klimpaloon (0.9 series) + #homeflixisbetterthannetflix \ No newline at end of file