WaterGate

This is stable and fast plugin for pmmp that allows server connect to WaterDog plugin StarGate. It make easier communication between server. Includes API fur custom packets, transferring players and more

🎯Features:

• Fast communication between servers
• Custom packets
• Moving players between servers (API)

More features will be added very soon

🔧API

You can access WaterGate by WaterGate::getInstance()

Avalibe Functions

• RegisterPacket(WaterGatePacket packet) Really simple method for registring Packet
• putPacket(WaterGatePacket packet, string $client) This allows you to send packet. Packet must be registered first
• transferPlayer(Player player, string server, string $client) This we use to transfer Player between servers
• kickPlayer(Player player, string reason, string $client) Kick player from any server connected to WaterGate network
• isOnline(Player player, string $client) Check if player is online. Sends back response 'true!server' or 'false'.
• forwardPacket(string $destClient, string $localClient, WaterGatePacket $packet) Using ForwardPacket you can forward packet to other client/server
• addServer(string $address, string $port, string $name, string $client) Add server to list and allows players to transfer
• removeServer(string $name, string $client) Remove server from server list

Client variable in API is used to specify destination proxy (if more instances are used). It is not important to define it, if one one proxy is used.

Example:

$player = PLUGIN::getInstance()->getPlayer("xJustJqy");
$server = "lobby2";

WaterGate::getInstance()->transferPlayer($player, $server);

📦Packet Handling

Received Packets are handled by CustomPacketEvent. Official Packets are handled (if needed) automaticly

Accessing Packet from Event:

public function getPacket() {
  return $this->packet;
}

📞ResponseCheckTask

Response checking is useful when we want to get some data created by packet back to client.
PHP allows you to use simple closures to handle result:

$closure = function ($response){
    WaterGate::getInstance()->getLogger()->info("§a".$response);
};
WaterGate::getInstance()->isOnline("xJustJqy", $closure);

⚙️Creating Own Packets

For better understanding please read WaterGatePacket

Docker Implementation

If you have servers inside Docker container this is for you. WaterGate allows you to create/remove/start/stop any container. Using ServerManagePacket you can set container exposed ports and env. variables too.

Convertor

Convertor is used for encoding and decoding packets. We can use it for static and nonstatic usage
Functions:

• packetStringData(string packetString) Exports packetString to data array

• putInt(int integer) Pushes Integer to array

• putString(string string) Pushes String to array

• getString(int key) Returns String from array by key value

• getPacketString() Returns packetString from array data

• static getInt(string string) Returns Integer from String

• static getForcePacketString(array strings) Returns packetString from given array

• static getPacketStringData(string packetString) Returns array data from given string

Example (nonstatic):

$convertor = new Convertor($this->getID());
$convertor->putString($this->server);
$convertor->putInt($this->tps);

$this->encoded = $convertor->getPacketString();

Example (static):

$data = Convertor::getPacketStringData($packetString);
$packetId = (int) $data[0];