Giter Site home page Giter Site logo

quantumultx-surge-api's Introduction

I. 关于

本API旨在将各种服务器订阅，转换成可用于 QuantumultX & Surge 两个优秀的iOS客户端的格式，以及全平台的mellow ，clash等优秀代理工具.

目前已实现功能：

  • QuantumultX：

    • 从 SS订阅/SSD订阅/SSR订阅/V2rayN 订阅/Surge(conf&list)/QuanX 转换成 QuantumultX 格式的订阅，并提供正则过滤，以及UDP/TFO参数的修改，以及多个订阅（托管）的合并等，以及emoji旗帜添加/删除，以及简单的节点重命名；
    • 将服务器订阅转换为 quantumult 的配置（含YouTube跟Netflix等基本分流）

  • Surge：

    • 从 Surge(conf&list)/SS订阅/SSD订阅/V2rayN订阅，转换成 Surge list的格式链接，并提供正则过滤，多个订阅（托管）链接合并，以及emoji旗帜添加/删除，以及简单的节点重命名等

  • Mellow:

    • 将V2RayN或者quantumultX格式的Vmess订阅链接，转换成Mellow可用的配置文件conf，并提供节点正则过滤功能，emoji地区旗帜，rename以及简单排序等功能

  • Clash：

    • 从 SS订阅/SSD订阅/V2rayN 订阅/Surge(conf&list)/QuanX 转换成 Clash 格式的 proxy-provider，并提供正则过滤，以及UDP/TFO参数的修改，以及多个订阅（托管）的合并等，以及emoji旗帜添加/删除，以及简单的节点重命名；

更新说明：

  • 2019-11-03: rename 功能增强：节点名 前/后 增加字符
  • 2019-11-06: 增加将订阅转换成 QuantumultX 配置
  • 2019-11-09: 增加按节点名排序参数 sort
  • 2019-11-24: 增加vmess2mellow，暂支持VRayN以及QuantumultX类型的v2订阅 --> 神机规则版本的mellow配置
  • 2019-12-02: 增加 Vmess2Quanx中 "tls-verification=true/false " 证书验证参数，cert=1/0
  • 2019-12-16: 增加对 clash的 proxy-provider 的支持
  • 2020-01-05:

常见错误：

A. 代号 502: 服务器关机中

B. 代号 500: 内部处理错误，可联系telegram-bot反馈：@Shawn_KOP_bot

  • 请直接说明具体问题，最好附上整个链接
  • 介意隐私，怕节点被偷的大佬，以及只会说 “怎么不行啊” 的患者，⚠️⚠️勿扰

C. APP 内出现 invalid response：同上

II. 使用说明

A. QuantumultX

1. 服务器订阅转换API

服务器订阅转换API 参数 说明 要求 状态
路径1 sub2quanx NA https://dove.589669.xyz/sub2quanx? NA
路径2 all2quanx 除了type参数，其它参数用法同路径1的示范完全一样 https://dove.589669.xyz/all2quanx? NA
链接类型 type 对路径1必须 ss/ssd/ssr/v2/surge/quanx (surge的托管conf与list均可) ✅
订阅链接 sub 必须，请先urlencode 务必先对链接urlencode，多个订阅用 + 连接 ✅
正则过滤节点 filter 可选，请先urlencode 务必先对参数urlencode，从开头开始匹配，所以建议从 .* 开始 ✅
UDP强制更改 udp 可选 参数为1，或0 （默认为0，关闭），对surge/quanx类型无效 ✅
TFO强制更改 tfo 可选 参数为1，或0（默认为0，关闭），对surge/quanx类型无效 ✅
emoji 国家/地区符号 emoji 可选 参数为 -1(删除旗帜)，1，2(用于国行手机，解决无法显示**地区旗帜🇹🇼的问题)；
另有参数 11， 22，将emoji添加在节点名尾部（如：日本 IPLC 🇯🇵）		 ✅
节点重命名 rename 可选，请先urlencode 1. 格式为 rename=oldname@newname，多个rename可用+链接：
- 例如将 香港替换成HK，日本替换成JP，则参数为：香港@HK+日本@JP (记得拿去urlencode)
2. 在名字前/后增加字符，可分别用 A@ 跟 @B等单参数，例如：
- 在节点前增加 [SS]，节点名尾增加 [IPLC], 则rename参数为：[SS]@+@[IPLC]
1跟2当然是可以混用的，比如 “[SS]@+@[IPLC]+香港@HK+日本@JP”		 ✅
节点排序 sort 可选 参数为1，-1， 分别按节点名进行 正序/逆序 排列 ✅
证书验证 cert 可选 参数为1/0， 默认留空为1，即 "tls-verification=true " ✅

完整示范：将 dler 的 ss订阅链接 转换，并只取其中名字含 “日本” 的节点，并添加 emoji，以及将节点名中的“日本”替换为“JP”，

0⃣️ sub 类型为 type=ss，订阅链接参数urlencode后为：sub=https%3A%2F%2Fdler.cloud%2Flink%2Fxxxx%3Fmu%3Dss

1⃣️ filter 参数为 .*日本，urlencode后为：filter=.%2A%E6%97%A5%E6%9C%AC

2⃣️ rename 参数为 日本@JP ， urlencode后为：rename=%E6%97%A5%E6%9C%AC%40JP

3⃣️ emoji 参数为 emoji=2

4⃣️ 每个参数间用 & 连接，最终合并成链接为：

https://dove.589669.xyz/sub2quanx?type=ss&tfo=1&udp=1&emoji=2&sub=https%3A%2F%2Fdler.cloud%2Flink%2Fxxxx%3Fmu%3Dss&filter=.%2A%E6%97%A5%E6%9C%AC&rename=%E6%97%A5%E6%9C%AC%40JP

如果你想过滤多个参数，比如 日本 或者 韩国 可以使用 .*(日本|韩国)

更多更灵活的操作，自行学习 正则：https://github.com/ziishaned/learn-regex/blob/master/translations/README-cn.md

参数请去此网站进行URLEncode：https://www.urlencoder.org

2. 服务器订阅转QuantumultX配置

参数 说明 要求 状态
路径 sub2qxconf 将服务器订阅转换成整份配置 https://dove.589669.xyz/sub2qxconf?
订阅链接 sub 必须 对链接urlencode，多个链接用 + 连接 ✅

完整示范：将两个节点订阅链接 http://sub1 跟 https://sub2 ,生成 QuantumultX 的配置，

1⃣️ 将 http://sub1+ http://sub2 拿去urlencode：

2⃣️ 完整链接🔗：https://dove.589669.xyz/sub2qxconf?sub=http%3A%2F%2Fsub1%2Bhttp%3A%2F%2Fsub2

3⃣️ 点按quantumultx右下角，进入设置，找到最下方“下载”填入QuantumultX

B. Surge 3

Surge API 参数 说明 要求 状态
路径1 Mix2Surge NA https://dove.589669.xyz/Mix2Surge? NA
路径2 all2surge 除了type参数，其它参数用法同路径1的示范完全一样 https://dove.589669.xyz/all2surge? NA
链接类型 type 对路径1为必须 ss/ssd/v2/surge （其中，surge参数对conf托管跟list通用） ✅
订阅(托管)链接 sub 必须，请先urlencode 务必先对链接urlencode，多个订阅用 + 号连接 ✅
正则过滤节点 filter 可选，请先urlencode 务必先对参数urlencode，从开头开始匹配，所以建议从 .* 开始 ✅
v2订阅的header host hd 可选 hd=1，0 （为解决某些v2ray订阅在surge中不可用的情况，为0时，忽略header参数） ✅
UDP/TFO参数 udp/tfo 可选 仅对type为ss的类型有效（tfo=1/0，udp=1/0 来开启/关闭，默认关闭） ✅
emoji 国家/地区符号 emoji 可选 参数为 -1(删除旗帜)，1，2(用于国行手机，解决无法显示**地区旗帜🇹🇼的问题)；
另有参数 11， 22，将emoji添加在节点名尾部（如：日本 IPLC 🇯🇵）		 ✅
节点重命名 rename 可选，请先urlencode 1. 格式为 rename=oldname@newname，多个rename可用+链接：
- 例如将 香港替换成HK，日本替换成JP，则参数为：香港@HK+日本@JP (记得拿去urlencode)
2. 在名字前/后增加字符，可分别用 A@ 跟 @B等单参数，例如：
- 在节点前增加 [SS]，节点名尾增加 [IPLC], 则rename参数为：[SS]@+@[IPLC]
1跟2当然是可以混用的，比如 “[SS]@+@[IPLC]+香港@HK+日本@JP”		 ✅
节点排序 sort 可选 参数为1，-1， 分别按节点名进行 正序/逆序 排列 ✅

完整示范： 将某两个V2订阅合并转换成surge的list，并只选择其中的 **CHT ** 节点路线

https://dove.589669.xyz/Mix2Surge?type=v2&sub=https%3A%2F%2Fdler.cloud%2Fsubscribe%2Fxxx%3Fmu%3Dav2%2Bhttps%3A%2F%2Fytoo.xyz%2Fmodules%2Fservers%2FV2raySocks%2Fosubscribe.php%3Fsid%3D372%26token%3Dxxxo&filter=.%2ACHT

C. Mellow 项目

项目地址：https://github.com/mellow-io/mellow

神机规则地址：https://github.com/ConnersHua/Profiles/blob/master/Mellow/Pro.conf

API作用：将V2RayN订阅/quantumultX格式V2订阅，转换成mellow的conf配置（神机规则）

Mellow API 参数 说明 要求 状态
路径 V2Mellow 必须 https://dove.589669.xyz/V2Mellow? ✅
类型 type 必须 v2 或者 qx ✅
链接 sub 必须 务必先对链接urlencode，多个订阅用 + 号连接 ✅
正则过滤节点 filter 可选 务必先对参数urlencode，从开头开始匹配，所以建议从 .* 开始 ✅
emoji 国家/地区符号 emoji 可选 参数为 -1(删除旗帜)，1，2(用于国行手机，解决无法显示**地区旗帜🇹🇼的问题)；
另有参数 11， 22，将emoji添加在节点名尾部（如：日本 IPLC 🇯🇵）		 ✅
节点重命名 rename 可选，请先urlencode 1. 格式为 rename=oldname@newname，多个rename可用+链接：
- 例如将 香港替换成HK，日本替换成JP，则参数为：香港@HK+日本@JP (记得拿去urlencode)
2. 在名字前/后增加字符，可分别用 A@ 跟 @B等单参数，例如：
- 在节点前增加 [SS]，节点名尾增加 [IPLC], 则rename参数为：[SS]@+@[IPLC]
1跟2当然是可以混用的，比如 “[SS]@+@[IPLC]+香港@HK+日本@JP”		 ✅
节点排序 sort 可选 参数为1，-1， 分别按节点名进行 正序/逆序 排列 ✅

完整示范：将dlercloud 的v2订阅，并只挑选其中的 PCCW 节点 ⚠️注意⚠️：此API与前两个不同的是，这个API中，rename 优先级高于 filter： 所以你如果把“日本” rename成了 “JP” ，那过滤“日本”节点时，请用替换后的“JP”关键词作为filter参数

https://dove.589669.xyz/V2Mellow?type=v2&sub=https%3A%2F%2Fdler.cloud%2Fsubscribe%2FToken%3Fmu%3Dav2&filter=.%2APCCW

D. Clash 项目

项目地址：https://github.com/Dreamacro/clash

API 作用: 从 SS订阅/SSD订阅/V2rayN 订阅/Surge(conf&list)/QuanX 转换成 Clash 最新的 proxy-provider 格式（类似 surge 的 policy-path 的 list）

服务器订阅转换API 参数 说明 要求 状态
路径1 sub2clash NA https://dove.589669.xyz/sub2clash? NA
路径2 all2clash 除了type参数，其它参数用法同路径1的示范完全一样 https://dove.589669.xyz/all2clash? NA
链接类型 type 对路径1为必须 ss/ssd/v2/surge/quanx (surge的托管conf与list均可) ✅
订阅链接 sub 必须，请先urlencode 务必先对链接urlencode，多个订阅用 + 连接 ✅
正则过滤节点 filter 可选，请先urlencode 务必先对参数urlencode，从开头开始匹配，所以建议从 .* 开始 ✅
UDP强制更改 udp 可选 参数为1，或0 （默认为0，关闭），对surge/quanx类型无效
emoji 国家/地区符号 emoji 可选 参数为 -1(删除旗帜)，1，2(用于国行手机，解决无法显示**地区旗帜🇹🇼的问题)；
另有参数 11， 22，将emoji添加在节点名尾部（如：日本 IPLC 🇯🇵）		 ✅
节点重命名 rename 可选，请先urlencode 1. 格式为 rename=oldname@newname，多个rename可用+链接：
- 例如将 香港替换成HK，日本替换成JP，则参数为：香港@HK+日本@JP (记得拿去urlencode)
2. 在名字前/后增加字符，可分别用 A@ 跟 @B等单参数，例如：
- 在节点前增加 [SS]，节点名尾增加 [IPLC], 则rename参数为：[SS]@+@[IPLC]
1跟2当然是可以混用的，比如 “[SS]@+@[IPLC]+香港@HK+日本@JP”		 ✅
节点排序 sort 可选 参数为1，-1， 分别按节点名进行 正序/逆序 排列 ✅

0⃣️ 请咖啡☕️名单

🙏感谢🙏 如果觉得有用，请大胆请喝咖啡☕️

  • 鸡儿硬梆梆
  • 🐔哥｜法外 伉俪
  • 旺仔弟| 旺仔哥
  • 守夜人
  • Big Cat
  • Xin
  • 锄禾
  • 弥彦
  • Miao ~ socloud
  • 非主流 李克斯 关下门
  • yumemi
  • Zealson
  • 布
  • 好用的

quantumultx-surge-api's People

Contributors

kop-xiao avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.