sjb/docs/tutorial.md

使用教程

English | 中文

步骤一：Fork 本项目

将本仓库的源代码复制至个人账号仓库中

1. 首页点击 Fork：

2. Fork 创建个人仓库：

1. 个人仓库命名，可按您喜欢的名字随意命名（最终直播源结果链接取决于该名称），这里以默认 TV 为例
2. 确认信息无误后，点击确认创建

步骤二：修改模板

当您在步骤一中点击确认创建，成功后会自动跳转到您的个人仓库。这个时候您的个人仓库就创建完成了，可以定制个人的直播源频道菜单了！

1. 点击 demo.txt 模板文件：

2. 创建个人模板 user_demo.txt：

1. 创建文件
2. 模板文件命名为 user_demo.txt
3. 模板文件需要按照（频道分类,#genre#），（频道名称,频道接口）进行编写，注意是英文逗号
4. 点击 Commit changes...进行保存

步骤三：修改配置

跟编辑模板一样，修改运行配置

1. 点击 config.py 配置文件：

2. 复制默认配置文件内容：

3. 新建个人配置文件 user_config.py：

1. 创建文件
2. 配置文件命名为 user_config.txt
3. 粘贴默认模板，修改 source_file = "user_demo.txt"；final_file = "user_result.txt"
4. 点击 Commit changes...进行保存

按照您的需要适当调整配置，以下是默认配置说明

配置项	默认值	描述
source_file	"demo.txt"	模板文件名称
final_file	"result.txt"	生成文件名称
favorite_list	["CCTV1","CCTV13"]	关注频道名称列表（仅用于与常规频道区分，自定义获取分页数量）
favorite_page_num	6	关注频道获取分页数量
default_page_num	4	常规频道获取分页数量
urls_limit	15	单个频道接口数量
response_time_weight	0.5	响应时间权重值（所有权重值总和应为 1）
resolution_weight	0.5	分辨率权重值 （所有权重值总和应为 1）
recent_days	30	获取最近时间范围内更新的接口（单位天），适当减小可避免出现匹配问题
ipv_type	"ipv4"	生成结果中接口的类型，可选值："ipv4"、"ipv6"、"all"
domain_blacklist	["https://epg.pw"]	接口域名黑名单，用于过滤低质量含广告类域名的接口
url_blacklist_keywords	[]	接口关键字黑名单，用于过滤含特定字符的接口

步骤四：开启自动更新

如果您的模板和配置修改没有问题的话，这时就可以配置 Actions 来实现自动更新啦

1. 进入 Actions：

2. 开启 Actions 工作流：

由于 Fork 的仓库 Actions 工作流是默认关闭的，需要您手动确认开启，点击红框中的按钮确认开启

开启成功后，可以看到目前是没有任何工作流在运行的，别急，下面开始运行您第一个更新工作流

3. 运行更新工作流：

（1）启用 update schedule：

1. 点击 Workflows 分类下的 update schedule
2. 由于 Fork 的仓库工作流是默认关闭的，点击 Enable workflow 按钮确认开启

（2）根据分支运行 Workflow：

这个时候就可以运行更新工作流了

1. 点击 Run workflow
2. 这里可以切换您要运行的仓库分支，由于 Fork 默认拉取的是 master 分支，如果您修改的模板和配置也在 master 分支，这里选择 master 就好了，点击 Run workflow 确认运行

（3）Workflow 运行中：

稍等片刻，就可以看到您的第一条更新工作流已经在运行了！ （注意：由于运行时间取决于您的模板频道数量以及页数等配置，也很大程度取决于当前网络状况，请耐心等待，默认模板与配置一般需要 25 分钟左右。）

（4）Workflow 取消运行：

如果您觉得这次的更新不太合适，需要修改模板或配置再运行，可以点击 Cancel run 取消本次运行

（5）Workflow 运行成功：

如果一切正常，稍等片刻后就可以看到该条工作流已经执行成功（绿色勾图标）。此时您可以访问代理文件链接，查看最新结果有没有同步即可： https://mirror.ghproxy.com/raw.githubusercontent.com/您的github用户名/仓库名称（对应上述Fork创建时的TV）/master/user_result.txt

如果访问该链接能正常返回更新后的接口内容，说明您的直播源接口链接已经大功告成了！将该链接复制粘贴到 TVBox 等软件配置栏中即可使用~

• 注意：除了首次执行工作流需要您手动触发，后续执行（默认每隔 12 小时）将自动触发。如果您修改了模板或配置文件想立刻执行更新，可手动触发（2）中的 Run workflow 即可。

步骤五：修改工作流更新频率

如果您想修改更新频率（默认 12 小时），可修改 on:schedule:- cron 字段。不建议更新频率过高，因为短时间内的接口并无差异。

步骤六：更新源代码

由于本项目将持续迭代优化，如果您想获取最新的更新内容，可进行如下操作

1. Star

在我的仓库首页点击收藏该项目（您的 Star 是我持续更新的动力）

2. Watch

关注该项目，后续更新日志将以 releases 发布，届时您将收到邮件通知

3. Sync fork

回到您的仓库首页，如果项目有更新内容，点击 Sync fork，Update branch 确认即可更新最新代码