Browse Source

update docs [no docker]

pull/318/head
Jason Dove 4 years ago
parent
commit
6aeaf65a13
  1. BIN
      docs/images/libraries-edit-icon.png
  2. BIN
      docs/images/local-libraries-edit-icon.png
  3. BIN
      docs/images/shows-add-local-library-path.png
  4. 2
      docs/index.md
  5. 17
      docs/user-guide/add-media-items.md
  6. 27
      docs/user-guide/create-channels.md

BIN
docs/images/libraries-edit-icon.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.8 KiB

BIN
docs/images/local-libraries-edit-icon.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

BIN
docs/images/shows-add-local-library-path.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.7 KiB

After

Width:  |  Height:  |  Size: 9.7 KiB

2
docs/index.md

@ -1,4 +1,4 @@ @@ -1,4 +1,4 @@
![ErsatzTV](../images/ersatztv.png)
![ErsatzTV](images/ersatztv.png)
**ErsatzTV** is pre-alpha software for configuring and streaming custom live channels using your media library. The software is currently unstable and under active development.

17
docs/user-guide/add-media-items.md

@ -3,23 +3,30 @@ Four library kinds are currently supported: [Local](#local-libraries), [Plex](#p @@ -3,23 +3,30 @@ Four library kinds are currently supported: [Local](#local-libraries), [Plex](#p
## Local Libraries
ErsatzTV provides three local libraries, one for each supported media kind: `Movies`, `Shows` and `Music Videos`.
Local libraries provide a way to schedule media directly from folders; no media server is necessary.
### Metadata
With local libraries, ErsatzTV will read metadata from [NFO files](https://kodi.wiki/view/NFO_files), falling back to a *minimal* amount of metadata if NFO files are not found.
### Add Libraries
ErsatzTV provides three local libraries by default, one for each supported media kind: `Movies`, `Shows` and `Music Videos`.
Additional libraries can be added under `Media Sources` > `Local`.
### Add Media Items
To add media items to a local library under `Media` > `Libraries`, click the edit button for the library:
To add media items to a local library under `Media Sources` > `Local`, click the edit button for the library:
![Libraries Edit Icon](../images/libraries-edit-icon.png)
![Local Libraries Edit Icon](../images/local-libraries-edit-icon.png)
Then click the `Add Library Path` button and enter the path where your media files of the appropriate kind are stored:
In the `Path` field, enter the path where your media files of the appropriate kind are stored:
![Add Local Library Path](../images/shows-add-local-library-path.png)
Finally, click `Add Local Library Path` and ErsatzTV will scan and import your media items.
Finally, click `Add Path`.
When you have added all of your media paths, click `Save Changes` and ErsatzTV will scan and import your media items.
## Plex Libraries

27
docs/user-guide/create-channels.md

@ -8,9 +8,10 @@ Channel numbers can be whole numbers or can contain one decimal, like `500` or ` @@ -8,9 +8,10 @@ Channel numbers can be whole numbers or can contain one decimal, like `500` or `
### Streaming Mode
Two streaming modes are currently supported: `MPEG-TS` (Transport Stream) and `HLS Direct` (HTTP Live Streaming Direct).
`MPEG-TS` is considered stable and is recommended for most purposes.
`HLS Direct` is unstable and is not recommended for general use, but can avoid the need to transcode with some clients.
Three streaming modes are currently supported: `MPEG-TS` (Transport Stream), `HLS Direct` (HTTP Live Streaming Direct) and `HLS Hybrid` (HTTP Live Streaming Hybrid).
* `MPEG-TS` transcodes content and supports watermarks, though some clients will have issues at program boundaries
* `HLS Direct` does not transcode content and can perform better on low power systems, but does not support watermarks
* `HLS Hybrid` transcodes content and supports watermarks, and can perform very well at program boundaries with some clients
### FFmpeg Profile
@ -24,15 +25,10 @@ Channel logos can be added using the `Upload Logo` button and the logos will dis @@ -24,15 +25,10 @@ Channel logos can be added using the `Upload Logo` button and the logos will dis
## Create Schedule
Schedules are used to control the playback order of media items on a channel.
Create a Schedule by navigating to the `Schedules` page, clicking `Add Schedule` and giving your schedule a name, a collection playback order, and clicking `Add Schedule` to confirm your selections.
Create a Schedule by navigating to the `Schedules` page, clicking `Add Schedule` and giving your schedule a name, and selecting the appropriate settings:
### Collection Playback Order
Select the desired playback order for media items within each collection in the schedule:
- `Chronological`: Items are ordered by release date, then by season and episode number.
- `Random`: Items are randomly ordered and may contain repeats.
- `Shuffle`: Items are randomly ordered and no item will be played a second time until every item from the collection has been played once.
* `Keep Multi-Part Episodes Together`: This only applies to shuffled schedule items, and will try to intelligently group multi-part episodes (i.e. `s05e02 - whatever part 1` and `s05e03 - whatever part 2`) so they are always scheduled together and always play in the correct order.
* `Treat Collections As Shows`: This only applies when `Keep Multi-Part Episodes Together` is enabled, and will try to group multi-part episodes across shows within the collection (i.e. crossover episodes like `Show 1 - s03e04 - Whatever Part 1` and `Show 2 - s01e07 - Whatever Part 2`).
### Schedule Items
@ -56,11 +52,20 @@ Schedule items can contain the following collection types: @@ -56,11 +52,20 @@ Schedule items can contain the following collection types:
- `Television Show`: Select an entire television show.
- `Television Season`: Select a specific season of a television show.
- `Artist`: Select all music videos for a specific artist.
- `Multi Collection`: Select all collections within a multi-collection.
#### Collection
Based on the selected collection type, select the desired collection.
### Playback Order
Select the desired playback order for media items within the selected collection:
- `Chronological`: Items are ordered by release date, then by season and episode number.
- `Random`: Items are randomly ordered and may contain repeats.
- `Shuffle`: Items are randomly ordered and no item will be played a second time until every item from the collection has been played once.
#### Playout Mode
Select how you want this schedule item to behave every time it is selected for playback.

Loading…
Cancel
Save