mirror of
https://github.com/4gray/iptvnator.git
synced 2026-10-08 17:06:15 -08:00
87 lines
4.1 KiB
Markdown
87 lines
4.1 KiB
Markdown
# IPTVnator - IPTV Player Application
|
||
|
||
<p align="center">
|
||
<img src="https://raw.githubusercontent.com/4gray/iptvnator/electron/src/assets/icons/favicon.256x256.png" alt="IPTVnator icon" title="Free IPTV player application" />
|
||
</p>
|
||
<p align="center">
|
||
<a href="https://github.com/4gray/iptvnator/releases"><img src="https://img.shields.io/github/release/4gray/iptvnator.svg?style=for-the-badge&logo=appveyor" alt="Release"></a> <img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/4gray/iptvnator/Build%20and%20release?style=for-the-badge"> <a href="https://github.com/4gray/iptvnator/releases"><img src="https://img.shields.io/github/downloads/4gray/iptvnator/total?style=for-the-badge&logo=appveyor" alt="Releases"></a> <a href="https://codecov.io/gh/4gray/iptvnator"><img alt="Codecov" src="https://img.shields.io/codecov/c/github/4gray/iptvnator?style=for-the-badge"></a>
|
||
</p>
|
||
|
||
**IPTVnator** is a video player application that provides support for the playback of IPTV playlists (m3u, m3u8). The application allows to import playlists by using remote URLs or per file upload from the file system. Additionally there is a support of EPG information XMLTV-based which can be provided by URL.
|
||
|
||
The application is an cross-platform and open source project based on Electron and Angular.
|
||
|
||
|
||
|
||
## Features
|
||
|
||
- M3u and M3u8 playlists support 📺
|
||
- Upload playlists from a file system 📂
|
||
- Add remote playlists via URL 🔗
|
||
- Open playlist from the file system
|
||
- Search for channels 🔍
|
||
- EPG support (TV Guide) with detailed info
|
||
- TV archive/catchup/timeshift
|
||
- Group-based channels list
|
||
- Save channels as favorites
|
||
- HTML video player with hls.js support or Video.js based player
|
||
- Internalization, currently 3 languages are supported (en, ru, de)
|
||
- Set custom "User Agent" header for a playlist
|
||
- Light and Dark theme
|
||
|
||
## Screenshots:
|
||
|
||
| Welcome screen: Playlists overview | Main player interface with channels sidebar and video player |
|
||
| :----------------------------------------------------------: | :-------------------------------------------------------: |
|
||
|  |  |
|
||
| Welcome screen: Add playlist via file upload | Welcome screen: Add playlist via URL |
|
||
|  |  |
|
||
|
||
*Note: First version of the application which was developed as a PWA is available in an extra git branch.*
|
||
|
||
## Download
|
||
|
||
Download the latest version of the application for macOS, Windows and Linux from the [release page](https://github.com/4gray/iptvnator/releases).
|
||
|
||
**IPTVnator** is also available as a snap package:
|
||
|
||
```
|
||
$ sudo snap install iptvnator
|
||
```
|
||
|
||
[](https://snapcraft.io/iptvnator)
|
||
|
||
<a href="https://www.buymeacoffee.com/4gray" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-green.png" alt="Buy Me A Coffee" width="185"></a>
|
||
|
||
## How to build
|
||
|
||
Requirements: node.js with npm.
|
||
|
||
1. Clone this repository and install all project dependencies with:
|
||
```
|
||
$ npm install
|
||
```
|
||
|
||
2. To build the application on your local machine use one of the following commands:
|
||
```
|
||
# linux
|
||
$ npm run electron:build:linux
|
||
```
|
||
|
||
```
|
||
#mac
|
||
$ npm run electron:build:mac
|
||
```
|
||
|
||
```
|
||
# windows
|
||
$ npm run electron:build:windows
|
||
```
|
||
|
||
This command will produce the distributable assets in the `release` folder based on the configuration from electron-builder which is stored in `electron-builder.json` and `package.json`. Check the [API description of electron-builder](https://www.electron.build/) and adapt the configuration if you need some special configuration for you environment.
|
||
|
||
*Note: Don’t expect that you can build app for all platforms on one platform. [Read details](https://www.electron.build/multi-platform-build)*
|
||
|
||
## Disclaimer
|
||
|
||
IPTVnator doesn't provide any playlists or other digital content. |