Skip to content

xRookieFight/AquaRelay

The AquaRelay logo
Blazingly fast, lightweight, and easy to use Minecraft: Bedrock Edition proxy server written in PHP

Build Status GitHub all releases


Important

This project is still under development, if you have found a bug please report it from the issues tab.


Features

  • Fast transfer support between Bedrock servers
  • Supports PocketMine-MP, Nukkit, and PowerNukkitX
  • Lightweight and minimal resource usage
  • Easy configuration with simple YAML files
  • Plugin-friendly architecture
  • Modern PHP codebase
  • Actively maintained and open source

Requirements

  • PHP 8.1 or higher
  • Supported OS: Linux, macOS, Windows
  • A Bedrock-compatible server (PocketMine-MP / Nukkit / PowerNukkitX)

Installation

Download

You can download the latest release from: https://github.com/AquaRelay/AquaRelay/releases

Setup

  1. Download PHP (minimum 8.1)
  2. Make a folder of your server. Put the AquaRelay.phar file and start script files into the folder.
  3. Start the server using the start script files.
  4. Change the config.yml file

Usage

Once running, players can:

  • Join through the proxy address
  • Seamlessly transfer between servers
  • Experience reduced connection latency

AquaRelay acts as a transparent layer between clients and backend servers.


Development

Adding to your development

 composer require aquarelay/aquarelay

Running from source

git clone https://github.com/AquaRelay/AquaRelay.git
cd AquaRelay
composer install
php AquaRelay.php

Contributing

We welcome all contributions ❤️ Please read CONTRIBUTING.md before opening a pull request.


Support


License

This project is licensed under the LGPL-3.0 License. See the LICENSE file for details.

About

Blazingly fast, lightweight, and easy to use Minecraft: Bedrock Edition proxy server written in PHP

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Sponsor this project

Packages

 
 
 

Contributors

Languages