bybrooklyn/tunarr
1
0
Fork 0
mirror of https://github.com/chrisbenincasa/tunarr.git synced 2026-04-18 09:03:35 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Christian Benincasa
2024-04-09 13:46:20 -04:00
parent 7f580e5a0c
commit 5ddfb7da25
1 changed files with 17 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@@ -27,31 +27,31 @@ Tunarr has the following goals:
- Modernize the stack, both backend and frontend
- Provide an migration path for existing users
- Stabilize the program, fix bugs, and improve performance
- Stabilize the program, fix bugs, and improve performance (Tunarr currently is developed and tested on Node 20.11.1, which offers [non-trivial performance improvements](https://blog.rafaelgss.dev/state-of-nodejs-performance-2023) over previous versions)
- Modernize and "prettify" the Web UI
- And of course, **Add a ton great new features!**
## Features
- "Spoofing" HDHR tuner and a IPTV channel list, providing a large amount of flexibility
- **NEW** Stream your channels directly in the [browser using HLS](https://github.com/chrisbenincasa/tunarr/pull/116) (and soon [MPEG-DASH](https://github.com/chrisbenincasa/tunarr/issues/129))
- **NEW** [Dark mode!](https://github.com/chrisbenincasa/tunarr/pull/34)
- **NEW** Quickly find content you want for your channels with [advanced filtering and sorting](https://github.com/chrisbenincasa/tunarr/pull/210)
- Spoofed HDHR tuner and a IPTV channel list, providing a large amount of flexibility
- Ease of setup for xteve and Plex playback by mocking a HDHR server.
- Configure your channels once, and play them just the same in any of the other devices.
- Customize your channels and what they play. Make them display their logo while they play. Play filler content ("commercials", music videos, prerolls, channel branding videos) at specific times to pad time.
- Docker image and prepackage binaries for Windows, Linux and Mac.
- Supports Nvidia for hardware encoding, including in Docker.
- Select media (desired programs and commercials) across multiple Plex servers
- Deep channel customization. Make channels display a logo, play filler content ("commercials", music videos, prerolls, channel branding videos) at specific times to pad time, and more!
- Docker image and prepackaged binaries for Windows, Linux, and Mac OS
- Use Nvidia for hardware encoding, including in Docker.
- Source content from multiple Plex servers
- Includes a WEB TV Guide where you can even play channels in your desktop by using your local media player.
- Subtitle support.
- Auto deinterlace any Plex media not marked `"scanType": "progressive"`
- Can be configured to completely force Direct play, if you are ready for the caveats.
- **NEW** Stream your channels directly in the browser using HLS (and soon [MPEG-DASH](https://github.com/chrisbenincasa/tunarr/issues/129))
- **NEW** Dark mode!
- Subtitle support
- Auto-deinterlace support for Plex media
- Force Direct Play (with caveats)
## Limitations
- If you want to play the TV channels in Plex using the spoofed HDHR, Plex pass is required.
- Like dizqueTV, Tunarr does not currently watch your Plex server for media updates/changes. You must manually remove and re-add your programs for any changes to take effect. Same goes for Plex server changes (changing IP, port, etc).. You'll have to update the server settings manually in that case. **NOTE** This feature is actively under development!
- Most players (including Plex) will break after switching episodes if video / audio format is too different. Tunarr can be configured to use ffmpeg transcoding to prevent this, but that costs resources.
- Like dizqueTV, Tunarr does not currently watch your Plex server for media updates/changes. You must manually remove and re-add your programs for any changes to take effect. Same goes for Plex server changes (changing IP, port, etc).. You'll have to update the server settings manually in that case. **NOTE** This feature is actively under development! (https://github.com/chrisbenincasa/tunarr/issues/15)
- Most players (including Plex) will break after switching episodes if video / audio format is too different. Tunarr can be configured to use ffmpeg transcoding to prevent this, at the cost of system resources
## Releases
@@ -63,7 +63,7 @@ Tunarr has the following goals:
## Development
[pnpm](https://pnpm.io) and [turbo](https://turbo.build/) are used for package management and development. More details on the development environment, setup, and contributing to come!
[pnpm](https://pnpm.io), [turbo](https://turbo.build/), and [vite](https://vitejs.dev/) are used for package management and development. More details on the development environment, setup, and contributing to come!
### Start dev servers
@@ -73,6 +73,8 @@ Run from the root of the project:
pnpm turbo dev
```
After the servers are running, the backend should be available at `localhost:8000` and the frontend at `localhost:5173/web`.
## License
- The original dizqueTV is released under zlib license (c) 2020 Victor Hugo Soliz Kuncar: we've kept this.