8065ceec39
* 📝 添加近期更新的使用说明 * 📝 注入了一些灵魂 * 🐛 修正布局错误 * 🐛 修正引用错误 * 💥 初步引入 模板介绍 * 📝 又注入了一点灵魂 * 🐛 抓住了一只虫子 * 📝 我柜子动了我不修了 * 📝 第九个 Commit 收工领便当啦
36 KiB
subconverter
在各种订阅格式之间进行转换的实用程序.
新增内容
2020/04/04
- 新增 模板介绍 用于对所引用的
base基础模板进行高度个性化自定义 - 新增 配置文件 中
[template]参数的描述 - 新增 外部配置 中
[template]参数的描述 - 新增 本地生成 用于在本地生成具体的配置文件
- 新增 支持类型 中
mellow&trojan参数 - 新增 进阶链接 中
new_name参数的描述 - 新增 配置文件 中
append_sub_userinfoclash_use_new_field_name参数的描述 - 调整 说明目录 层次
2020/03/02
- 新增 进阶链接 中关于
append_typeappend_infoexpanddev_idintervalstrict等参数的描述
说明目录
支持类型
| 类型 | 作为源类型 | 作为目标类型 | 参数 |
|---|---|---|---|
| Clash | ✓ | ✓ | clash |
| ClashR | ✓ | ✓ | clashr |
| Quantumult (完整配置) | ✓ | ✓ | quan |
| Quantumult X (完整配置) | ✓ | ✓ | quanx |
| Loon | ✓ | ✓ | loon |
| Mellow | ✓ | ✓ | mellow |
| SS (SIP002) | ✓ | ✓ | ss |
| SS (软件订阅) | ✓ | ✓ | sssub |
| SSD | ✓ | ✓ | ssd |
| SSR | ✓ | ✓ | ssr |
| Surfboard | ✓ | ✓ | surfboard |
| Surge 2 | ✓ | ✓ | surge&ver=2 |
| Surge 3 | ✓ | ✓ | surge&ver=3 |
| Surge 4 | ✓ | ✓ | surge&ver=4 |
| Trojan | ✓ | ✓ | trojan |
| V2Ray | ✓ | ✓ | v2ray |
| 类 TG 代理的 HTTP/Socks 链接 | ✓ | × | 仅支持 &url= 调用 |
注意：
-
Shadowrocket 用户可以使用
ss、ssr以及v2ray参数 -
类 TG 代理的 HTTP/Socks 链接 由于没有命名设定，所以可以在后方插入
&remark=进行命名，例如-
tg://http?server=1.2.3.4&port=233&user=user&pass=pass&remark=Example
-
https://t.me/http?server=1.2.3.4&port=233&user=user&pass=pass&remark=Example
-
简易用法
即生成的配置文件默认套用 神机规则
调用地址
http://127.0.0.1:25500/sub?target=%TARGET%&url=%URL%&config=%CONFIG%
调用说明
| 调用参数 | 必要性 | 示例 | 解释 |
|---|---|---|---|
| target | 必要 | surge&ver=4 | 指想要生成的配置类型，详见上方 支持类型 中的参数 |
| url | 必要 | https%3A%2F%2Fwww.xxx.com | 指机场所提供的订阅链接，需要经过 URLEncode 处理 |
| config | 可选 | https%3A%2F%2Fwww.xxx.com | 指远程 pref.ini (包含分组和规则部分)，需要经过 URLEncode 处理，可查看 示例仓库 寻找灵感，默认加载本地设置文件 |
运行 subconverter 主程序后，按照 调用说明 的对应内容替换即可得到一份使用神机规则的配置文件。
由于此部分篇幅较长，点击下方条目即可展开详解：
处理单份订阅
如果你需要将一份 Surge 订阅转换成 Clash 的订阅, 可以按以下操作：
有以下一个订阅，且想转换成 Clash 的订阅:
1. https://dler.cloud/subscribe/ABCDE?surge=ss
首先将订阅通过 URLEncode 后可以得到:
https%3A%2F%2Fdler.cloud%2Fsubscribe%2FABCDE%3Fsurge%3Dss
然后将想要的 %TARGET% (即 clash) 和上一步所得到的 %URL% 填入调用地址中:
http://127.0.0.1:25500/sub?target=clash&url=https%3A%2F%2Fdler.cloud%2Fsubscribe%2FABCDE%3Fsurge%3Dss
最后将该链接填写至 Clash 的订阅处就大功告成了。
处理多份订阅
如果你需要将多个订阅合成一份, 则要在上方所提及的 URLEncode 之前使用 '|' 来分隔链接, 可以按以下操作：
有以下两个订阅，且想合并转换成 Clash 的订阅:
1. https://dler.cloud/subscribe/ABCDE?clash=vmess
2. https://rich.cloud/subscribe/ABCDE?clash=vmess
首先使用 '|' 将两个订阅分隔开:
https://dler.cloud/subscribe/ABCDE?clash=vmess|https://rich.cloud/subscribe/ABCDE?clash=vmess
接着通过 URLEncode 后可以得到:
https%3A%2F%2Fdler.cloud%2Fsubscribe%2FABCDE%3Fclash%3Dvmess%7Chttps%3A%2F%2Frich.cloud%2Fsubscribe%2FABCDE%3Fclash%3Dvmess
然后将想要的 %TARGET% (即 clash) 和上一步所得到的 %URL% 填入调用地址中:
http://127.0.0.1:25500/sub?target=clash&url=https%3A%2F%2Fdler.cloud%2Fsubscribe%2FABCDE%3Fclash%3Dvmess%7Chttps%3A%2F%2Frich.cloud%2Fsubscribe%2FABCDE%3Fclash%3Dvmess
最后将该链接填写至 Clash 的订阅处就大功告成了。
处理单份链接
如果你需要将自建的一条 SS 的 SIP002 链接转换成 Clash 的订阅, 可以按以下操作：
有以下自建的一条 SS 的 SIP002 链接，且想转换成 Clash 的订阅:
1. ss://YWVzLTEyOC1nY206dGVzdA==@192.168.100.1:8888#Example1
首先将订阅通过 URLEncode 后可以得到:
ss%3A%2F%2FYWVzLTEyOC1nY206dGVzdA%3D%3D%40192%2E168%2E100%2E1%3A8888%23Example1
然后将想要的 %TARGET% (即 clash) 和上一步所得到的 %URL% 填入调用地址中:
http://127.0.0.1:25500/sub?target=clash&url=ss%3A%2F%2FYWVzLTEyOC1nY206dGVzdA%3D%3D%40192%2E168%2E100%2E1%3A8888%23Example1
最后将该链接填写至 Clash 的订阅处就大功告成了。
处理多份链接
如果你需要将多个链接合成一份, 则要在上方所提及的 URLEncode 之前使用 '|' 来分隔链接, 可以按以下操作：
有以下两个链接，且想合并转换成 Clash 的订阅:
1. ss://YWVzLTEyOC1nY206dGVzdA==@192.168.100.1:8888#Example1
2. vmess://eyJ2IjoiMiIsInBzIjoidm1lc3MtcHJveHkxIiwiYWRkIjoiZXhhbXBsZS5jb20iLCJwb3J0Ijo0NDMsInR5cGUiOiIiLCJpZCI6IjEyMzQ1Njc4LWFiY2QtMTIzNC0xMjM0LTQ3ZmZjYTBjZTIyOSIsImFpZCI6NDQzLCJuZXQiOiJ3cyIsInBhdGgiOiIvdjIiLCJob3N0IjoiZXhhbXBsZS5jb20iLCJ0bHMiOiJ0bHMifQ==
首先使用 '|' 将两个链接分隔开:
ss://YWVzLTEyOC1nY206dGVzdA==@192.168.100.1:8888#Example1|vmess://eyJ2IjoiMiIsInBzIjoidm1lc3MtcHJveHkxIiwiYWRkIjoiZXhhbXBsZS5jb20iLCJwb3J0Ijo0NDMsInR5cGUiOiIiLCJpZCI6IjEyMzQ1Njc4LWFiY2QtMTIzNC0xMjM0LTQ3ZmZjYTBjZTIyOSIsImFpZCI6NDQzLCJuZXQiOiJ3cyIsInBhdGgiOiIvdjIiLCJob3N0IjoiZXhhbXBsZS5jb20iLCJ0bHMiOiJ0bHMifQ==
接着通过 URLEncode 后可以得到:
ss%3A%2F%2FYWVzLTEyOC1nY206dGVzdA%3D%3D%40192%2E168%2E100%2E1%3A8888%23Example1%7Cvmess%3A%2F%2FeyJ2IjoiMiIsInBzIjoidm1lc3MtcHJveHkxIiwiYWRkIjoiZXhhbXBsZS5jb20iLCJwb3J0Ijo0NDMsInR5cGUiOiIiLCJpZCI6IjEyMzQ1Njc4LWFiY2QtMTIzNC0xMjM0LTQ3ZmZjYTBjZTIyOSIsImFpZCI6NDQzLCJuZXQiOiJ3cyIsInBhdGgiOiIvdjIiLCJob3N0IjoiZXhhbXBsZS5jb20iLCJ0bHMiOiJ0bHMifQ%3D%3D
然后将想要的 %TARGET% (即 clash) 和上一步所得到的 %URL% 填入调用地址中:
http://127.0.0.1:25500/sub?target=clash&url=ss%3A%2F%2FYWVzLTEyOC1nY206dGVzdA%3D%3D%40192%2E168%2E100%2E1%3A8888%23Example1%7Cvmess%3A%2F%2FeyJ2IjoiMiIsInBzIjoidm1lc3MtcHJveHkxIiwiYWRkIjoiZXhhbXBsZS5jb20iLCJwb3J0Ijo0NDMsInR5cGUiOiIiLCJpZCI6IjEyMzQ1Njc4LWFiY2QtMTIzNC0xMjM0LTQ3ZmZjYTBjZTIyOSIsImFpZCI6NDQzLCJuZXQiOiJ3cyIsInBhdGgiOiIvdjIiLCJob3N0IjoiZXhhbXBsZS5jb20iLCJ0bHMiOiJ0bHMifQ%3D%3D
最后将该链接填写至 Clash 的订阅处就大功告成了。
简易转换
当机场提供的 Surge 配置足以满足需求，但额外需要使用 Clash 配置文件时，此时可以使用以下方式进行转换
http://127.0.0.1:25500/surge2clash?link=Surge的订阅链接
此处 Surge的订阅链接不需要进行URLEncode，且无需任何额外配置。
进阶用法
在不满足于本程序所提供的神机规则或者对应的分组时，可以考虑尝试进阶用法
即 对
调用地址甚至程序目录下的pref.ini进行个性化的编辑以满足不同的需求
阅前提示
在进行下一步操作前，十分推荐您阅读以下内容：
- 与
pref.ini相关的：INI 语法介绍 - 与
Clash配置相关的：YAML 语法介绍 - 与
模板配置相关的：INJA 语法介绍 - 会经常涉及到的： 正则表达式入门
- 当遇到问题需要提交 ISSUE 时的：提问的智慧
当您尝试进行进阶操作时，即默认您有相关的操作能力，本程序仅保证在默认配置文件下能够正常运行。
进阶链接
调用地址 (进阶)
http://127.0.0.1:25500/sub?target=%TARGET%&url=%URL%&emoji=%EMOJI%····
调用说明 (进阶)
| 调用参数 | 必要性 | 示例 | 解释 |
|---|---|---|---|
| target | 必要 | surge&ver=4 | 指想要生成的配置类型，详见上方 支持类型 中的参数 |
| url | 可选 | https%3A%2F%2Fwww.xxx.com | 指机场所提供的订阅链接，需要经过 URLEncode 处理，可选的前提是在 default_url 中进行指定。也可以使用 data URI |
| config | 可选 | https%3A%2F%2Fwww.xxx.com | 指远程 pref.ini (包含分组和规则部分)，需要经过 URLEncode 处理，可查看 示例仓库 寻找灵感，默认加载本地设置文件 |
| upload | 可选 | true / false | 用于将生成的订阅文件上传至 Gist，需要填写gistconf.ini，默认为 false (即不上传) |
| upload_path | 可选 | MySS.yaml | 用于将生成的订阅文件上传至 Gist 后的名称，需要经过 URLEncode 处理 |
| emoji | 可选 | true / false | 用于在节点名称前加入 Emoji，默认为 true |
| group | 可选 | MySS | 用于设置该订阅的组名，多用于 SSD/SSR |
| tfo | 可选 | true / false | 用于开启该订阅链接的 TCP Fast Open，默认为 false |
| udp | 可选 | true / false | 用于开启该订阅链接的 UDP，默认为 false |
| scv | 可选 | true / false | 用于关闭 TLS 节点的证书检查，默认为 false |
| list | 可选 | true / false | 用于输出 Surge Node List 或者 Clash Proxy Provider 或者 Quantumult (X) 的节点订阅 或者 解码后的 SIP002 |
| sort | 可选 | true / false | 用于对输出的节点或策略组进行再次排序，默认为 false |
| include | 可选 | 详见下文中 include_remarks |
指仅保留匹配到的节点，支持正则匹配，需要经过 URLEncode 处理，会覆盖配置文件里的设置 |
| exclude | 可选 | 详见下文中 exclude_remarks |
指排除匹配到的节点，支持正则匹配，需要经过 URLEncode 处理，会覆盖配置文件里的设置 |
| filename | 可选 | MySS | 指定该链接生成的配置文件的文件名，可以在 Clash For Windows 等支持文件名的软件中显示出来 |
| append_type | 可选 | true / false | 用于在节点名称前插入节点类型，如 [SS],[SSR] 等 |
| append_info | 可选 | true / false | 用于输出包含流量或到期信息的节点, 默认为 true，设置为 false 则取消输出 |
| expand | 可选 | true / false | 用于在 API 端处理或转换 Surge, QuantumultX 的规则列表，即不将规则全文置入配置文件中，默认为 false，设置为 true 则将规则全文写进配置文件 |
| dev_id | 可选 | 92DSAFA | 用于设置 QuantumultX 的远程设备 ID, 以在某些版本上开启远程脚本 |
| interval | 可选 | 43200 | 用于设置托管配置更新间隔，确定配置将更新多长时间，单位为秒 |
| strict | 可选 | true / false | 如果设置为 true，则 Surge 将在上述间隔后要求强制更新 |
| new_name | 可选 | true / false | 如果设置为 true，则将启用 Clash 的新组名称 (proxies, proxy-groups, rules) |
举个例子：
有订阅 `https://dler.cloud/subscribe/ABCDE?clash=vmess`，想转换成 Surge 4 的订阅，且需要开启 TFO 和 UDP
顺便再给节点名加上 EMOJI 同时排除掉订阅中显示流量和官网的节点（节点名为"剩余流量：1024G"，"官网地址：dler.cloud"）
首先确认需要用到的参数：
target=surge&ver=4 、 tfo=true 、 udp=true 、 emoji=true 、exclude=(流量|官网)
url=https://dler.cloud/subscribe/ABCDE?clash=vmess
然后将需要 URLEncode 的部分进行处理：
exclude=%28%E6%B5%81%E9%87%8F%7C%E5%AE%98%E7%BD%91%29
url=https%3A%2F%2Fdler.cloud%2Fsubscribe%2FABCDE%3Fclash%3Dvmess
接着将所有元素进行拼接：
http://127.0.0.1:25500/sub?target=surge&ver=4&tfo=true&udp=true&emoji=true&exclude=%28%E6%B5%81%E9%87%8F%7C%E5%AE%98%E7%BD%91%29&url=https%3A%2F%2Fdler.cloud%2Fsubscribe%2FABCDE%3Fclash%3Dvmess
最后将该链接填写至 Surge 的订阅处就大功告成了。
配置档案
当通过上述 进阶链接 配置好订阅链接后，通常会使得链接十分冗长和难以记忆，此时可以考虑使用配置档案。
此功能暂时仅能读取本地文件
调用地址 (档案)
http://127.0.0.1:25500/getprofile?name=%NAME%&token=%TOKEN%
调用说明 (档案)
| 调用参数 | 必要性 | 示例 | 解释 |
|---|---|---|---|
| name | 必要 | profiles/formyairport.ini | 指配置档案的存储位置(可使用基于pref 配置文件的相对位置) |
| token | 必要 | passwd | 为了安全考虑必须设置token（详见 配置文件 中 [common] 部分 对 api_access_token 的描述） |
应当注意的是，此处文件内的参数无需进行 URLEncode，且此处的 token 与 api_mode 的状态无关。
在程序目录内的任意位置创建一个新的文档文件（推荐保存至 profiles 文件夹内，以使整洁目录及便于后续维护），如 formyairport.ini，并仿照 示例文档 根据配置好的参数填写进去即可。
举个例子：
以上述 进阶链接 的例子而言，formyairport.ini 内的内容应当是：
[Profile]
url=https://dler.cloud/subscribe/ABCDE?clash=vmess
target=surge
surge_ver=4
tfo=true
udp=true
emoji=true
exclude=(流量|官网)
在编辑并保存好 formyairport.ini 后，即可使用 http://127.0.0.1:25500/getprofile?name=profiles/formyairport.ini&token=passwd 进行调用。
配置文件
关于 subconverter 主程序目录中
pref.ini文件的解释
由于此部分篇幅较长，点击下方条目即可展开详解：
[common] 部分
该部分主要涉及到的内容为 全局的节点排除或保留 、各配置文件的基础
其他设置项目可以保持默认或者在知晓作用的前提下进行修改
-
api_mode
API 模式，设置为 true 以防止直接加载本地订阅或直接提供本地文件，若访问这些内容则需要接上
&token=。（多用于架设于服务器上）- 当值为
false时, 每次更新配置都会读取pref.ini, 为true时则仅启动时读取。
- 当值为
-
api_access_token
用于访问相对隐私的接口（如
/getprofile）- 例如:
api_access_token=passwd -
default_url
无 %URL% 参数时，默认加载的订阅链接， 不需要 URLEncode。
如果有多个链接，仍然需要使用 "|" 分隔，支持
文件/url- 例如:
default_url=https://dler.cloud/subscribe/ABCDE?clash=vmess- 解释：
此时订阅链接: http://127.0.0.1:25500/sub?target=clash 等同于: http://127.0.0.1:25500/sub?target=clash&url=https%3A%2F%2Fdler.cloud%2Fsubscribe%2FABCDE%3Fclash%3Dvmess -
insert_url
无论是否具有 %URL% 参数时，都会在添加订阅前加入的节点， 不需要 URLEncode。
如果有多个节点，仍然需要使用 "|" 分隔，支持
单个节点/订阅链接支持 SS/SSR/Vmess 以及类 TG 代理的 HTTP/Socks 链接
- 例如:
insert_url=ss://Y2hhY2hhMjAtaWV0Zi1wb2x5MTMwNTpwYXNzd29yZA@www.example.com:1080#Example insert_url=ss://Y2hhY2hhMjAtaWV0Zi1wb2x5MTMwNTpwYXNzd29yZA@www.example.com:1080#Example -
exclude_remarks
排除匹配到的节点，支持正则匹配
- 例如:
exclude_remarks=(流量|时间|官网|产品) -
include_remarks
仅保留匹配到的节点，支持正则匹配
- 例如:
include_remarks=(?<=美).*(BGP|GIA|IPLC) -
clash_rule_base
生成的 Clash 配置文件基础。支持
本地文件和在线URL- 例如:
clash_rule_base=clash.yaml # 加载本地的 clash.yaml 文件作为基础 # 或者 clash_rule_base=https://raw.githubusercontent.com/ConnersHua/Profiles/master/Clash/Pro.yaml # 加载神机的 Github 中相关文件作为基础 -
surge_rule_base
生成的 Surge 配置文件基础，用法同上
-
surfboard_rule_base
生成的 Surfboard 配置文件基础，用法同上
-
mellow_rule_base
生成的 Mellow 配置文件基础，用法同上
-
loon_rule_base
生成的 Loon 配置文件基础，用法同上
-
proxy_ruleset
更新 RuleSet 时是否使用代理
填写
NONE或者空白禁用，或者填写SYSTEM使用系统代理也可填写如同
socks5://127.0.0.1:1080的 HTTP 或 SOCKS 代理- 例如:
proxy_ruleset=SYSTEM # 使用系统代理 # 或者 proxy_ruleset=socks5://127.0.0.1:1080 # 使用本地的 1080 端口进行 SOCKS5 代理 -
proxy_subscription
更新 原始订阅 时是否使用代理，用法同上
-
proxy_config
更新 外部配置文件 时是否使用代理，用法同上
-
append_proxy_type
节点名称是否需要加入属性，设置为 true 时在节点名称前加入 [SS] [SSR] [VMess] 以作区别，
默认为 false
- 例如（设置为 true时）：
[SS] 香港中转 [VMess] 美国 GIA
[node_pref] 部分
该部分主要涉及到的内容为 开启节点的 UDP 及 TCP Fast Open 、节点的重命名 、重命名节点后的排序
相关设置项目建议保持默认或者在知晓作用的前提下进行修改
-
udp_flag
为节点打开 UDP 模式，设置为 true 时打开，默认为 false
- 当不清楚机场的设置时请勿调整此项。
-
tcp_fast_open_flag
为节点打开 TFO (TCP Fast Open) 模式，设置为 true 时打开，默认为 false
- 当不清楚机场的设置时请勿调整此项。
-
sort_flag
对生成的订阅中的节点进行 A-Z 的排序，设置为 true 时打开，默认为 false
-
skip_cert_verify_flag
关闭 TLS 节点的证书检查，设置为 true 时打开，默认为 false
- 请勿随意将此设置修改为 true
-
filter_deprecated_nodes
排除当前
target=不支持的节点类型，设置为 true 时打开，默认为 false- 可以考虑设置为 true，从而在一定程度上避免出现兼容问题
-
append_sub_userinfo
在 header 里的加入流量信息 (Quanx, Surge 等读取后可以显示流量信息通知)，设置为 true 时打开，默认为 true
-
clash_use_new_field_name
启用 Clash 的新区块名称 (proxies, proxy-groups, rules)，设置为 true 时打开，默认为 false
- 使用前务必确认当前使用 Clash core 已经支持新的区块名称
-
rename_node
重命名节点，支持正则匹配
使用方式：原始命名@重命名
- 例如:
rename_node=中国@中 rename_node=\(?((x|X)?(\d+)(\.?\d+)?)((\s?倍率?:?)|(x|X))\)?@(倍率:$1)-
特殊用法:
rename_node=!!GROUPID=0!!中国@中 # 指定此重命名仅在第一个订阅的节点中生效
[managed_config] 部分
该部分主要涉及到的内容为 订阅文件的更新地址
-
write_managed_config
是否将 '#!MANAGED-CONFIG' 信息附加到 Surge 或 Surfboard 配置，设置为 true 时打开，默认为 true
-
managed_config_prefix
具体的 '#!MANAGED-CONFIG' 信息，地址前缀不用添加 "/"。
Surge 或 Surfboard 会向此地址发出更新请求，同时本地 ruleset 转 url 会用此生成/getruleset链接。
局域网用户需要将此处改为本程序运行设备的局域网 IP
- 例如:
managed_config_prefix = http://192.168.1.5:25500 -
config_update_interval
托管配置更新间隔，确定配置将更新多长时间，单位为秒
- 例如:
config_update_interval = 86400 # 每 86400 秒更新一次（即一天） -
config_update_struct
如果 config_update_struct 为 true，则 Surge 将在上述间隔后要求强制更新。
-
quanx_device_id
用于重写 Quantumult X 远程 JS 中的设备 ID，该 ID 在 Quantumult X 设置中自行查找
- 例如:
quanx_device_id = XXXXXXX
[surge_external_proxy] 部分
为 Surge 添加 SSR 的支持路径
[emojis] 部分
-
add_emoji
是否在节点名称前加入下面自定义的 Emoji，设置为 true 时打开，默认为 true
-
remove_old_emoji
是否移除原有订阅中存在的 Emoji，设置为 true 时打开，默认为 true
-
rule
在匹配到的节点前添加自定义 emojis，支持正则匹配
- 例如:
rule=(流量|时间|应急),⌛time rule=(美|美国|United States),🇺🇸-
特殊用法:
rule=!!GROUPID=0!!(流量|时间|应急),⌛time # 指定此 Emoji 规则仅在第一个订阅的节点中生效
[ruleset] 部分
如果你对原本订阅自带的规则不满意时，可以使用如下配置
-
enabled
启用自定义规则集的总开关，设置为 true 时打开，默认为 true
-
overwrite_original_rules
覆盖原有规则，即 [common] 中 xxx_rule_base 中的内容，设置为 true 时打开，默认为 false
-
update_ruleset_on_request
根据请求执行规则集更新，设置为 true 时打开，默认为 false
-
surge_ruleset
从本地或 url 获取规则片段
[] 前缀后的文字将被当作规则，而不是链接或路径，主要包含
[]GEOIP和[]MATCH(等同于[]FINAL)。- 例如：
surge_ruleset=🍎 苹果服务,https://raw.githubusercontent.com/ConnersHua/Profiles/master/Surge/Ruleset/Apple.list # 表示引用 https://raw.githubusercontent.com/ConnersHua/Profiles/master/Surge/Ruleset/Apple.list 规则 # 且将此规则指向 [clash_proxy_group] 所设置 🍎 苹果服务 策略组 surge_ruleset=🎯 全球直连,rules/NobyDa/Surge/Download.list # 表示引用本地 rules/NobyDa/Surge/Download.list 规则 # 且将此规则指向 [clash_proxy_group] 所设置 🎯 全球直连 策略组 surge_ruleset=🎯 全球直连,[]GEOIP,CN # 表示引用 GEOIP 中关于中国的所有 IP # 且将此规则指向 [clash_proxy_group] 所设置 🎯 全球直连 策略组
[clash_proxy_group] 部分
为 Clash 、Mellow 、Surge 以及 Surfboard 等程序创建策略组, 可用正则来筛选节点
[] 前缀后的文字将被当作引用策略组
custom_proxy_group=🍎 苹果服务`url-test`(美国|US)`http://www.gstatic.com/generate_204`300
# 表示创建一个叫 🍎 苹果服务 的 url-test 策略组,并向其中添加名字含'美国','US'的节点，每隔300秒测试一次
custom_proxy_group=🇯🇵 日本延迟最低`url-test`(日|JP)`http://www.gstatic.com/generate_204`300
# 表示创建一个叫 🇯🇵 日本延迟最低 的 url-test 策略组,并向其中添加名字含'日','JP'的节点，每隔300秒测试一次
custom_proxy_group=🇯🇵 JP`select`沪日`日本`[]🇯🇵 日本延迟最低
# 表示创建一个叫 🇯🇵 JP 的 select 策略组,并向其中**依次**添加名字含'沪日','日本'的节点，以及引用上述所创建的 🇯🇵 日本延迟最低 策略组
-
还可使用一些特殊筛选条件(GROUPID 匹配支持range,如 1,!2,3-4,!5-6,7+,8-)
custom_proxy_group=g1`select`!!GROUPID=0 # 指订阅链接中的第一条订阅 custom_proxy_group=g2`select`!!GROUPID=1 # 指订阅链接中的第二条订阅 custom_proxy_group=g2`select`!!GROUPID=!2 # 指除了订阅链接中的第三条订阅 custom_proxy_group=g2`select`!!GROUPID=3-5 # 指订阅链接中的第四条到第六条订阅 custom_proxy_group=v2ray`select`!!GROUP=V2RayProvider # 指订阅链接中组名为 V2RayProvider 的节点 -
现在也可以使用双条件进行筛选
custom_proxy_group=g1hk`select`!!GROUPID=0!!(HGC|HKBN|PCCW|HKT|hk|港) # 订阅链接中的第一条订阅内名字含 HGC、HKBN、PCCW、HKT、hk、港 的节点
[server] 部分
此部分通常保持默认即可
-
listen
绑定到 Web 服务器的地址，将地址设为 0.0.0.0，则局域网内设备均可使用
-
port
绑定到 Web 服务器地址的端口，默认为 25500
[template] 部分
此部分用于指定 模板 中的部分值
-
template_path
对子模板文件的所在位置(即模板文件中使用
{% include "xxx.tpl" %}引入的模板)做出路径限制 -
clash.dns 等
名称可以为任意非本程序默认的参数，用来对模板中的值进行判断或在模板中使用其定义的参数
[advanced] 部分
此部分通常保持默认即可
外部配置
本部分用于 链接参数
&config=
将文件按照以下格式写好，上传至 Github Gist 或者 其他可访问网络位置
经过 URLEncode 处理后，添加至 &config= 即可调用
需要注意的是，由外部配置中所定义的值会覆盖 pref.ini 里的内容
即，如果你在外部配置中定义了
emoji=(流量|时间|应急),🏳️🌈
emoji=阿根廷,🇦🇷
那么本程序只会匹配以上两个 Emoji，不再使用 pref.ini 中所定义的 国别 Emoji
点击查看文件内容
[custom]
;这是一个外部配置文件示例
;所有可能的自定义设置如下所示
;用于自定义组的选项 会覆盖 pref.ini 里的内容
;使用以下模式生成 Clash 代理组，带有 "[]" 前缀将直接添加
;Format: Group_Name`select`Rule_1`Rule_2`...
; Group_Name`url-test|fallback|load-balance`Rule_1`Rule_2`...`test_url`interval
;Rule with "[]" prefix will be added directly.
custom_proxy_group=Proxy`select`.*`[]AUTO`[]DIRECT`.*
custom_proxy_group=UrlTest`url-test`.*`http://www.gstatic.com/generate_204`300
custom_proxy_group=FallBack`fallback`.*`http://www.gstatic.com/generate_204`300
custom_proxy_group=LoadBalance`load-balance`.*`http://www.gstatic.com/generate_204`300
;custom_proxy_group=g1`select`!!GROUPID=0
;custom_proxy_group=g2`select`!!GROUPID=1
;custom_proxy_group=v2ray`select`!!GROUP=V2RayProvider
;custom_proxy_group=g1hk`select`!!GROUPID=0!!(HGC|HKBN|PCCW|HKT|hk|港)
;custom_proxy_group=sstw`select`!!GROUP=V2RayProvider!!(深台|彰化|新北|台|tw)
;用于自定义规则的选项 会覆盖 pref.ini 里的内容
;Ruleset addresses, supports local files/URL
;Format: Group name,URL
; Group name,[]Rule
enable_rule_generator=false
overwrite_original_rules=false
;surge_ruleset=DIRECT,https://raw.githubusercontent.com/ConnersHua/Profiles/master/Surge/Ruleset/Unbreak.list
;surge_ruleset=🎯 全球直连,rules/LocalAreaNetwork.list
;surge_ruleset=🎯 全球直连,[]GEOIP,CN
;surge_ruleset=🐟 漏网之鱼,[]FINAL
;用于自定义基础配置的选项 会覆盖 pref.ini 里的内容
clash_rule_base=base/forcerule.yml
;surge_rule_base=base/surge.conf
;surfboard_rule_base=base/surfboard.conf
;mellow_rule_base=base/mellow.conf
;quan_rule_base=base/quan.conf
;quanx_rule_base=base/quanx.conf
;用于自定义重命名的选项 会覆盖 pref.ini 里的内容
;rename=Test-(.*?)-(.*?)-(.*?)\((.*?)\)@\1\4x测试线路_自\2到\3
;rename=\(?((x|X)?(\d+)(\.?\d+)?)((\s?倍率?)|(x|X))\)?@$1x
;用于自定义 Emoji 的选项 会覆盖 pref.ini 里的内容
;emoji=(流量|时间|应急),🏳️🌈
;emoji=阿根廷,🇦🇷
;用于包含或排除节点关键词的选项 会覆盖 pref.ini 里的内容
;include_remarks=
;exclude_remarks=
;[template]
;;局部作用于模板中的变量
;clash.dns.port=5353
模板介绍
0.5.0版本中引进了模板功能，可以通过设置不同的条件参数来获取对应的模板内容从而做到将多个模板文件合成为一个，或者在不改动模板内容的前提下修改其中的某个参数等
示例文件可以参看 all_base.tpl
模板内的常用写法有以下几类：
各种判断可以嵌套使用，但需要确保逻辑关系没有问题，即有
if就要有endif更多的使用方式可以参照 INJA 语法
-
取值
{{ global.clash.http_port }} # 获取 配置文件 中 clash.http_port 的值 -
单判断
{% if request.clash.dns == "1" %} ··· {% endif %} # 如果 URL 中的 clash.dns=1 时，判断成立 -
或判断
{% if request.target == "clash" or request.target == "clashr" %} ··· {% endif %} # 如果 URL 中的 target 为 clash 或者 clashr 时，判断成立 -
如果...否则...
{% if local.clash.new_field_name == "true" %} proxies: ~ proxy-groups: ~ rules: ~ {% else %} Proxy: ~ Proxy Group: ~ Rule: ~ {% endif %} # 如果 外部配置中 clash.new_field_name=true 时，启用 新的 Clash 块名称，否则使用旧的名称 -
如果存在...则...(可避免请求中无对应参数时发生的报错)
{% if exists("request.clash.dns") %} dns: enabled: true listen: 1053 {% endif %} # 如果 URL 中存在对 clash.dns 参数的任意指定时，判断成立 (可以和 如果···否则··· 等判断一起使用)
模板内的引用有以下几类：
-
从 配置文件 中获取，判断前缀为
globalsocks-port: {{ global.clash.socks_port }} # 当配置文件中设定了 `clash.socks_port` 值时，将被引用 -
从 外部配置 中获取，判断前缀为
local{% if local.clash.new_field_name =="true" %} ··· {% endif %} # 当外部配置中设定了 `clash.new_field_name=true` 时，该判断生效，其包含的···内容被引用 -
从 URL 链接中获取，判断前缀为
request，例如http://127.0.0.1:25500/sub?target=clash&url=www.xxx.com&clash.dns=1
特别用法
本地生成
启动程序后，在本地生成对应的配置文件文本
在程序目录内的 generate.ini 中设定文件块([xxx])，生成的文件名(path=xxx)以及其所需要包含的参数，例如：
[test]
path=output.conf
target=surge
ver=4
url=ss://Y2hhY2hhMjAtaWV0Zi1wb2x5MTMwNTpwYXNzd29yZA@www.example.com:1080#Example
[test_profile]
path=output.yml
profile=profiles/example_profile.ini
使用 subconverter -g 启动本程序时，即可在程序根目录内生成名为 output.conf output.yml 的配置文件文本。
使用 subconverter -g --artifact "test" 启动本程序时，即可在程序根目录内仅生成上述示例中 [test] 文件块所指代的 output.conf 的配置文件文本。
自动上传
自动上传 gist ，可以用于 Clash For Android / Surge 等进行远程订阅
在程序目录内的 gistconf.ini 中添加 Personal Access Token（在此创建）例如：
[common]
;uncomment the following line and enter your token to enable upload function
token = xxxxxxxxxxxxxxxxxxxxxxxx(所生成的 Personal Access Token)
在 调用地址 或 调用地址 (进阶) 所生成的链接后加上 &upload=true 就会在更新好后自动上传 gist
此时，subconverter 程序窗口内会出现如下所示的神秘代码：
No gist id is provided. Creating new gist...
Writing to Gist success!
Generator: surge4
Path: surge4
Raw URL: https://gist.githubusercontent.com/xxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/raw/surge4
Gist owner: xxxx
上方所提到的 Raw URL: https://gist.githubusercontent.com/xxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/raw/surge4
中的 https://gist.githubusercontent.com/xxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/raw/surge4 即是你的在线订阅链接。
注意，本程序默认会将此链接设为秘密状态
根据 官方手册 - 创建 Gist 的解释为：
秘密 gists 不会显示在 Discover 中，也不可搜索。
秘密 gists 不是私人的。 如果将秘密 gist 的 URL 发送给朋友，他们可以查看。
但是，如果您不认识的人发现该 URL，也能看到您的 gist。
所以请务必保管好所生成的 Raw URL 链接。