mirakurun 4.0.0-beta.9 → 4.1.2

package/.github/instructions/commit-messages.instructions.md

@@ -0,0 +1,44 @@
+---
+description: "Use when writing commit messages, PR titles, or changelog summaries. Enforces the repository's conventional commit format and scope conventions."
+---
+
+# Commit Message Guidelines
+
+- Use the format: `<type>(<scope>): <subject>`
+- Keep the subject short, clear, and in present tense.
+- Prefer Japanese when natural and consistent with the current project context.
+
+## Type
+
+Use one of the following:
+
+- `feat`: new or changed feature
+- `fix`: bug fix
+- `docs`: documentation only
+- `style`: formatting / whitespace / linting
+- `refactor`: structural change without behavior change
+- `test`: tests added or refactored
+- `chore`: maintenance tasks
+- `perf`: performance improvement
+- `ci`: CI/CD changes
+- `revert`: revert a previous commit
+
+## Scope
+
+Use the part of the codebase affected:
+
+- `ui` for UI changes, or `ui/$ClassName` / `ui/$ModuleName`
+- `api` for API changes, or `api/$operationId` / `api/$path`
+- `$ClassName` or `$ModuleName` for other code areas
+
+## Subject
+
+- Summarize the change in one concise line.
+- Prefer action-oriented wording such as "追加", "改善", "修正" when appropriate.
+- Avoid vague words like "update", "fix", or "change" without context.
+
+## Examples
+
+- `chore(package.json): 依存関係のアップデート`
+- `feat(ui/ExampleView): サンプルボタンの追加`
+- `perf(TSFilter): チャンク処理のパフォーマンスを向上`

package/AGENTS.md

@@ -0,0 +1,85 @@
+# AGENTS.md
+
+このリポジトリで作業するエージェント向けのガイドです。対象範囲はリポジトリ全体です。
+
+## 最優先
+
+- 変更前に既存実装と設定を確認する。
+- 不要なリファクタリングや整形変更はしない。
+- 既存の未コミット変更は触らない。明示的な依頼がない限り巻き戻さない。
+- 変更は最小差分で行う。
+
+## プロジェクト概要
+
+Mirakurun は、日本のデジタル TV チューナー向け API サーバーです。Node.js / TypeScript で実装され、サーバー側は Express と express-openapi、Web UI は React 18、React Router、Blueprint UI、Sass、webpack を使用します。
+
+## 主要ディレクトリ
+
+- `src/Mirakurun`: サーバー本体、チューナー管理、EPG、ストリーム処理、設定読み込み。
+- `src/Mirakurun/api`: express-openapi の operation 実装。ファイルパスが API パスに対応。
+- `src/ui`: Web UI。React コンポーネント、ルート、Sass、UI 用 TypeScript 設定。
+- `config`: 既定の設定ファイル。実行時に環境変数や Docker 設定とマージされる場合がある。
+- `doc`: セットアップ、設定、プラットフォーム関連のドキュメント。
+- `test`: Node.js 標準テストランナーのテスト。通常は `lib` のビルド済み JS を読む。
+- `docker`: Dockerfile、Compose 設定、コンテナ初期化スクリプト。
+- `lib`: ビルド出力。必要な場合以外は手編集しない。
+
+## 開発コマンド
+
+- 依存関係のインストール: `npm install`
+- サーバーと UI のビルド: `npm run build`
+- サーバーのみのビルドと TSLint: `npm run build:server`
+- UI の webpack ビルド: `npm run build:webpack`
+- テスト: `npm test`
+- テストの watch 実行: `npm run test:watch`
+- watch ビルド: `npm run watch`
+- 開発起動: `npm run start`
+- デバッグ起動: `npm run debug`
+- クリーンアップ: `npm run clean`
+- Docker ビルド: `npm run docker:build`
+- Docker 起動: `npm run docker:run` または `npm run docker:up`
+- Docker セットアップ起動: `npm run docker:run-setup`
+- Docker コンテナ内シェル: `npm run docker:bash`
+- Docker デバッグ起動: `npm run docker:debug`
+- Docker 停止: `npm run docker:down`
+- Docker ログ: `npm run docker:logs`
+
+テストは `../lib/...` のビルド済み JS を参照することがあります。通常は `npm run build` の後に `npm test` を実行してください。
+
+## コーディング規約
+
+- TypeScript は `tslint.json` に従う。
+- 既存コードに合わせて、ダブルクォート、セミコロン、スペースインデントを使う。
+- 既存ファイルの Apache License ヘッダーは維持する。新規ファイルも周辺に合わせる。
+- 公開 API や型を変える場合は、関連する定義も同時に更新する。
+- JSON レスポンスは既存の `src/Mirakurun/api.ts` の helper を優先する。
+
+## API 変更時の注意
+
+- API の実装は `src/Mirakurun/api/**` に置く。
+- `Operation` と `apiDoc` は既存パターンに合わせる。
+- API パス、レスポンス、リクエスト body、定義型を変える場合は `api.yml` と整合させる。
+- 公開型を変える場合は `api.d.ts` と必要に応じて `index.d.ts` も更新する。
+- ストリーム系 API はチューナー資源、エラー変換、接続終了時の後処理に注意する。
+
+## UI 変更時の注意
+
+- UI は `src/ui/tsconfig.json` と `webpack.config.js` 経由でビルドされる。
+- ルートは `src/ui/index.tsx`、画面実装は主に `src/ui/routes`、共通部品は `src/ui/components` にある。
+- 既存の Blueprint UI、Blueprint Icons、Sass の設計に合わせる。
+- 共有状態や RPC / REST 取得は `src/ui/modules/state.ts` の既存パターンを優先する。
+- UI の表示時刻は Luxon の `Asia/Tokyo` / `ja` 前提を維持する。
+
+## 設定と実行時挙動
+
+- `config/server.yml`, `config/tuners.yml`, `config/channels.yml` は既定値。
+- Docker 実行時は環境変数でサーバー設定が上書き・マージされる。
+- 実機チューナー、DVB/ISDB デバイス、ネットワーク、Unix ドメインソケットに依存する処理は、ローカルで再現できない場合がある。
+- 再現できない場合は、影響範囲を明記して、可能な範囲でユニットテストや静的検証を行う。
+
+## 変更後の確認
+
+- TypeScript / API / UI の変更では、基本的に `npm run build` を実行する。
+- 挙動変更やロジック変更では、`npm run build` 後に `npm test` を実行する。
+- ドキュメントのみの変更では、内容の目視確認でよい。
+- 実行できなかった検証は、最終報告で理由を明記する。

package/CHANGELOG.md

@@ -2,10 +2,190 @@
 
 see [Commit Logs](https://github.com/Chinachu/Mirakurun/commits/master) to check all.
 
-## 4.0.0-beta.9 (2025-03-16)
+## 4.1.2 (2026-06-19)
+
+### Server
+
+- 🐛 TunerDevice: remote decoder を有効にしている場合でも decoder が定義されている場合は remote/local 両方で decoder 処理をしてしまうバグの修正
+
+### UI
+
+- ✨ HomeView: 局ロゴ見切れの修正とその他スタイルの調整
+- ✨ HomeView: サービス一覧から EPG 番組表へのリンクを追加
+
+## 4.1.1 (2026-06-15)
+
+動作環境やユースケースを鑑みて、このバージョンから、このプロジェクトは基本的に日本語を使用します。ドキュメントや UI 等も順次日本語となります。何卒ご了承下さい 🙏
+
+### Known Issues
+
+- **UI**
+  - Home: 旧 UI からの仮移植です。表示崩れや余白不足、局ロゴの見切れがあります。
+
+### Docker
+
+- 🆙 ベースイメージを `node:22.14.0-bookworm` → `node:24.16.0-bookworm` に更新
+
+### Server
+
+- 🆙 Node.js エンジン要件: `^18 || ^20 || ^22` → `^22 || ^24`
+- 👾 Config: allowPNA の型チェックを修正 (*bug*)
+
+### UI
+
+- ✨ Fluent UI から Blueprint へ UI ベースコンポーネントを変更し、UI を刷新
+- 🆕 ライトテーマ / ダークテーマ の切り替え
+- 🆕 EPG, 番組検索, 番組詳細表示
+
+## About 4.0.0
 
 **Important Notice**: Mirakurun 4.0.0 includes significant performance improvements, enhanced EPG processing, asynchronous file I/O operations, and new features. As announced in 3.9.0, the experimental Win32 support has been completely removed.
 
+## 4.0.0-beta.17 (2025-04-11)
+
+### Server Changes
+
+- **Service**:
+  - Fixed a bug in the loading services.
+
+## 4.0.0-beta.17 (2025-04-10)
+
+### Server Changes
+
+- **Server**:
+  - Allow access to the Web UI through the allowOrigins setting.
+- **Channel**:
+  - Fixed a bug in the readyFn of EPG gatherer job.
+- **Tuner**:
+  - Improved readyForJob logic for better tuner selection.
+  - Added logging for tuner selection process.
+- **TunerDevice**:
+  - Added channel type to command template replacement.
+
+## 4.0.0-beta.16 (2025-04-01)
+
+### Server Changes
+
+- **Job**:
+  - Jobs can now be rerun.
+  - Maximum number of runs can now be set.
+- **Config**:
+  - Added: `jobMaxRunning`, `jobMaxStandby` server configs.
+- **API**:
+  - Added: `rerunJob` operations.
+- **UI**:
+  - **JobsView**: Added support to rerun Job.
+  - **ServerConfigurator**: Added job settings.
+
+## 4.0.0-beta.15 (2025-03-30)
+
+Bugfix of `@4.0.0-beta.14`.
+
+## 4.0.0-beta.14 (2025-03-30)
+
+### Key Changes
+
+- **Job/Queue**: Improved background job mechanism for like EPG updates.
+  - **Users can now request EPG updates at any time.**
+  - Job execution schedules can now be set in a **cron-like format**.
+  - <u>Jobs are now executed in parallel</u> according to the number of CPU cores and resource availability.
+  - At the moment, the number of parallel executions is `Math.max(1, Math.floor(os.cpus().length / 2))`, but it will be made configurable in the ~~future~~. → `@4.0.0-beta.16`
+
+### Server Changes
+
+- **Config**:
+  - Added: `programGCJobSchedule`, `epgGatheringJobSchedule` server configs.
+  - Removed: `programGCInterval`, `epgGatheringInterval` server configs. (*breaking change*)
+  - Settings are not migrated. If you have customized, you must re-configure them in cron-like format, which can be changed from the Web UI.
+  - see: [Configuration](doc/Configuration.md) ([日本語](doc/Configuration.ja.md))
+- **API**:
+  - Added: `runJobSchedule`, `abortJob` operations.
+- **UI**:
+  - **JobsView**: added.
+  - **ServerConfigurator**: updated.
+
+## 4.0.0-beta.13 (2025-03-29)
+
+### Docker Changes
+
+- Added `DISABLE_PCSCD` environment variable to disable pcscd service.
+- Added `DISABLE_B25_TEST` environment variable to disable B25 test decoder installation.
+- Updated `docker-compose.yml` - For testing purposes, all devices can be accessed without setting "devices" by default.
+  - **The previous default setting required a restart of the container when the card reader's USB was unplugged and plugged in, but the new default setting restores it automatically.** please check the [docker-compose.yml](docker/docker-compose.yml).
+  - **以前のデフォルト設定では、カードリーダーの USB を抜き差しすると、コンテナの再起動が必要でしたが、今回のデフォルト設定では、自動的に復旧するようになりました。** 設定例は [docker-compose.yml](docker/docker-compose.yml) をご確認ください。
+
+## 4.0.0-beta.12 (2025-03-21)
+
+### Server Changes
+
+- **Server**:
+  - Wait the LISTEN until finishes loading the program and service db at startup.
+- **UI**:
+  - **TunersManager**: packet counter is now hidden when stream info is empty
+
+## 4.0.0-beta.11 (2025-03-20)
+
+### Key Changes
+
+- **Channel Configuration**: Added new `commandVars` property to replace and extend the previous tuner command options
+  - Supports any custom command variables (not limited to predefined keys)
+  - Added support for arguments containing whitespace using quotes
+  - Previous options (`satellite`, `space`, `freq`, `polarity`) are now soft-deprecated but still work - Automatically migrates existing configurations to the new format
+
+  ```yaml
+  # Tuner Device Item Configuration
+  - name: Example-Tuner
+    types:
+      - GR
+    ...
+    command: cmd <channel> --arg1 --arg2 <exampleArg1> <exampleArg2> "<exampleArg3>" -
+
+  # Channel Item Configuration
+  - name: Example-Ch
+    type: GR
+    channel: '123'
+    ...
+    commandVars: # new
+      exampleArg1: -arg0 -arg1=example
+      exampleArg2: -arg2 "whitespace is now supported using quote"
+      exampleArg3: white space
+      ...
+  ```
+  - This implementation is inspired by the [extra-args already implemented in mirakc](https://github.com/mirakc/mirakc/blob/1fbbd9875bcb2de9143e2dc73be8ac6d54ed0965/docs/config.md#channels), but in a different way. This is so that appropriate arguments can be defined even in an environment where different tuner commands are mixed.
+
+### Server Changes
+
+- **API**:
+  - Deprecated several channel configuration properties in favor of the new `commandVars` property
+- **Channel**:
+  - Improved handling of tuner command parameters with expanded configuration options
+  - Migrated from hardcoded parameters to flexible variable substitution
+- **TunerDevice**:
+  - Enhanced command string handling with support for quoted arguments containing whitespace
+  - Improved command template variable substitution
+- **UI**:
+  - **ChannelsConfigurator**: Significantly improved the channel configuration interface
+    - Added visual editor for command arguments with dynamic add/remove capability
+    - Removed column headers for cleaner interface
+    - Automatically migrates deprecated configuration properties to the new format
+
+## 4.0.0-beta.10 (2025-03-17)
+
+### Server Changes
+
+- **Server**:
+  - Added test mode support for unit/integration testing
+  - Added deinit method (not used yet)
+  - Improved server init with proper async handling
+- **API**:
+  - **getTuner**: Fixed 500 error on not found (*bug*)
+
+### Client Changes
+
+- **getDocs**: Added to get API spec docs
+
+## 4.0.0-beta.9 (2025-03-16)
+
 ### Server Changes
 
 - **UI**:

package/README.ja.md

@@ -0,0 +1,125 @@
+[![Mirakurun](https://gist.githubusercontent.com/kanreisa/0ab27d7771e97edce5a24cc81b9b8ce6/raw/8e08d3d91390794b139ed593e3a834a8b41f651c/logo-mirakurun_2025-03-29.svg)](https://github.com/Chinachu/Mirakurun)
+
+# Mirakurun
+
+"Air" (開発中アプリのコードネーム) のために設計された日本のデジタルテレビチューナー API サーバーです。
+
+[![npm version][npm-img]][npm-url]
+[![npm downloads][downloads-image]][downloads-url]
+[![Linux Build][azure-pipelines-img]][azure-pipelines-url]
+[![tip for next commit](https://tip4commit.com/projects/43158.svg)](https://tip4commit.com/github/Chinachu/Mirakurun)
+[![Backers on Open Collective](https://opencollective.com/Mirakurun/backers/badge.svg)](#backers)
+[![Sponsors on Open Collective](https://opencollective.com/Mirakurun/sponsors/badge.svg)](#sponsors)
+
+[**CHANGELOG**](CHANGELOG.md) | [**環境構築**](doc/Platforms.ja.md) | [**設定**](doc/Configuration.ja.md)
+
+[**English**](README.md) | [**日本語**](README.ja.md)
+
+## Docker
+
+[![dockeri.co](https://dockeri.co/image/chinachu/mirakurun)][docker-url]
+
+参照: 利用可能な[タグ一覧](https://hub.docker.com/r/chinachu/mirakurun/tags) (Docker Hub)
+
+## 特徴
+
+- HTTP RESTful API (Swagger / Open API 2.0)
+- 高度なチューナープロセス管理
+- 単一チューニングでの複数ストリーム配信
+- ストリーム優先度
+- MPEG-2 TS パーサー、フィルター
+- リアルタイム EPG パーサー
+- 様々なチューナーデバイスと混合環境に対応 (chardev, DVB / ISDB-T, ISDB-S, DVB-S2)
+- 自動チャンネルスキャン
+- Web UI
+- IPTV サーバー (M3U8 プレイリスト, XMLTV)
+
+#### 図: MPEG-2 TS ストリーム API の多様性
+
+![](https://gist.githubusercontent.com/kanreisa/0ab27d7771e97edce5a24cc81b9b8ce6/raw/7409e229648e00b55404f9e8342dccb58bbb4ac4/mirakurun-fig-api-variety2.svg)
+
+#### 図: ストリームフロー
+
+![](https://gist.githubusercontent.com/kanreisa/0ab27d7771e97edce5a24cc81b9b8ce6/raw/7409e229648e00b55404f9e8342dccb58bbb4ac4/mirakurun-fig-flow-stream2.svg)
+
+## 環境構築
+
+👉 [**環境構築**](doc/Platforms.ja.md)
+
+## 設定
+
+👉 [**設定**](doc/Configuration.ja.md)
+
+## Web UI
+
+```sh
+# 管理 UI
+http://_your_mirakurun_ip_:40772/
+
+# Swagger UI
+http://_your_mirakurun_ip_:40772/api/debug
+```
+
+## クライアント実装
+
+- [Rivarun](https://github.com/Chinachu/Rivarun)
+- [BonDriver_Mirakurun](https://github.com/Chinachu/BonDriver_Mirakurun)
+- Mirakurun クライアント ([組み込み](https://github.com/Chinachu/Mirakurun/blob/master/src/client.ts))
+  - "Air" (開発コードネーム)
+  - [Chinachu γ](https://github.com/Chinachu/Chinachu/wiki/Gamma-Installation-V2)
+  - [EPGStation](https://github.com/l3tnun/EPGStation)
+
+## 貢献
+
+- [CONTRIBUTING.md](CONTRIBUTING.md)
+
+## 寄付
+
+- [Tip4Commit](https://tip4commit.com/github/Chinachu/Mirakurun) (BTC) - すべてのコミッターへ分配されます
+- [Open Collective](https://opencollective.com/Mirakurun) (USD) - プール (使途未定)
+
+## Discord コミュニティ
+
+- 招待リンク: https://discord.gg/X7KU5W9
+
+## Contributors
+
+このプロジェクトは貢献してくださるすべての方々のおかげで成り立っています。
+<a href="https://github.com/Chinachu/Mirakurun/graphs/contributors"><img src="https://opencollective.com/Mirakurun/contributors.svg?width=890&button=false" /></a>
+
+## Backers
+
+すべての Backer の皆様、ありがとうございます！ 🙏 [[Backer になる](https://opencollective.com/Mirakurun#backer)]
+
+<a href="https://opencollective.com/Mirakurun#backers" target="_blank"><img src="https://opencollective.com/Mirakurun/backers.svg?width=890"></a>
+
+## Sponsors
+
+スポンサーになってこのプロジェクトをサポートしてください。あなたのロゴがウェブサイトへのリンクとともにここに表示されます。 [[スポンサーになる](https://opencollective.com/Mirakurun#sponsor)]
+
+<a href="https://opencollective.com/Mirakurun/sponsor/0/website" target="_blank"><img src="https://opencollective.com/Mirakurun/sponsor/0/avatar.svg"></a>
+<a href="https://opencollective.com/Mirakurun/sponsor/1/website" target="_blank"><img src="https://opencollective.com/Mirakurun/sponsor/1/avatar.svg"></a>
+<a href="https://opencollective.com/Mirakurun/sponsor/2/website" target="_blank"><img src="https://opencollective.com/Mirakurun/sponsor/2/avatar.svg"></a>
+<a href="https://opencollective.com/Mirakurun/sponsor/3/website" target="_blank"><img src="https://opencollective.com/Mirakurun/sponsor/3/avatar.svg"></a>
+<a href="https://opencollective.com/Mirakurun/sponsor/4/website" target="_blank"><img src="https://opencollective.com/Mirakurun/sponsor/4/avatar.svg"></a>
+<a href="https://opencollective.com/Mirakurun/sponsor/5/website" target="_blank"><img src="https://opencollective.com/Mirakurun/sponsor/5/avatar.svg"></a>
+<a href="https://opencollective.com/Mirakurun/sponsor/6/website" target="_blank"><img src="https://opencollective.com/Mirakurun/sponsor/6/avatar.svg"></a>
+<a href="https://opencollective.com/Mirakurun/sponsor/7/website" target="_blank"><img src="https://opencollective.com/Mirakurun/sponsor/7/avatar.svg"></a>
+<a href="https://opencollective.com/Mirakurun/sponsor/8/website" target="_blank"><img src="https://opencollective.com/Mirakurun/sponsor/8/avatar.svg"></a>
+<a href="https://opencollective.com/Mirakurun/sponsor/9/website" target="_blank"><img src="https://opencollective.com/Mirakurun/sponsor/9/avatar.svg"></a>
+
+## 著作権 / ライセンス
+
+&copy; 2016- [kanreisa](https://github.com/kanreisa).
+
+- コード: [Apache License, Version 2.0](LICENSE)
+- ドキュメント: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)
+- ロゴ: [CC BY-SA 4.0](https://creativecommons.org/licenses/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

package/README.md

@@ -1,8 +1,8 @@
-[![Mirakurun](https://gist.githubusercontent.com/kanreisa/0ab27d7771e97edce5a24cc81b9b8ce6/raw/e50683f1c4e7d1a13e9ef468f8cc945b0dbc853c/logo-mirakurun.svg)](https://github.com/Chinachu/Mirakurun)
+[![Mirakurun](https://gist.githubusercontent.com/kanreisa/0ab27d7771e97edce5a24cc81b9b8ce6/raw/8e08d3d91390794b139ed593e3a834a8b41f651c/logo-mirakurun_2025-03-29.svg)](https://github.com/Chinachu/Mirakurun)
 
 # Mirakurun
 
-DVR Tuner Server for Japanese TV which designed for the "Air" (in development codename).
+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]
@@ -11,59 +11,44 @@ DVR Tuner Server for Japanese TV which designed for the "Air" (in development co
 [![Backers on Open Collective](https://opencollective.com/Mirakurun/backers/badge.svg)](#backers)
 [![Sponsors on Open Collective](https://opencollective.com/Mirakurun/sponsors/badge.svg)](#sponsors)
 
-## Docker
-
-[![dockeri.co](https://dockeri.co/image/chinachu/mirakurun)][docker-url]
+[**CHANGELOG**](CHANGELOG.md) | [**Setup Guide**](doc/Platforms.md) | [**Configuration**](doc/Configuration.md)
 
-see: available [Tags](https://hub.docker.com/r/chinachu/mirakurun/tags) (Docker Hub)
+[**English**](README.md) | [**日本語**](README.ja.md)
 
-### Quick Install
+## Docker
 
-```sh
-mkdir ~/mirakurun/
-cd ~/mirakurun/
-wget https://raw.githubusercontent.com/Chinachu/Mirakurun/refs/heads/release/4.0.0/docker/docker-compose.yml
-docker compose pull
-docker compose run --rm -e SETUP=true mirakurun
-docker compose up -d
-```
+[![dockeri.co](https://dockeri.co/image/chinachu/mirakurun)][docker-url]
 
-see: [doc/Platforms.md](doc/Platforms.md)
+Reference: List of available [tags](https://hub.docker.com/r/chinachu/mirakurun/tags) (Docker Hub)
 
 ## Features
 
-* RESTful API (Open API) - has designed like HTTP version of Spinel
-* Unix Sockets / TCP
-* Advanced Tuner Process Management
-* Priority Management
-* Tuner Device Pooling
-* Integrated MPEG-2 TS Parser, Filter
-* Realtime EPG Parser
-* Supports most Tuner Devices (chardev, DVB / ISDB-T, ISDB-S, DVB-S2)
-* Channel Scan
-* IPv6 Support
-* [Multiplexing Mirakuruns](doc/Mirakuruns.md)
-* Web UI
-* IPTV Server (M3U8 Playlist, XMLTV)
+- 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
 
-![](https://gist.githubusercontent.com/kanreisa/0ab27d7771e97edce5a24cc81b9b8ce6/raw/e50683f1c4e7d1a13e9ef468f8cc945b0dbc853c/mirakurun-fig-api-variety.svg)
+![](https://gist.githubusercontent.com/kanreisa/0ab27d7771e97edce5a24cc81b9b8ce6/raw/7409e229648e00b55404f9e8342dccb58bbb4ac4/mirakurun-fig-api-variety2.svg)
 
 #### Figure: Stream Flow
 
-![](https://gist.githubusercontent.com/kanreisa/0ab27d7771e97edce5a24cc81b9b8ce6/raw/e50683f1c4e7d1a13e9ef468f8cc945b0dbc853c/mirakurun-fig-flow-stream.svg)
-
-## Requirements / Supported Platforms
+![](https://gist.githubusercontent.com/kanreisa/0ab27d7771e97edce5a24cc81b9b8ce6/raw/7409e229648e00b55404f9e8342dccb58bbb4ac4/mirakurun-fig-flow-stream2.svg)
 
-* [Node.js](http://nodejs.org/) 18, 20, 22
-* Linux w/ [Docker](https://hub.docker.com/r/chinachu/mirakurun)
+## Setup Guide
 
-see: [doc/Platforms.md](doc/Platforms.md)
+👉 [**Setup Guide**](doc/Platforms.md)
 
-## **Install / Update / Uninstall / CLI**
+## Configuration
 
-see: [doc/Platforms.md](doc/Platforms.md)
+👉 [**Configuration**](doc/Configuration.md)
 
 ## Web UI
 
@@ -75,28 +60,27 @@ http://_your_mirakurun_ip_:40772/
 http://_your_mirakurun_ip_:40772/api/debug
 ```
 
-
 ## Client Implementations
 
-* [Rivarun](https://github.com/Chinachu/Rivarun)
-* [BonDriver_Mirakurun](https://github.com/Chinachu/BonDriver_Mirakurun)
-* Mirakurun Client ([Built-in](https://github.com/Chinachu/Mirakurun/blob/master/src/client.ts))
-  * "Air" (in development codename)
-  * [Chinachu γ](https://github.com/Chinachu/Chinachu/wiki/Gamma-Installation-V2)
-  * [EPGStation](https://github.com/l3tnun/EPGStation)
+- [Rivarun](https://github.com/Chinachu/Rivarun)
+- [BonDriver_Mirakurun](https://github.com/Chinachu/BonDriver_Mirakurun)
+- Mirakurun Client ([Built-in](https://github.com/Chinachu/Mirakurun/blob/master/src/client.ts))
+  - "Air" (in development codename)
+  - [Chinachu γ](https://github.com/Chinachu/Chinachu/wiki/Gamma-Installation-V2)
+  - [EPGStation](https://github.com/l3tnun/EPGStation)
 
 ## Contributing
 
-[CONTRIBUTING.md](CONTRIBUTING.md)
+- [CONTRIBUTING.md](CONTRIBUTING.md)
 
-## Supporting
+## Donations
 
-* [Tip4Commit](https://tip4commit.com/github/Chinachu/Mirakurun) (BTC) - to Every Committers
-* [Open Collective](https://opencollective.com/Mirakurun) (USD) - Pool (TBD)
+- [Tip4Commit](https://tip4commit.com/github/Chinachu/Mirakurun) (BTC) - Distributed to all committers
+- [Open Collective](https://opencollective.com/Mirakurun) (USD) - Pool (purpose undecided)
 
 ## Discord Community
 
-* Invitation: https://discord.gg/X7KU5W9
+- Invitation: https://discord.gg/X7KU5W9
 
 ## Contributors
 
@@ -128,11 +112,9 @@ Support this project by becoming a sponsor. Your logo will show up here with a l
 
 © 2016- [kanreisa](https://github.com/kanreisa).
 
-* Code: [Apache License, Version 2.0](LICENSE)
-* Docs: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)
-* Logo: [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/)
-
-**Commercial License / Support** is provided by [Pixely LLC](https://pixely.jp/).
+- Code: [Apache License, Version 2.0](LICENSE)
+- Docs: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)
+- Logo: [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/)
 
 [npm-img]: https://img.shields.io/npm/v/mirakurun.svg
 [npm-url]: https://npmjs.org/package/mirakurun