Browse Source

update readme, dev docs, add swagger icon

pull/1/head
Jason Dove 4 years ago
parent
commit
faa9c5c89c
  1. 7
      ErsatzTV/Shared/MainLayout.razor
  2. 57
      README.md
  3. 25
      docs/development.md
  4. BIN
      docs/ersatztv-ui-channels.png

7
ErsatzTV/Shared/MainLayout.razor

@ -10,10 +10,10 @@ @@ -10,10 +10,10 @@
<MudText Typo="Typo.h5" Class="ml-3">ErsatzTV</MudText>
<MudAppBarSpacer/>
<MudTooltip Text="Channels M3U">
<MudIconButton Icon="fa fa-file-video" Color="Color.Inherit" Link="/iptv/channels.m3u" Target="_blank"/>
<MudIconButton Icon="@Icons.Custom.FileFormats.FileVideo" Color="Color.Inherit" Link="/iptv/channels.m3u" Target="_blank"/>
</MudTooltip>
<MudTooltip Text="EPG XMLTV">
<MudIconButton Icon="fa fa-file-code" Color="Color.Inherit" Link="/iptv/xmltv.xml" Target="_blank"/>
<MudIconButton Icon="@Icons.Custom.FileFormats.FileCode" Color="Color.Inherit" Link="/iptv/xmltv.xml" Target="_blank"/>
</MudTooltip>
<MudTooltip Text="Discord">
<MudIconButton Icon="fab fa-discord" Color="Color.Inherit" Link="https://discord.gg/hHaJm3yGy6" Target="_blank"/>
@ -21,6 +21,9 @@ @@ -21,6 +21,9 @@
<MudTooltip Text="GitHub">
<MudIconButton Icon="@Icons.Custom.Brands.GitHub" Color="Color.Inherit" Link="https://github.com/jasongdove/ErsatzTV" Target="_blank"/>
</MudTooltip>
<MudTooltip Text="OpenAPI">
<MudIconButton Icon="@Icons.Material.Filled.Api" Color="Color.Inherit" Link="/swagger" Target="_blank"/>
</MudTooltip>
</MudAppBar>
<MudDrawer @bind-Open="_drawerOpen" Elevation="2">
<MudNavMenu>

57
README.md

@ -1,50 +1,43 @@ @@ -1,50 +1,43 @@
# ErsatzTV
ErsatzTV is pre-alpha software for configuring and streaming custom live channels using your own media. The software is currently unstable and under active development.
**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.
## Features
## Current Features
- Multiple content sources
- Local files and [NFO metadata](https://kodi.wiki/view/NFO_files) (mostly working)
- [Plex](https://www.plex.tv/) content and metadata (under active development)
- [Jellyfin](https://jellyfin.org/) content and metadata (future)
- IPTV server and [HDHomeRun](https://info.hdhomerun.com/info/http_api) emulation support a wide range of client applications
- Plex Live TV (via HDHomeRun emulation)
- [Channels](https://getchannels.com/) (via IPTV server)
- [TiviMate IPTV Player](https://play.google.com/store/apps/details?id=ar.tvplayer.tv)
- Use local media files and optional sidecar [NFO metadata](https://kodi.wiki/view/NFO_files); no need for a full media server
- IPTV server and HDHomeRun emulation support a wide range of client applications
- Channel-specific streaming mode (MPEG-TS or HLS) and transcoding settings
- Automatic creation of television media collections
- Powerful scheduling options such as chronological collection playback throughout the day or over multiple days
- OpenAPI spec for easy scripting from other languages (available while running at `/swagger/v1/swagger.json`)
- Command line project for easy shell scripting
## Screenshots
## In Development
### Plex Live TV
- [Plex](https://www.plex.tv/) media, metadata and collections
- Published Docker image
![Plex Live TV Stream](docs/plex-live-tv-stream.png)
Sintel is © copyright Blender Foundation | durian.blender.org
## Development
## Planned Features
### Requirements
- [Jellyfin](https://jellyfin.org/) media, metadata and collections
- Meta collections to logically group other collections
- Run as a Windows service
- Spots to fill unscheduled gaps
- [.NET 5.0](https://dotnet.microsoft.com/download)
- [ffmpeg and ffprobe](https://ffmpeg.org/download.html)
## Preview
### Run server
### ErsatzTV UI
```shell
cd ErsatzTV
dotnet run
```
![ErsatzTV UI](docs/ersatztv-ui-channels.png)
### Run tests
### Plex Live TV
```shell
dotnet test
```
![Plex Live TV Stream](docs/plex-live-tv-stream.png)
Sintel is © copyright Blender Foundation | durian.blender.org
### Cleanup code
## Development
```shell
./scripts/cleanup-code.sh
```
See [development documentation](docs/development.md).
## License

25
docs/development.md

@ -0,0 +1,25 @@ @@ -0,0 +1,25 @@
## Development
### Requirements
- [.NET 5.0](https://dotnet.microsoft.com/download)
- [ffmpeg and ffprobe](https://ffmpeg.org/download.html)
### Run server
```shell
cd ErsatzTV
dotnet run
```
### Run tests
```shell
dotnet test
```
### Cleanup code
```shell
./scripts/cleanup-code.sh
```

BIN
docs/ersatztv-ui-channels.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.8 KiB

Loading…
Cancel
Save