readme

2024-09-20 13:14:22 +08:00
parent fa085f1b95
commit 90029f6a2f
2 changed files with 85 additions and 13 deletions
--- a/README.md
+++ b/README.md
@@ -7,6 +7,11 @@
 - 频道 [t.me/uzvideoplay](https://t.me/uzvideoplay)
 - 群组 [t.me/uzVideoApp](https://t.me/uzVideoApp)

+#### 视频源扩展
+> 添加方式
+ 
+uz影视 -> 设置 -> 数据管理 -> 视频源 -> 小齿轮 -> 添加源列表 -> 输入链接 -> 确定
+
 [大佬扩展源](https://mirror.ghproxy.com/https://raw.githubusercontent.com/Yswag/uzVideo/main/js/spider_sources.json)

 [视频源](https://mirror.ghproxy.com/https://raw.githubusercontent.com/YYDS678/uzVideo/main/video_sources_default.json)
@@ -17,6 +22,12 @@

 [色色源](https://mirror.ghproxy.com/https://raw.githubusercontent.com/YYDS678/uzVideo/main/video_sources_sese.json)

+#### 首页推荐扩展
+> 添加方式
+ 
+uz影视 -> 设置 -> 数据管理 -> 推荐扩展 -> 小齿轮 -> 添加 -> 输入链接 -> 确定
+
+[豆瓣推荐首页](https://mirror.ghproxy.com/https://raw.githubusercontent.com/YYDS678/uzVideo/refs/heads/main/js/recommendHome.json)

 # 编写 uz 可执行的扩展

--- a/js/README.md
+++ b/js/README.md
@@ -1,16 +1,32 @@
-# 编写 uz 可执行的扩展
+- [扩展说明](#扩展说明)
+- [uzVideo(视频源) 扩展运行说明](#uzvideo视频源-扩展运行说明)
+- [uzHome(首页推荐) 扩展运行说明](#uzhome首页推荐-扩展运行说明)
+- [加密说明](#加密说明)
+- [修改记录](#修改记录)
+    - [v1.5.50](#v1550)
+    - [v1.5.40](#v1540)
+    - [v1.4.00](#v1400)
+    - [v1.3.00](#v1300)

-1. 感谢您的关注，由于作者对 js 了解甚少，所以内置的代码不够全面。**如果您要编写 uz 可执行的扩展需要添加代码或其他问题，可以联系[机器人](https://t.me/uzVideoAppbot)**
-2. uzCode.js 内部定义了一些类和方法，您需要在扩展中实现 WebApiBase 的所有方法
-3. uz 内部仅有一个运行时，所有 js 代码（包括扩展）都在一起加载执行。所以您的扩展内类名一定要特殊，实例名称也要特殊
-4. 不支持 import export
-5. 集成库可在 `uz3lib.js` 查看，如需添加其他库通用库请联系[机器人](https://t.me/uzVideoAppbot)
-6. 成对使用 `// ignore` uz 内部会忽略包裹的内容
-7. 为您的扩展编写以下 json 配置文件
+# 扩展说明
+
+1. 感谢您的关注，由于作者对 `js` 了解甚少，所以内置的代码不够全面。**如果您要编写 uz 可执行的扩展需要添加代码或其他问题，可以联系[机器人](https://t.me/uzVideoAppbot)**
+2. `uzVideo.js` 为视频源扩展，提供观看视频的能力。内部定义了一些类和方法，您需要在扩展中实现 `WebApiBase` 的所有方法。
+3. `uzHome.js` 为首页推荐扩展，提供视频推荐能力。
+4. uz 内部仅有一个运行时，所有 `js` 代码（包括扩展）都在一起加载执行。所以您的扩展内类名一定要特殊，实例名称也要特殊
+5. 不支持 `import` `export`
+6. 集成库可在 `uz3lib.js` 查看，如需添加其他库通用库请联系[机器人](https://t.me/uzVideoAppbot)
+7. 成对使用 `// ignore` uz 内部会忽略包裹的内容
+
+# uzVideo(视频源) 扩展运行说明
+
+1. 执行每个方法都会为 `webSite` 进行赋值
+2. json 文件说明

 ```
 {
  "name": "名称",
+  "codeID": "如果选择了加密请填写，由 uz 生成",
  "api": "扩展链接",
  "instance": "实例名称",
  "webSite": "视频站地址。当加载代码时会赋值给对象的 webSite 属性，用户可自行在 app 内修改",
@@ -20,13 +36,9 @@
  "isLock": false, // 是否上锁 默认false(即不上锁)，用户可自行在 app 内修改
  "blockClassList": ["短剧"] // 屏蔽分类，用户可自行在 app 内修改
 }
-
 ```

-# 扩展运行说明
-
-1. 执行每个方法都会为 `webSite` 进行赋值
-2. 流程图
+3. 流程图

 ```mermaid

@@ -55,8 +67,57 @@ graph TD

 ```

+# uzHome(首页推荐) 扩展运行说明
+
+1. 固定实例名称为 `uzHomeJs` （例如 const uzHomeJs = new UZHomeJS();）
+2. json 文件说明
+
+```
+{
+  "name": "名称",
+  "codeID": "如果选择了加密请填写，由 uz 生成",
+  "url": "扩展链接"
+}
+```
+
+3. 如需添加更多 UI 类型，请联系[机器人](https://t.me/uzVideoAppbot)
+4. 流程图
+
+```mermaid
+
+graph TD
+
+  A[开始] --> A1[uz 调用 getHome 获取首页 tab 分类] -->|返回数据 RepHome| B[调用 getTab 获取 tab 页数据]
+
+  B -->|返回 RepTabList.data | C[展示推荐视频数据]
+
+  B -->|返回 RepTabList.filter| D[展示筛选标签，随后调用 getFilterList] -->|返回 RepVideoList| E[展示筛选视频数据]
+
+  C --> F
+
+  E --> F
+
+  F[结束，点击视频 uz 开始搜索]
+
+
+```
+
+# 加密说明
+
+1. 您的扩展代码由 uz 进行加密，并生成 `codeID` 用于扩展解密。
+2. `codeID` 每次都是随机生成，不可指定。请将 `codeID` 添加进 `json` 文件内。
+3. app 设置页 `sid` 为用户标识，卸载、重置等情况下可能会发生变化。
+4. `VerifyLink` `SaltApp2Backend` `SaltBackend2App` 为选填项，用于控制谁 `sid` 可以添加使用您开发的扩展。(仅在添加时进行验证)。
+5. 推荐使用 `cloudflare worker` 进行验证。
+6. 验证相关代码请见 `verifyServer.js` 请注意修改 `salt` 及 `sid` 验证逻辑。
+
 # 修改记录

+### v1.5.50
+
+1. 支持使用 uz 加密扩展，加密后请将 `codeID` 填写在 `json` 文件内。
+2. 新增首页推荐扩展类型 `uzHome.js`
+
 ### v1.5.40

 1. `req` 支持设置 `responseType` 值为字符串 `json、arraybuffer、bytes、plain、stream`