mihomo-subconverter — Next.js Tool Template

SHA-256: 94ef109baf2e86d2334adf97a90cc77ec64d523a574acb22ad3bdde55fc9704c

2026-10-04T17:12:53.212Z

# Mihomo Subscription Converter

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/ififi2017/mihomo-subconverter)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
[![Next.js](https://img.shields.io/badge/Next.js-16-black)](https://nextjs.org)

A lightweight Mihomo / Clash subscription converter. Paste your proxy node links, choose a rule template, and get a ready-to-use configuration file — deployable to Vercel in one click.

> Rule sets are powered by [MetaCubeX/meta-rules-dat](https://github.com/MetaCubeX/meta-rules-dat) in `.mrs` binary format. Template format follows the [ACL4SSR](https://github.com/ACL4SSR/ACL4SSR) / sub-web INI convention for compatibility. Protocol parsing patterns reference [sublink-worker](https://github.com/7Sageer/sublink-worker) by 7Sageer.

---

## Supported Protocols

| Protocol | URI prefix |
|----------|-----------|
| Hysteria2 | `hysteria2://` / `hy2://` |
| AnyTLS | `anytls://` |
| VLESS | `vless://` (including `type=xhttp` / `splithttp`) |
| Trojan | `trojan://` |
| VMess | `vmess://` |
| Shadowsocks | `ss://` |
| TUIC | `tuic://` |

Converter links are also supported — paste a subscription URL generated by this tool (or any URL that carries node URIs in its `config` query parameter), and the nodes are extracted automatically. You can also paste a **base64 subscription blob** or a Clash config's **`proxies:`** section; both are parsed locally and the converter still does **not** fetch remote airport URLs.

---

## Features

- **Multi-protocol** — Hysteria2, AnyTLS, VLESS (incl. xhttp), Trojan, VMess, Shadowsocks, TUIC
- **Converter / base64 / YAML import** — Paste a converter link, a base64 subscription, or Clash `proxies:` YAML; nodes are extracted locally (remote airport URLs are never fetched)
- **INI rule templates** — Bundled MetaCubeX Full template with jsDelivr mirrors (works in mainland China), or point to any compatible `.ini` file
- **China-reachable rule sets** — GitHub raw / gh-proxy ruleset URLs are rewritten to `testingcf.jsdelivr.net` in the generated YAML
- **sub-web compatible** — Template URLs work with [CareyWang/sub-web](https://github.com/CareyWang/sub-web) remote config links without modification
- **Custom rules** — Prepend your own `DOMAIN-SUFFIX` / `IP-CIDR` rules at highest priority
- **Live subscription URL** — Generated link always reflects your current proxy list; paste it once into any Mihomo-compatible client
- **Custom domain aware** — Bind a custom domain in Vercel; generated links use it automatically
- **i18n** — English and Chinese UI; adding a new language takes two steps (see below)
- **Zero-config deploy** — No environment variables needed (optional hardening available, see below)

---

## Deploy to Vercel

### One-click deploy

Click the **Deploy with Vercel** button above. Fork the repo and deploy — no environment variables required.

### Custom domain

Add your domain under **Vercel project → Settings → Domains**. Once set up, any subscription link generated through your domain will automatically use it — no extra configuration needed.

### Optional environment variables

The converter works with zero configuration, but two optional variables harden a public deployment (set them under **Vercel project → Settings → Environment Variables**):

| Variable | Effect |
|----------|--------|
| `ACCESS_TOKEN` | When set, `/api/clash` and `/api/preview-template` require a matching `token` query parameter. The UI detects this automatically and prompts for the token (stored in the browser, appended to generated links). |
| `TEMPLATE_ALLOWED_HOSTS` | Comma-separated host allowlist for custom template URLs, matched by suffix (e.g. `githubusercontent.com` also allows `raw.githubusercontent.com`). When unset, any public http(s) host is allowed; private/internal addresses are always rejected. |

> **Security note:** generated subscription links embed your node credentials in the URL. Treat them like passwords — anyone with the link (or access to request logs along the way) can read your nodes. Setting `ACCESS_TOKEN` does not change this; it only prevents strangers from using your deployment.

### Run locally

```bash
npm install
npm run dev
```

Open http://localhost:3000

### Run tests

```bash
npm test
```

---

## Usage

1. **Paste nodes** — Add proxy URIs one per line, a previously generated converter link, a base64 subscription, or a Clash YAML `proxies:` section (embedded nodes are extracted locally)
2. **Rule template** *(optional)* — Leave empty to use the default MetaCubeX Full template, or paste a URL to your own `.ini` file
3. **Custom rules** *(optional)* — Add rules that take priority over all built-in ones
4. **Generate** — Click **Generate Config** or press `Ctrl / ⌘ + Enter`
5. **Use it** — Copy the subscription link into your client's remote profile URL field

---

## Rule Templates

The converter uses an ACL4SSR-compatible INI file to define proxy groups and rule sets.

**Default template** (used when the Custom Template URL field is left empty). The UI links to the jsDelivr-CF mirror so the file opens in mainland China; GitHub raw is only a fallback at generate time. A snapshot is also bundled in `templates/MetaCubeX_Full.ini`.

```
https://testingcf.jsdelivr.net/gh/ififi2017/clash_rules@master/config/MetaCubeX_Full.ini
```

Open the link above to see a working example of the expected format — it's a good starting point for writing your own template.

### Using a custom template

1. Copy the default template above as a starting point
2. Edit the `custom_proxy_group` and `ruleset` lines to suit your needs
3. Host the file on GitHub (raw URL), any CDN, or a static file server
4. Paste the URL into the **Custom Template URL** field in the UI

**sub-web compatibility:** The template format follows the ACL4SSR / sub-web INI convention — any remote config URL that works in [CareyWang/sub-web](https://sub-web.pages.dev/) ([GitHub](https://github.com/CareyWang/sub-web)) under "远程配置" will also work here without modification. Both `.list` and `.mrs` rule formats are supported.

### Template format reference

```ini
; Lines starting with ; or # are comments

; Proxy groups — backtick-separated fields
custom_proxy_group=🚀 Node Select`select`[]♻️ Auto Select`[]DIRECT
custom_proxy_group=♻️ Auto Select`url-test`.*`http://www.gstatic.com/generate_204`300,,50
custom_proxy_group=🇭🇰 HK Nodes`url-test`(HK|Hong Kong|港)`http://www.gstatic.com/generate_204`300,,50

; Rule sets — GROUP,URL  or  GROUP,[]INLINE_RULE
; .list (classical text) and .mrs (MetaCubeX binary) are both supported
ruleset=🛑 AdBlock,https://example.com/rules/ban.list
ruleset=🎯 Direct,https://example.com/rules/cn.mrs
ruleset=🎯 Direct,[]GEOIP,CN
ruleset=🐟 Catch-all,[]FINAL
```

**Proxy group types:**

| Type | Fields after type |
|------|-------------------|
| `select` | `[]GroupName` or `[]DIRECT` / `[]REJECT` (one per backtick field) |
| `url-test` | `filter-regex` · `health-check-url` · `interval,,tolerance` |
| `fallback` | same as `url-test` |
| `load-balance` | same as `url-test` |

**Special inline rules:**

| INI value | Clash output |
|-----------|-------------|
| `[]FINAL` | `MATCH,<group>` |
| `[]GEOIP,CN` | `GEOIP,CN,<group>,no-resolve` |
| `[]IP-CIDR,x.x.x.x/y` | `IP-CIDR,x.x.x.x/y,<group>` |

---

## API

```
GET  /api/clash?config=<encoded_links>[&template=<encoded_url>][&customRules=<json_array>][&groups=<json_array>][&token=<token>]
POST /api/clash
```

The UI uses **POST** for preview generation (node URIs stay out of the request URL). The **subscription link** copied into Mihomo remains a GET URL — clients can only fetch that way.

`POST` JSON body fields match the query parameters (`config`, `template`, `customRules`, `groups`, `token`). `token` may also be sent as a query parameter.

| Parameter | Description |
|-----------|-------------|
| `config` | URL-encoded proxy URIs (newlines), Clash YAML `proxies:` section, or a base64 subscription |
| `template` | URL-encoded `.ini` template URL (optional, defaults to MetaCubeX Full) |
| `customRules` | JSON array of custom rule strings (optional) |
| `groups` | JSON array of rule-group names to include (optional, defaults to all) |
| `token` | Access token, required only when the deployment sets `ACCESS_TOKEN` |

Parameters must be URL-encoded exactly once (standard query-string encoding).

**Example:**

```bash
curl "https://your-domain.vercel.app/api/clash?config=hysteria2%3A%2F%2Fpwd%40host%3A443%3Fpeer%3Dsni%23MyNode"
```

---

## Adding a New Language

Translations live in the `locales/` directory as plain JSON files. Adding a new language requires two steps:

**1. Create the translation file**

Copy `locales/en.json` to `locales/<lang>.json` (use a [BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) language code, e.g. `ja`, `ko`, `fr`) and translate the values.

**2. Register the language**

In `lib/i18n.js`, add two lines:

```js
import ja from '../locales/ja.json'          // 1. import the file

export const LOCALES = {
  en: { name: 'English', messages: en },
  zh: { name: '中文',    messages: zh },
  ja: { name: '日本語',  messages: ja },     // 2. register it here
}
```

That's it — the language switcher in the header will pick it up automatically. PRs are welcome!

---

## License

MIT