Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .git-blame-ignore-revs
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Format Markdown documentation with Flowmark.
819fecec5b68a64a17389d0b4ce2c4de5b0553a5
6 changes: 4 additions & 2 deletions en/guide/contact.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Contact Information

- Ask questions or report issues: [GitHub Issues](https://github.com/EasyTier/EasyTier/issues)
- Discussion and communication: [GitHub Discussions](https://github.com/EasyTier/EasyTier/discussions)
- Ask questions or report issues:
[GitHub Issues](https://github.com/EasyTier/EasyTier/issues)
- Discussion and communication:
[GitHub Discussions](https://github.com/EasyTier/EasyTier/discussions)
- QQ Group: [949700262](https://qm.qq.com/q/LDxBN5L3kA)
- Telegram: https://t.me/easytier
26 changes: 16 additions & 10 deletions en/guide/gui/astral-game.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,32 @@
[![AstralGame](https://img.shields.io/badge/wiki-AstralGame-blue)](https://astral.fan/)

## Preview
![manage-step1](/assets/AstralET1.png)
![manage-step1](/assets/AstralET2.png)
![manage-step1](/assets/AstralET3.png)
![manage-step1](/assets/AstralET4.png)

![manage-step1](/assets/AstralET1.png) ![manage-step1](/assets/AstralET2.png)
![manage-step1](/assets/AstralET3.png) ![manage-step1](/assets/AstralET4.png)
![manage-step1](/assets/AstralET5.png)

## Usage Tutorial

- https://astral.fan/quick-start/what-is-astral/

## Introduction

AstralGame is a lightweight game networking tool developed based on **Flutter** and **EasyTier**, designed to provide players with a simple and efficient online gaming experience.
AstralGame is a lightweight game networking tool developed based on **Flutter** and
**EasyTier**, designed to provide players with a simple and efficient online gaming
experience.

## Features

- **Built-in EasyTier**: Directly integrates EasyTier into AstralGame, eliminating the need for additional installations and leaving no background processes.
- **Plug-and-Play**: Launch the app when connecting, close it when done—simple and convenient.
- **Actively Maintained**: Regular updates ensure quick issue resolution and continuous feature optimization (a productivity boost during work breaks).
- **Built-in EasyTier**: Directly integrates EasyTier into AstralGame, eliminating the
need for additional installations and leaving no background processes.
- **Plug-and-Play**: Launch the app when connecting, close it when done—simple and
convenient.
- **Actively Maintained**: Regular updates ensure quick issue resolution and continuous
feature optimization (a productivity boost during work breaks).

## Contact & Support

- **QQ Group**: [Join Our QQ Community](https://qm.qq.com/q/r4VsExDDt6)
- **GitHub Issues**: [Report Bugs or Suggest Features](https://github.com/ldoubil/astral/issues)
- **QQ Group**: [Join Our QQ Community](https://qm.qq.com/q/r4VsExDDt6)
- **GitHub Issues**:
[Report Bugs or Suggest Features](https://github.com/ldoubil/astral/issues)
8 changes: 6 additions & 2 deletions en/guide/gui/basic.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
# Quick Networking

The configuration method is shown in the figure. EasyTier nodes do not distinguish between server and client. As long as the nodes can directly connect to each other or connect through an initial node (similar to plugging in a network cable), they can join the network.
The configuration method is shown in the figure.
EasyTier nodes do not distinguish between server and client.
As long as the nodes can directly connect to each other or connect through an initial
node (similar to plugging in a network cable), they can join the network.

![Configuration Interface](/assets/cn/config.png)

After the configuration is complete, click the Run Network button. The interface after the network runs successfully is shown in the figure.
After the configuration is complete, click the Run Network button.
The interface after the network runs successfully is shown in the figure.

![Running](/assets/cn/running.png)
46 changes: 31 additions & 15 deletions en/guide/gui/easytier-game.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,40 +2,56 @@

## Introduction

EasyTier Game Launcher is developed with `nuxt3`, `typescript`, `rust`, and `tauri`. It has a simple interface and comes with the latest EasyTier core. When playing multiplayer games, it provides the most comfortable experience both psychologically and practically. It also supports custom configuration file startup to meet various needs.
EasyTier Game Launcher is developed with `nuxt3`, `typescript`, `rust`, and `tauri`. It
has a simple interface and comes with the latest EasyTier core.
When playing multiplayer games, it provides the most comfortable experience both
psychologically and practically.
It also supports custom configuration file startup to meet various needs.

## Download

GitHub Releases: [https://github.com/EasyTier/EasytierGame/releases](https://github.com/EasyTier/EasytierGame/releases)
GitHub Releases: https://github.com/EasyTier/EasytierGame/releases

- Only green zip packages are available. Personally, I don't like installers that write to the registry. Just extract and use, keeping the directory clean and tidy.
- Only green zip packages are available.
Personally, I don’t like installers that write to the registry.
Just extract and use, keeping the directory clean and tidy.

![game-step1](/assets/game-step1.png)

## Tutorial

- For the first use, enter a "hostname" and click to start the connection. Later, you can create your own server or use servers provided by kind community members.
![game-step2](/assets/game-step2.png)
- For the first use, enter a “hostname” and click to start the connection.
Later, you can create your own server or use servers provided by kind community
members. ![game-step2](/assets/game-step2.png)

![game-step3](/assets/game-step3.png)

- There are some special configurations in the advanced options that you can choose from.
![game-step4](/assets/game-step4.png)
- There are some special configurations in the advanced options that you can choose
from. ![game-step4](/assets/game-step4.png)

- If your needs are still not met, you can use a configuration file to start. For details on how to configure, refer to the documentation [Configuration File](/guide/network/config-file.html).
- If your needs are still not met, you can use a configuration file to start.
For details on how to configure, refer to the documentation
[Configuration File](/guide/network/config-file.html).
![game-step5](/assets/game-step5.png)

- After upgrading the EasyTier core, you can click the update plugin button to update. However, you need to use a VPN. If you cannot update, you can get the update from the community.
![game-step6](/assets/game-step6.png)
- After upgrading the EasyTier core, you can click the update plugin button to update.
However, you need to use a VPN. If you cannot update, you can get the update from the
community. ![game-step6](/assets/game-step6.png)

## Features

- Developed based on the EasyTier networking tool with a clear and simple interface.
- Built-in "Update" button. When the EasyTier networking tool releases a new version, just click update (requires VPN).
- For the first use, enter a "hostname" and click to start the connection. Later, you can create your own server or use community servers.
- Simple configuration with advanced features, also supports custom configuration file startup.
- **WinIPBroadcast** is enabled by default, no longer afraid of not finding rooms when connecting (e.g., Borderlands 3).
- Tested with **Elden Ring learning version**, **Borderlands 3**, **Deep Rock Galactic**, **Monster Hunter World**, etc., all can be played stably.
- Built-in “Update” button.
When the EasyTier networking tool releases a new version, just click update (requires
VPN).
- For the first use, enter a “hostname” and click to start the connection.
Later, you can create your own server or use community servers.
- Simple configuration with advanced features, also supports custom configuration file
startup.
- **WinIPBroadcast** is enabled by default, no longer afraid of not finding rooms when
connecting (e.g., Borderlands 3).
- Tested with **Elden Ring learning version**, **Borderlands 3**, **Deep Rock
Galactic**, **Monster Hunter World**, etc., all can be played stably.

## System Support

Expand Down
48 changes: 33 additions & 15 deletions en/guide/gui/easytier-manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,31 @@

## Download

GitHub Releases: [https://github.com/xlc520/easytier-manager/releases](https://github.com/xlc520/easytier-manager/releases)
GitHub Releases: https://github.com/xlc520/easytier-manager/releases

#### Package Descriptions

- `exe`: Installer, must be installed before use
- `zip`: Portable, extract and use directly
- `easytier-manager-win_2.0.0.exe`: Universal installer for 64-bit and 32-bit Windows systems
- `easytier-manager-win_2.0.0.exe`: Universal installer for 64-bit and 32-bit Windows
systems
- `easytier-manager-win-x64_2.0.0.exe`: 64-bit Windows system installer
- `easytier-manager-win-ia32_2.0.0.exe`: 32-bit Windows system installer
- `easytier-manager-win7-x64_2.0.0.exe`: 64-bit Windows 7 system installer
- `tar.gz` `deb` `rpm` `AppImage`: For Linux systems (not yet tested)

## Tutorial

- **1. [Important] Settings page: Check if the kernel exists, if not, download the kernel, then install it, and check again if the kernel exists** (only needed for first use, subsequent confirmations can run directly)
- **1. [Important] Settings page: Check if the kernel exists, if not, download the
kernel, then install it, and check again if the kernel exists** (only needed for first
use, subsequent confirmations can run directly)

![manage-step1](/assets/manage-step1.png)

![manage-step2](/assets/manage-step2.png)

- 2. Configuration page: Create new network configurations, providing both direct code editing and form filling methods
- 2. Configuration page: Create new network configurations, providing both direct code
editing and form filling methods

![manage-step3](/assets/manage-step3.png)

Expand All @@ -36,35 +40,49 @@ GitHub Releases: [https://github.com/xlc520/easytier-manager/releases](https://g

![manage-step7](/assets/manage-step7.png)

- 4. [Optional] After successful networking, if the connection is fine, you can exit the manager. The core program will run in the background (right-click the tray icon to "Exit")
- 4. [Optional] After successful networking, if the connection is fine, you can exit the
manager. The core program will run in the background (right-click the tray icon to
“Exit”)

- 5. [Optional] On the configuration page, install specified configurations as system services
- 5. [Optional] On the configuration page, install specified configurations as system
services

![manage-step8](/assets/manage-step8.png)

![manage-step9](/assets/manage-step9.png)

## Introduction

EasyTier Manager integrates Vue3 + Vite5 + Electron33 + Element-Plus. It is a free and open-source network manager based on `element-plus`. It is developed using the latest mainstream technologies such as `vue3`, `vite5`, `TypeScript`, etc.
EasyTier Manager integrates Vue3 + Vite5 + Electron33 + Element-Plus.
It is a free and open-source network manager based on `element-plus`. It is developed
using the latest mainstream technologies such as `vue3`, `vite5`, `TypeScript`, etc.

## Features

- **Memory Usage**: After successful networking, you can directly exit the manager without affecting the network, so it won't occupy memory or cause memory leaks due to various issues
- **Multi-Configuration Startup**: Supports running and managing multiple network configurations
- **System Service Installation**: One-click installation as a system service with visual interface, auto-start on boot
- **Visual Configuration Addition**: Provides form-based visual addition of network configurations, simple and convenient
- **Memory Usage**: After successful networking, you can directly exit the manager
without affecting the network, so it won’t occupy memory or cause memory leaks due to
various issues
- **Multi-Configuration Startup**: Supports running and managing multiple network
configurations
- **System Service Installation**: One-click installation as a system service with
visual interface, auto-start on boot
- **Visual Configuration Addition**: Provides form-based visual addition of network
configurations, simple and convenient
- **Visual Log Viewing**: View logs of current network configurations on the home page
- **One-Click Download and Install**: One-click download and installation of the kernel with built-in accelerated sources, no manual download required
- **Latest Tech Stack**: Developed using cutting-edge frontend technologies like Electron33/Vue3/vite5
- **One-Click Download and Install**: One-click download and installation of the kernel
with built-in accelerated sources, no manual download required
- **Latest Tech Stack**: Developed using cutting-edge frontend technologies like
Electron33/Vue3/vite5
- **TypeScript**: Application-level JavaScript language
- **Internationalization**: Built-in comprehensive internationalization solution

## Bug Reports & Suggestions

> Tending towards stability, may not develop new features, only fix vulnerabilities and such
> Tending towards stability, may not develop new features, only fix vulnerabilities and
> such

You can check [TODO](https://github.com/xlc520/easytier-manager/blob/master/TODO.md) to see if it's already recorded to avoid duplication
You can check [TODO](https://github.com/xlc520/easytier-manager/blob/master/TODO.md) to
see if it’s already recorded to avoid duplication

[Submit Bug | Feature Request](https://github.com/xlc520/easytier-manager/issues/new/choose)

Expand Down
6 changes: 4 additions & 2 deletions en/guide/gui/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# Graphical User Interface (GUI) Networking

The graphical interface program can also be downloaded from the GitHub Release page, with the prefix easytier-gui.
The graphical interface program can also be downloaded from the GitHub Release page,
with the prefix easytier-gui.

Note that after installation on MacOS, you need to execute the following command in the terminal, otherwise, it will mistakenly report that the file is damaged.
Note that after installation on MacOS, you need to execute the following command in the
terminal, otherwise, it will mistakenly report that the file is damaged.

```bash
xattr -c /Applications/easytier-gui.app
Expand Down
64 changes: 43 additions & 21 deletions en/guide/gui/qteasytier.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,65 +2,87 @@

## Project Introduction

QtEasyTier is a cross-region networking tool developed based on the Qt framework, designed for creating and managing virtual network connections.
It provides an intuitive graphical interface, helping users easily configure and manage virtual networks to achieve secure communication across network devices.
QtEasyTier is a cross-region networking tool developed based on the Qt framework,
designed for creating and managing virtual network connections.
It provides an intuitive graphical interface, helping users easily configure and manage
virtual networks to achieve secure communication across network devices.

Project Address: https://gitee.com/viagrahuang/qt-easy-tier

![QtEasyTier](/assets/qteasytier1.png)

## Features

- **Fast:** The program is developed using pure Qt C++, features system-native rendering, does not rely on Chromium or Webview, daily frontend memory usage stays under 50MB, ensuring efficient and fast operation.
- **Beautiful:** The UI style utilizes the Breeze style ported from KDE, providing a clean, aesthetically pleasing, and modern user interface. The program's UI layout is simple, logical, and intuitive, making it easy to learn, especially suitable for scenarios running multiple networks simultaneously.
- **Fast:** The program is developed using pure Qt C++, features system-native
rendering, does not rely on Chromium or Webview, daily frontend memory usage stays
under 50MB, ensuring efficient and fast operation.
- **Beautiful:** The UI style utilizes the Breeze style ported from KDE, providing a
clean, aesthetically pleasing, and modern user interface.
The program’s UI layout is simple, logical, and intuitive, making it easy to learn,
especially suitable for scenarios running multiple networks simultaneously.

## Platform Support

- Windows 10/11
- Linux support is planned for the future
- Mac currently has no support plan (primarily because the author doesn't have a Macbook), but contributions from experts are welcome
- Mac currently has no support plan (primarily because the author doesn’t have a
Macbook), but contributions from experts are welcome

## Quick Start
For details, please visit the [Help Documentation](https://gitee.com/viagrahuang/qt-easy-tier/blob/master/assets/help.md)

For details, please visit the
[Help Documentation](https://gitee.com/viagrahuang/qt-easy-tier/blob/master/assets/help.md)

- Double-click `QtEasyTier.exe` to launch the application
- Click the plus sign in the bottom right corner to create a network configuration
- Enter basic information such as network name, username, password, or click 'Import Configuration' below
- Enter basic information such as network name, username, password, or click ‘Import
Configuration’ below
- Configure advanced options (optional)
- Click the "Run Network" button to initiate the network connection
- Click the Run Network button to initiate the network connection

## Related Projects This Program Depends On or Uses

### EasyTier

A simple, secure, decentralized cross-region networking solution powered by Rust and Tokio.
- Official Website: [https://easytier.cn/](https://easytier.cn/)
A simple, secure, decentralized cross-region networking solution powered by Rust and
Tokio.
- Official Website: https://easytier.cn/

### Qt Framework

Qt is a cross-platform C++ application development framework used for creating graphical user interfaces (GUIs) and other applications.
- Official Website: [https://www.qt.io/](https://www.qt.io/)
Qt is a cross-platform C++ application development framework used for creating graphical
user interfaces (GUIs) and other applications.
- Official Website: https://www.qt.io/

### Breeze

Breeze is the default theme for the KDE Plasma desktop environment. This program incorporates its style library adapted for the Qt framework to provide users with a beautiful interface.
- Official Website: [https://kde.org/](https://kde.org/)
Breeze is the default theme for the KDE Plasma desktop environment.
This program incorporates its style library adapted for the Qt framework to provide
users with a beautiful interface.
- Official Website: https://kde.org/

## Contact the Author
- Project Address: [https://gitee.com/viagrahuang/qt-easy-tier](https://gitee.com/viagrahuang/qt-easy-tier)

- Project Address: https://gitee.com/viagrahuang/qt-easy-tier
- Issue Reporting: Welcome to submit Issues and PRs
- Contact Methods:
- The author is active in the EasyTier Support Group 3, feel free to join for discussion: 957189589
- The author is active in the EasyTier Support Group 3, feel free to join for
discussion: 957189589
- Bilibili Space: [space.bilibili.com/558600071](https://space.bilibili.com/558600071)

## License

This project is licensed under the GNU General Public License v3.0 (GPLv3). For details, please see the LICENSE file.
This project is licensed under the GNU General Public License v3.0 (GPLv3). For details,
please see the LICENSE file.

## Sponsorship and Support

Software development is not easy. Your sponsorship and support are vital motivation for the continuous development and maintenance of this project, and they also recognize the author's ongoing efforts.
If you find this project helpful, please consider supporting it through the following methods.
Software development is not easy.
Your sponsorship and support are vital motivation for the continuous development and
maintenance of this project, and they also recognize the author’s ongoing efforts.
If you find this project helpful, please consider supporting it through the following
methods.

1. Contribute a public server: Contact via email viagrahuang@88.com
2. Help fix bugs, add features, port to other platforms, etc.: [Project Address](https://gitee.com/viagrahuang/qt-easy-tier)
1. Contribute a public server: Contact via email viagrahuang@88.com
2. Help fix bugs, add features, port to other platforms, etc.:
[Project Address](https://gitee.com/viagrahuang/qt-easy-tier)
Loading