Mirakurun

A Japanese digital TV tuner API server specifically designed for "Air" (code name of the app in development).

[![npm version][npm-img]][npm-url]
[![npm downloads][downloads-image]][downloads-url]
[![Linux Build][azure-pipelines-img]][azure-pipelines-url]

CHANGELOG | Setup Guide | Configuration

English | 日本語

Docker

![dockeri.co][docker-url]

Reference: List of available tags (Docker Hub)

Features

- HTTP RESTful API (Swagger / Open API 2.0)
- Advanced tuner process management
- Multiple stream broadcasting from a single tuning
- Stream priority
- MPEG-2 TS parser, filter
- Real-time EPG parser
- Support for various tuner devices and hybrid environments (chardev, DVB / ISDB-T, ISDB-S, DVB-S2)
- Automatic channel scanning
- Web UI
- IPTV server (M3U8 playlist, XMLTV)

#### Figure: Variety of the MPEG-2 TS Stream API


#### Figure: Stream Flow


Setup Guide

👉 Setup Guide

Configuration

👉 Configuration

Web UI

``sh

Admin UI

http://_your_mirakurun_ip_:40772/

Swagger UI

http://_your_mirakurun_ip_:40772/api/debug
``

Client Implementations

- Rivarun
- BonDriver_Mirakurun
- Mirakurun Client (Built-in)
- "Air" (in development codename)
- Chinachu γ
- EPGStation

Contributing

- CONTRIBUTING.md

Donations

- Tip4Commit (BTC) - Distributed to all committers
- Open Collective (USD) - Pool (purpose undecided)

Discord Community

- Invitation: https://discord.gg/X7KU5W9

Contributors

This project exists thanks to all the people who contribute.

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

Copyright / License

© 2016- kanreisa.

- Code: Apache License, Version 2.0
- Docs: CC BY 4.0
- Logo: CC BY-SA 4.0

[npm-img]: https://img.shields.io/npm/v/mirakurun.svg
[npm-url]: https://npmjs.org/package/mirakurun
[downloads-image]: https://img.shields.io/npm/dm/mirakurun.svg?style=flat
[downloads-url]: https://npmjs.org/package/mirakurun
[azure-pipelines-img]: https://dev.azure.com/chinachu/Mirakurun/_apis/build/status/Chinachu.Mirakurun?branchName=master
[azure-pipelines-url]: https://dev.azure.com/chinachu/Mirakurun/_build/latest?definitionId=1&branchName=master
[docker-url]: https://hub.docker.com/r/chinachu/mirakurun