subconverter README

The project's README from github.com/tindy2013/subconverter. As one markdown file: README.md.

subconverter

Utility to convert between various proxy subscription formats.

Build Status GitHub tag (latest SemVer) GitHub release GitHub license

Docker README

中文文档

Supported Types

Type As Source As Target Target Name
Clash ✓ ✓ clash
ClashR ✓ ✓ clashr
Quantumult ✓ ✓ quan
Quantumult X ✓ ✓ quanx
Loon ✓ ✓ loon
SS (SIP002) ✓ ✓ ss
SS Android ✓ ✓ sssub
SSD ✓ ✓ ssd
SSR ✓ ✓ ssr
Surfboard ✓ ✓ surfboard
Surge 2 ✓ ✓ surge&ver=2
Surge 3 ✓ ✓ surge&ver=3
Surge 4 ✓ ✓ surge&ver=4
V2Ray ✓ ✓ v2ray
Telegram-liked HTTP/Socks 5 links ✓ × Only as source

Notice:

  1. Shadowrocket users should use ss, ssr or v2ray as target.

  2. You can add &remark= to Telegram-liked HTTP/Socks 5 links to set a remark for this node. For example:

Quick Usage

Using default groups and rulesets configuration directly, without changing any settings

Access Interface

http://127.0.0.1:25500/sub?target=%TARGET%&url=%URL%&config=%CONFIG%

Description

Argument Required Example Description
target Yes clash Target subscription type. Acquire from Target Name in Supported Types.
url Yes https%3A%2F%2Fwww.xxx.com Subscription to convert. Supports URLs and file paths. Process with URLEncode first.
config No https%3A%2F%2Fwww.xxx.com External configuration file path. Supports URLs and file paths. Process with URLEncode first. More examples can be found in this repository.

If you need to merge two or more subscription, you should join them with '|' before the URLEncode process.

Example:

You have 2 subscriptions and you want to merge them and generate a Clash subscription:
1. https://dler.cloud/subscribe/ABCDE?clash=vmess
2. https://rich.cloud/subscribe/ABCDE?clash=vmess

First use '|' to separate 2 subscriptions:
https://dler.cloud/subscribe/ABCDE?clash=vmess|https://rich.cloud/subscribe/ABCDE?clash=vmess

Then process it with URLEncode to get %URL%:
https%3A%2F%2Fdler.cloud%2Fsubscribe%2FABCDE%3Fclash%3Dvmess%7Chttps%3A%2F%2Frich.cloud%2Fsubscribe%2FABCDE%3Fclash%3Dvmess

Then fill %TARGET% and %URL% in Access Interface with actual values:
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

Finally subscribe this link in Clash and you are done!

Advanced Usage

Please refer to 中文文档.

Auto Upload

Upload Gist automatically

Add a Personal Access Token into gistconf.ini in the root directory, then add &upload=true to the local subscription link, then when you access this link, the program will automatically update the content to Gist repository.

Example:

[common]
;uncomment the following line and enter your token to enable upload function
token = xxxxxxxxxxxxxxxxxxxxxxxx(Your Personal Access Token)

subconverter (tindy2013/subconverter)

Searching Database…

17.1K ·GitHub
Subconverter
Что это такое?Утилита, которая конвертирует файлы прокси-подписок между форматами: скармливаете ей ссылку на подписку для одного прокси-клиента и получаете готовый конфиг для другого — например, Clash, Surge или V2Ray.
Между какими форматами подписок она умеет конвертировать?Clash, ClashR, Quantumult, Quantumult X, Loon, SS (SIP002), SS Android, SSD, SSR, Surfboard, Surge 2/3/4 и V2Ray — каждый формат работает и как исходный, и как целевой; ссылки в стиле Telegram (HTTP/Socks5) подходят только как исходные.
Как мне конвертировать подписку, когда всё запущено?Обратитесь к интерфейсу доступа с параметром target (название формата, например clash) и параметром url, в котором лежит ваша ссылка на подписку в URLEncoded-виде; необязательный параметр config позволяет подключить внешний файл конфигурации.
Как запустить её у себя на компьютере?Это программа на C++: соберите её из исходников с помощью входящего Makefile или запустите Docker-образ, который публикует CI проекта, затем держите локальный сервис запущенным и обращайтесь к нему по HTTP.
Есть ли нюансы с форматами, о которых стоит знать?Пользователям Shadowrocket стоит выбирать target ss, ssr или v2ray, ссылки в стиле Telegram не могут быть целевым форматом, а ссылки на подписки нужно кодировать (URLEncoded) перед передачей.
Можно ли объединить несколько подписок в один конфиг?Да — соедините ссылки на подписки через '|' до URLEncoding, и конвертер выдаст единый объединённый конфиг.
Умеет ли она держать сконвертированную подписку синхронизированной на GitHub Gist?Да. Положите Personal Access Token в файл gistconf.ini в корневом каталоге и добавьте &upload=true к своей локальной ссылке на подписку; тогда каждый запрос автоматически обновляет Gist.
Можно ли настроить правила и группы в сгенерированном конфиге?Да — передайте внешний файл конфигурации через параметр config (URL или путь к файлу, в URLEncoded-виде); в репозитории есть больше примеров, а расширенные возможности описаны в китайской документации (中文文档).
What are similar projects?clash-rules, ddgksf2013, SS-Rule-Snippet, v2rayfree, CFBox, Sub-Store, fancyss, Free-servers
Which topics is it in?ss, quantumult, quantumultx, emoji, surge, clash, v2ray, shadowsocks, ssr, proxy, c++, utility
Creator
tindy2013
Size
7.2 MB
Stars
17.1K
Updated
CommitJul 08Releasev0.9.0Apr 08
Age
6y
Commits · 90 Days