diff --git a/README.md b/README.md index d89382deb..34657e534 100644 --- a/README.md +++ b/README.md @@ -25,13 +25,12 @@ ## 專案架構 -| 項目 | 值 | -|-----------|-------------------------------| -| Package | `com.fongmi.android.tv` | -| minSdk | 24(Android 7.0 Nougat) | -| targetSdk | 28(Android 9.0 Pie) | -| ABI | `arm64-v8a`、`armeabi-v7a` | -| Flavor | `leanback`(電視版)、`mobile`(手機版) | +| 項目 | 值 | +|---------|-------------------------------| +| package | `com.fongmi.android.tv` | +| minSdk | 24(Android 7.0 Nougat) | +| abi | `arm64-v8a`、`armeabi-v7a` | +| flavor | `leanback`(電視版)、`mobile`(手機版) | ``` TV/ @@ -68,7 +67,7 @@ TV/ ## 直播功能 -- 支援 M3U/M3U8、TXT(`#genre#` 分組)、JSON 三種直播源格式 +- 支援 M3U、TXT(`#genre#` 分組)、JSON 三種直播源格式 - **EPG**:XMLTV 格式(支援 `.gz`),每 6 小時自動刷新 - **追看 / 時移**:`append`、`pltv` 等多種類型 - 頻道收藏、隱藏分組密碼保護 @@ -92,7 +91,7 @@ TV/ - **DoH**:DNS over HTTPS,支援 Bootstrap IP - **代理**:HTTP / HTTPS / SOCKS4 / SOCKS5,依 host 正則規則動態選擇 -- **hosts**:DNS 解析覆蓋,支援萬用字元 `*` +- **Hosts**:DNS 解析覆蓋,支援萬用字元 `*` - **CORS 注入**:依 host 規則在回應中注入自訂標頭 - **廣告攔截**:`ads` 黑名單,符合域名直接攔截 - **WebView 嗅探**:Sniffer 以 regex 攔截媒體 URL;支援 UA 偽裝 @@ -116,7 +115,7 @@ TV/ ## 配置說明 -VOD 配置為應用主要入口,透過 URL 或本地路徑載入,頂層欄位定義: +Vod 配置為應用主要入口,透過 URL 或本地路徑載入,頂層欄位定義: - 點播站點(`sites`)、解析規則(`parses`) - 直播來源(`lives`) @@ -130,6 +129,6 @@ Live 配置可內嵌或獨立存放。完整欄位說明見 [CONFIG.md](docs/CON | 文件 | 說明 | |-----------------------------|----------------------| -| [CONFIG.md](docs/CONFIG.md) | VOD / Live 完整配置欄位說明 | +| [CONFIG.md](docs/CONFIG.md) | Vod / Live 完整配置欄位說明 | | [SPIDER.md](docs/SPIDER.md) | Spider 所有方法規格與回傳格式 | | [LOCAL.md](docs/LOCAL.md) | 本地 HTTP API 所有端點完整說明 | diff --git a/docs/CONFIG.md b/docs/CONFIG.md index a2866aa65..270ff5c09 100644 --- a/docs/CONFIG.md +++ b/docs/CONFIG.md @@ -1,12 +1,12 @@ # 配置說明 -本文件說明 VOD(點播)與 Live(直播)配置檔案的 JSON 結構與各欄位意義。 +本文件說明 Vod(點播)與 Live(直播)配置檔案的 JSON 結構與各欄位意義。 --- ## 目錄 -- [VOD 配置(VodConfig)](#vod-配置vodconfig) +- [Vod 配置(VodConfig)](#vod-配置vodconfig) - [頂層欄位](#頂層欄位) - [sites — 點播來源](#sites--點播來源) - [parses — 解析規則](#parses--解析規則) @@ -28,9 +28,9 @@ --- -## VOD 配置(VodConfig) +## Vod 配置(VodConfig) -VOD 配置為一個 JSON 物件,作為應用程式的主要配置入口。配置可透過 URL、本地路徑或直接貼入字串的方式載入。 +Vod 配置為一個 JSON 物件,作為應用程式的主要配置入口。配置可透過 URL、本地路徑或直接貼入字串的方式載入。 ### 頂層欄位 @@ -153,7 +153,7 @@ VOD 配置為一個 JSON 物件,作為應用程式的主要配置入口。配 ### lives — 直播來源 -VOD 配置中的 `lives` 欄位用於指向外部直播配置或內嵌直播資訊。每個物件為一個 `Live` 來源,欄位定義與 [Live 配置頂層欄位](#頂層欄位-1) 相同。 +Vod 配置中的 `lives` 欄位用於指向外部直播配置或內嵌直播資訊。每個物件為一個 `Live` 來源,欄位定義與 [Live 配置頂層欄位](#頂層欄位-1) 相同。 常見用法為指定 `url` 指向外部 `live.json`,或直接內嵌 `groups` 頻道資料。 @@ -161,7 +161,7 @@ VOD 配置中的 `lives` 欄位用於指向外部直播配置或內嵌直播資 ## Live 配置(LiveConfig) -Live 配置可以是獨立的 JSON 檔案,或內嵌於 VOD 配置的 `lives` 陣列中。 +Live 配置可以是獨立的 JSON 檔案,或內嵌於 Vod 配置的 `lives` 陣列中。 獨立的 `live.json` 頂層支援以下欄位: @@ -169,11 +169,11 @@ Live 配置可以是獨立的 JSON 檔案,或內嵌於 VOD 配置的 `lives` |-----------|-----------------|-------------------------------------------------| | `spider` | `string` | 全局 Spider JAR 路徑,提供給所有 `lives` 作為預設爬蟲。 | | `lives` | `array` | 直播來源清單,欄位定義見下表。 | -| `proxy` | `array` | 代理設定,同 VOD 配置。詳見 [proxy](#proxy--代理伺服器)。 | -| `rules` | `array` | 攔截規則,同 VOD 配置。詳見 [rules](#rules--網路攔截規則)。 | -| `headers` | `array
` | 注入標頭,同 VOD 配置。詳見 [headers](#headers--注入回應標頭)。 | -| `hosts` | `array` | DNS 覆蓋規則,同 VOD 配置。詳見 [hosts](#hosts--dns-解析覆蓋)。 | -| `ads` | `array` | 廣告過濾清單,同 VOD 配置。詳見 [ads](#ads--廣告過濾)。 | +| `proxy` | `array` | 代理設定,同 Vod 配置。詳見 [proxy](#proxy--代理伺服器)。 | +| `rules` | `array` | 攔截規則,同 Vod 配置。詳見 [rules](#rules--網路攔截規則)。 | +| `headers` | `array
` | 注入標頭,同 Vod 配置。詳見 [headers](#headers--注入回應標頭)。 | +| `hosts` | `array` | DNS 覆蓋規則,同 Vod 配置。詳見 [hosts](#hosts--dns-解析覆蓋)。 | +| `ads` | `array` | 廣告過濾清單,同 Vod 配置。詳見 [ads](#ads--廣告過濾)。 | ### 頂層欄位 @@ -299,15 +299,15 @@ Live 配置可以是獨立的 JSON 檔案,或內嵌於 VOD 配置的 `lives` ## 共用欄位物件 -以下物件可在 VOD 配置或 Live 配置的對應陣列欄位中使用。 +以下物件可在 Vod 配置或 Live 配置的對應陣列欄位中使用。 -> `doh` 僅 VOD 配置支援,其餘欄位兩者均可使用。 +> `doh` 僅 Vod 配置支援,其餘欄位兩者均可使用。 --- ### doh — DNS over HTTPS -設定加密 DNS 解析伺服器,保護 DNS 查詢隱私並防止污染。僅 VOD 配置支援。 +設定加密 DNS 解析伺服器,保護 DNS 查詢隱私並防止污染。僅 Vod 配置支援。 | 欄位 | 類型 | 說明 | |--------|-----------------|-------------------------------------------------------| @@ -512,7 +512,7 @@ scheme://username:password@host:port ### style — 卡片樣式 -設定 VOD 來源的內容卡片顯示樣式。 +設定 Vod 來源的內容卡片顯示樣式。 | 欄位 | 類型 | 說明 | |---------|----------|-----------------------------------------------------| @@ -576,7 +576,7 @@ scheme://username:password@host:port ## 完整範例 -### VOD 配置(config.json) +### Vod 配置(config.json) ```json {