Seil0/Project-HomeFlix
Seil0
/
Project-HomeFlix
1
0
Fork 0
Code Issues 7 Pull Requests Releases 4 Wiki Activity

Update page 'Documentation'

Jannik 2019-03-16 00:32:06 +01:00
parent 0b5f875621
commit 531f4cf0ef
1 changed files with 0 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
Documentation.md

@ -29,48 +29,6 @@ If you want to use the omdb API you'll need to add a `apiKeys.json` in /resource
* Apache Log4j 2: https://logging.apache.org/log4j/2.x/
* OMDb API: https://www.omdbapi.com/
## 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"
}
]
}
```
## 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.