Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rfresh2/zenithproxy
2b2t minecraft proxy
https://github.com/rfresh2/zenithproxy
Last synced: 18 days ago
JSON representation
2b2t minecraft proxy
- Host: GitHub
- URL: https://github.com/rfresh2/zenithproxy
- Owner: rfresh2
- License: other
- Created: 2022-04-10T05:56:37.000Z (over 2 years ago)
- Default Branch: 1.20.4
- Last Pushed: 2024-04-24T09:18:21.000Z (7 months ago)
- Last Synced: 2024-04-24T12:04:06.549Z (7 months ago)
- Language: Java
- Size: 8.42 MB
- Stars: 77
- Watchers: 1
- Forks: 22
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ZenithProxy
Minecraft proxy/bot intended for use on 2b2t.org.
Unlike a traditional MC bot, you can login to it as a normal MC server and control the account.
The primary purpose is to have accounts always online in-game and securely shared by multiple people.
This project is also used to support the [2b2t.vc API](https://api.2b2t.vc) and [Discord Bot](https://bot.2b2t.vc).
What is a proxy?
This proxy itself consists of two components:
1. A Minecraft Server ("Proxy Server")
2. A Minecraft Client ("Proxy Client")
Players use a Minecraft client to connect to the Proxy Server as you would a normal MC server.
The Proxy Client connects to a destination MC server (i.e. 2b2t.org).
The Player's packets to the Proxy Server get forwarded to the Proxy Client which
forwards them to the destination MC server.
Player MC Client -> Proxy Server -> Proxy Client -> MC Server
When no Player Client is connected the Proxy Client will act
as a bot: moving around, chatting, etc.
How does it work?
ZenithProxy does not use, depend on, or interact with the Minecraft client or server code.
This means much greater opportunities for optimizing memory usage and performance.
But this also means existing MC mods or plugins cannot be used and must be
reimplemented specifically for ZenithProxy.
ZenithProxy acts primarily at the network packet layer. It can read/modify/cancel/send
arbitrary packets in either direction at any time.
Using packet interception, the client's session and world state is cached and
sent to players when they connect.
The cached world state is also used to simulate player movements,
inventory actions, discord chat relay, and all features.
# Features
* High performance and efficiency on minimal hardware, <300MB RAM per java instance or <150MB on linux.
* Integrated ViaVersion
* Can connect to (almost) any MC server and players can connect with (almost) any MC client
* Secure Whitelist system - share MC accounts without sharing passwords
* Extensive Discord Bot integration for management and monitoring
* Chat relay
* Customizable pings, alerts, and notifications. e.g. Player in visual range alerts
* Command System - Discord, In-game, and Terminal
* 25+ commands and modules to configure every feature
* Spectator mode
* Multiple players can connect to the proxy and spectate the player
* Advanced AntiAFK with full player movement simulation
* Integrated ReplayMod Recording
* Modules including AutoEat, AutoDisconnect, AutoReconnect, AutoRespawn, AutoTotem, KillAura, Spammer, AutoReply
* Many, many, more features.
# Getting Started
## Setup and Download
### System Requirements
1. Linux, Windows, or Mac computer. I recommend using a VPS (droplet) from DigitalOcean:
* [$200 Free Digital](https://m.do.co/c/f3afffef9a46)[Ocean Credits](https://m.do.co/c/3a3a226e4936).
* [Guide and automatic setup script](https://github.com/rfresh2/ZenithProxy/wiki/DigitalOcean-Setup-Guide).
2. Java 21+ (Not required for `linux` release channel on supported CPU)
* The ZenithProxy launcher will install Java 21 automatically if not already installed
### Launcher
1. Download [the launcher zip](https://github.com/rfresh2/ZenithProxy/releases/launcher-v3) for your system
* For other systems, download the Python version (Universal). Requires [Python 3.10+](https://www.python.org/downloads/)
2. Unzip the file.
3. Double click or run the launcher executable in a terminal:
* Windows: `.\launch.exe`
* Linux/Mac: `./launch`
* (Terminal Only) Python Universal: `./launch.sh` (Linux/Mac) or `.\launch.bat` (Windows)
How do I download a file from a Linux terminal?
* Use [wget](https://linuxize.com/post/wget-command-examples/#how-to-download-a-file-with-wget) in the terminal
* Example: `wget https://github.com/rfresh2/ZenithProxy/releases/download/launcher-v3/ZenithProxy-launcher-linux-amd64.zip`
Recommended unzip tools
* Windows: [7zip](https://www.7-zip.org/download.html)
* Linux: [unzip](https://linuxize.com/post/how-to-unzip-files-in-linux/)
* Mac: [The Unarchiver](https://theunarchiver.com/)
Recommended Terminals
* Windows: [Windows Terminal](https://apps.microsoft.com/detail/9N8G5RFZ9XK3)
* Mac: [iterm2](https://iterm2.com/)
### Run
* The launcher will ask for all configuration on first launch
* Or run the launcher with the `--setup` flag. e.g. `.\launch.exe --setup`
* Use the `connect` command to link an MC account and log in once ZenithProxy is launched
* Command Prefixes:
* Discord: `.` (e.g. `.help`)
* In-game: `/` OR `!` -> (e.g. `/help`)
* Terminal: N/A -> (e.g. `help`)
* [Full Commands Documentation](https://github.com/rfresh2/ZenithProxy/wiki/Commands)
### Running on Linux Servers
See the [Linux Guide](https://github.com/rfresh2/ZenithProxy/wiki/Linux-Guide)
I highly recommend using a terminal multiplexer - a program that manages terminal sessions.
If you do not use one, **ZenithProxy will be killed after you exit your SSH session.**
* (Recommended) [tmux](https://tmuxcheatsheet.com/how-to-install-tmux/)
* [screen](https://linuxize.com/post/how-to-use-linux-screen/)
* [pm2](https://pm2.keymetrics.io/docs/usage/quick-start/)
## Configuration
### Release Channels
* (Default) `java` - Supports all operating systems
* (Recommended) `linux` - Linux native x86_64 executable. ~50% reduced memory usage and instant startup
### DNS Setup
* To use a domain name you need the following DNS records:
* an `A` record to the public IP address of your server [Example](https://i.imgur.com/IvFhjhI.png)
* an `SRV` record for `_minecraft._tcp` with the port and the `A` record as its target. [Example](https://i.imgur.com/D4XDGDF.png)
### Discord Bot Setup
* Create a discord bot here: [discord.com/developers](https://discord.com/developers/)
* Enable `Message Content Intent` under the "Bot" tab. [Example](https://i.imgur.com/iznLeDV.png)
* Invite the discord bot to a server.
* Create a role for users to manage the proxy, a channel to manage the
proxy in, and a channel for the chat relay. The bot's role must have permissions to send and receive messages in both channels
* Configure in ZenithProxy using the `discord` command. Or run the launcher with the `--setup` flag.
## Running Multiple Instances
Create a new folder for each instance with its own copy of the launcher files. [Example](https://i.imgur.com/OTkKIti.png)
Instances must be independently run and configured. i.e. separate terminal sessions, discord bots, ports, config files, etc.
See the [Linux Guide](https://github.com/rfresh2/ZenithProxy/wiki/Linux-Guide) for help copying files, creating folders, etc.
### 2b2t Limits
2b2t limits accounts without priority queue based on:
1. Accounts currently connected per IP address
2. In-game session time, excluding time in queue.
Current limits are documented in [a discord channel](https://discord.com/channels/1127460556710883391/1200685719073599488)
## Special Thanks
* [Pork2b2tBot Contributors](https://github.com/PorkStudios/Pork2b2tBot/graphs/contributors)
* [MCProtocolLib Contributors](https://github.com/GeyserMC/MCProtocolLib/graphs/contributors)