ZBProxy

ZBProxy

English | 简体中文

🚀 A simple, fast, high performance multipurpose TCP relay, primarily developed for building Hypixel reverse proxies.

Feature Highlights

• ☝ One click to go
• 📋 Highly customizable configuration
• 🔌 TCP zero-copy relay on Linux with splice(2), and 2 more relay modes
• 👮 Whitelist/Blacklist for IP and Minecraft player name (Access Control)
• 🔄 Configuration hot reload for lists and Minecraft MOTD
• 📦 Tailored high performance and lightweight Minecraft network protocol framework
• 💻 Clean and colorful log outputs, easy to track every connection
• 🔮 Multiple platforms and architectures
• And more...

Join Official Telegram Group

Document (W.I.P)

What can it do?

In many situations you can use Nginx proxy_pass to easy relay your Minecraft data.
The complete code is as follows:

stream {
    server {
        listen 25565;
        proxy_pass TARGET_SERVER_ADDRESS;
    }
}

But start from 2020, Hypixel set up an authentication of the player login address.
If you do not log in from their official address as known as mc.hypixel.net:25565, you will not be able to join the game.
The original method is to cheat the server by modifying the hosts file.
But that's too complicated for people who don't know the principle.
We studied its working principle, and successfully bypassed the detection by modifying the data sent by client at the technical level.
The product of the research is what you see now as ZBProxy.
For players, just enter the address of your proxy server, you can join the game directly as usual.

Is it safe?

There is no need to worry about privacy at all, because the connection to any Minecraft server which requires online verification is fully encrypted.
Our code is completely open source, so you can freely check whether there is a backdoor.

How to use it?

1. Download the compiled executable file at Actions page. Login required.
2. Run it, and your relay service is now established!
   For Linux system, you may need to give permissions to the executable file in order to solve problems that cannot run or run blocked. Just enter the following command:

chmod +x PATH_TO_THE_FILE

1. Ensure the port 25565 is fully open on the server.
2. Enter your proxy server IP into your Minecraft client, and join it for game!
   (Since the listening port is 25565, you don't need to input the port number in the client, and the client will complete it automatically)

Since ZBProxy 3.0, users are allowed to set the listening port and forwarding destination through the automatically generated JSON configuration file, including choosing whether to enable the hostname rewriting function and a series of surprise functions.
At the first startup, a JSON configuration file is automatically generated, which contains a preset Hypixel forwarding configuration, so users can still build forwarding services in only one step like old versions, but reasonable use of the configuration file can help users explore more possibilities of ZBProxy. Including but not limited to quickly setting up an ordinary and efficient reverse proxy.
If you are just new in here, you can view the ZBProxy Document to learn about how to unlock the power of ZBProxy through configuration.

Are there any other ways to improve my games?

Generally speaking, Linux-based operating environments have more room for optimization.
ZBProxy supports Zero Copy technology on Linux, which can reduce memory usage by one time, save a lot of CPU processing, and reduce network latency. When users set Flow to auto or linux-zerocopy on their Service configuration, this technology will be automatically adopted in due course.
If you are running ZBProxy on a Linux-based system, you can go to ZBProxy Document to view tips for optimizing network settings.

TODO List

1. Some functions are still not implemented.

Sponsor

JetBrains for open source support development license.

License