2021-12-26 02:31:55 +08:00
<h1 align="center">
<img src="./src/assets/image/logo.png" alt="Clash" width="128" />
<br>
2023-10-21 17:02:13 +08:00
Clash Nyanpasu
2021-12-26 02:31:55 +08:00
<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.
2023-10-20 11:52:40 +08:00
- Profiles management and enhancement (by yaml and Javascript). [Doc ](https://github.com/keiko233/clash-nyanpasu/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.
## Install
2023-10-20 11:52:40 +08:00
Download from [release ](https://github.com/keiko233/clash-nyanpasu/releases ). Supports Windows x64, Linux x86_64 and macOS 11+
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
2023-10-21 17:02:13 +08:00
#### 1. **macOS** "Clash Nyanpasu" is damaged and can't be opened
2023-08-05 13:38:19 +08:00
2023-10-21 17:02:13 +08:00
open the terminal and run `sudo xattr -r -d com.apple.quarantine /Applications/Clash\ Nyanpasu.app`
2023-08-05 13:38:19 +08:00
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...
## 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
2023-10-21 17:02:13 +08:00
Clash Nyanpasu was based on or inspired by these projects and so on:
2022-01-22 23:57:39 +08:00
2023-10-21 17:02:13 +08:00
- [zzzgydi/clash-verge ](https://github.com/zzzgydi/clash-verge ): A Clash GUI based on tauri. Supports Windows, macOS and Linux.
2022-01-22 23:57:39 +08:00
- [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.
