clash-verge-rev/README.md

158 lines
5.3 KiB
Markdown
Raw Normal View History

2021-12-26 02:31:55 +08:00
<h1 align="center">
<img src="./src/assets/image/logo.png" alt="Clash" width="128" />
<br>
Clash Verge
<br>
</h1>
2021-12-04 14:31:26 +08:00
2021-12-26 02:31:55 +08:00
<h3 align="center">
A <a href="https://github.com/Dreamacro/clash">Clash</a> GUI based on <a href="https://github.com/tauri-apps/tauri">tauri</a>.
</h3>
2021-12-04 14:31:26 +08:00
2021-12-26 02:31:55 +08:00
## Features
2022-03-18 19:02:53 +08:00
- Full `clash` config supported, Partial `clash premium` config supported.
2022-06-20 02:06:46 +08:00
- Profiles management and enhancement (by yaml and Javascript). [Doc](https://github.com/zzzgydi/clash-verge/wiki/%E4%BD%BF%E7%94%A8%E6%8C%87%E5%8D%97)
2022-04-06 01:52:20 +08:00
- Simple UI and supports custom theme color.
2022-06-20 02:06:46 +08:00
- Built-in support [Clash.Meta](https://github.com/MetaCubeX/Clash.Meta) core.
2022-03-18 19:02:53 +08:00
- System proxy setting and guard.
2023-08-05 12:57:48 +08:00
## Promotion
[狗狗加速 —— 技术流机场 Doggygo VPN](https://dg1.top)
- High-performance overseas VPN, free trial, discounted packages, unlock streaming media, the world's first to support Hysteria protocol.
- 高性能海外机场,免费试用,优惠套餐,解锁流媒体,全球首家支持 Hysteria 协议。
2023-09-11 10:24:44 +08:00
- 使用 Clash Verge 专属邀请链接注册送 15 天,每天 1G 流量免费试用https://panel.dg1.top/#/register?code=sFCDayZf
2023-08-05 12:57:48 +08:00
<details>
<summary>Promotion Detail</summary>
- Clash Verge 专属 8 折优惠码: verge20 (仅有 500 份)
- 优惠套餐每月仅需 15.8 元160G 流量,年付 8 折
- 海外团队,无跑路风险,高达 50% 返佣
- 集群负载均衡设计,高速专线(兼容老客户端)极低延迟无视晚高峰4K 秒开
- 全球首家 Hysteria 协议机场,将在今年 10 月上线更快的 `tuic` 协议(Clash Verge 客户端最佳搭配)
- 解锁流媒体及 ChatGPT
- 官网https://dg1.top
</details>
2023-10-10 10:25:57 +08:00
<br />
2023-10-10 10:25:01 +08:00
2023-10-11 00:04:56 +08:00
[EEVPN —— 海外运营机场 ※ 支持 ChatGPT](https://www.eejsq.net/#/register?code=yRr6qBO3)
2023-10-10 10:25:01 +08:00
- 年付低至 9.99 元,价格低,速度不减
<details>
<summary>Promotion Detail</summary>
- 中国大陆 BGP 网络接入
- IEPL 专线网络
- 最高 2500Mbps 速率可用
- 不限制在线客户端
- 解锁流媒体及 ChatGPT
- 海外运营 数据安全
</details>
2022-03-18 19:02:53 +08:00
## Install
2022-03-21 21:55:45 +08:00
Download from [release](https://github.com/zzzgydi/clash-verge/releases). Supports Windows x64, Linux x86_64 and macOS 11+
2022-03-18 19:02:53 +08:00
2023-09-11 10:24:44 +08:00
- [Windows x64](https://github.com/zzzgydi/clash-verge/releases/download/v1.3.7/Clash.Verge_1.3.7_x64_en-US.msi)
- [macOS intel](https://github.com/zzzgydi/clash-verge/releases/download/v1.3.7/Clash.Verge_1.3.7_x64.dmg)
- [macOS arm](https://github.com/zzzgydi/clash-verge/releases/download/v1.3.7/Clash.Verge_1.3.7_aarch64.dmg)
- [Linux AppImage](https://github.com/zzzgydi/clash-verge/releases/download/v1.3.7/clash-verge_1.3.7_amd64.AppImage)
- [Linux deb](https://github.com/zzzgydi/clash-verge/releases/download/v1.3.7/clash-verge_1.3.7_amd64.deb)
2023-08-05 13:38:19 +08:00
2022-03-18 19:02:53 +08:00
Or you can build it yourself. Supports Windows, Linux and macOS 10.15+
Notes: If you could not start the app on Windows, please check that you have [Webview2](https://developer.microsoft.com/en-us/microsoft-edge/webview2/#download-section) installed.
2021-12-26 02:31:55 +08:00
2023-08-05 13:41:30 +08:00
### FAQ
2023-08-05 13:38:19 +08:00
#### 1. **macOS** "Clash Verge" is damaged and can't be opened
open the terminal and run `sudo xattr -r -d com.apple.quarantine /Applications/Clash\ Verge.app`
2021-12-26 02:31:55 +08:00
## Development
2023-03-07 22:55:38 +08:00
You should install Rust and Nodejs, see [here](https://tauri.app/v1/guides/getting-started/prerequisites) for more details. Then install Nodejs packages.
2021-12-26 02:31:55 +08:00
```shell
yarn install
```
2022-02-22 21:54:33 +08:00
Then download the clash binary... Or you can download it from [clash premium release](https://github.com/Dreamacro/clash/releases/tag/premium) and rename it according to [tauri config](https://tauri.studio/docs/api/config/#tauri.bundle.externalBin).
2021-12-26 02:31:55 +08:00
```shell
2023-08-05 13:38:19 +08:00
# force update to latest version
# yarn run check --force
2022-01-10 02:49:42 +08:00
yarn run check
2021-12-26 02:31:55 +08:00
```
Then run
```shell
yarn dev
2023-08-05 13:38:19 +08:00
# run it in another way if app instance exists
yarn dev:diff
2021-12-26 02:31:55 +08:00
```
2022-03-18 19:02:53 +08:00
Or you can build it
```shell
yarn build
```
2021-12-26 02:31:55 +08:00
## Todos
> This keng is a little big...
## Screenshots
<div align="center">
2022-01-10 02:52:12 +08:00
<img src="./docs/demo1.png" alt="demo1" width="32%" />
<img src="./docs/demo2.png" alt="demo2" width="32%" />
<img src="./docs/demo3.png" alt="demo3" width="32%" />
<img src="./docs/demo4.png" alt="demo4" width="32%" />
<img src="./docs/demo5.png" alt="demo5" width="32%" />
<img src="./docs/demo6.png" alt="demo6" width="32%" />
2021-12-26 02:31:55 +08:00
</div>
2022-04-06 01:52:20 +08:00
### Custom Theme
<div align="center">
<img src="./docs/color1.png" alt="demo1" width="16%" />
<img src="./docs/color2.png" alt="demo2" width="16%" />
<img src="./docs/color3.png" alt="demo3" width="16%" />
<img src="./docs/color4.png" alt="demo4" width="16%" />
<img src="./docs/color5.png" alt="demo5" width="16%" />
<img src="./docs/color6.png" alt="demo6" width="16%" />
</div>
2021-12-26 02:31:55 +08:00
## Disclaimer
This is a learning project for Rust practice.
## Contributions
2022-02-22 21:54:33 +08:00
Issue and PR welcome!
2021-12-26 02:31:55 +08:00
2022-01-22 23:57:39 +08:00
## Acknowledgement
Clash Verge was based on or inspired by these projects and so on:
- [tauri-apps/tauri](https://github.com/tauri-apps/tauri): Build smaller, faster, and more secure desktop applications with a web frontend.
- [Dreamacro/clash](https://github.com/Dreamacro/clash): A rule-based tunnel in Go.
2022-06-20 02:06:46 +08:00
- [MetaCubeX/Clash.Meta](https://github.com/MetaCubeX/Clash.Meta): A rule-based tunnel in Go.
2022-01-22 23:57:39 +08:00
- [Fndroid/clash_for_windows_pkg](https://github.com/Fndroid/clash_for_windows_pkg): A Windows/macOS GUI based on Clash.
- [vitejs/vite](https://github.com/vitejs/vite): Next generation frontend tooling. It's fast!
2021-12-26 02:31:55 +08:00
## License
2022-01-22 23:57:39 +08:00
GPL-3.0 License. See [License here](./LICENSE) for details.