mirror of
https://github.com/PlayPro/CoreProtect.git
synced 2024-11-25 12:25:37 +01:00
8cdf99429d
* sent data to client * send more data + debug + add docs + switch to handshake * add diff between container and normal changes * fix docs * changes according guidelines * make requested changes + cleanup * correct documentation * Improved Networking API documentation * Moved networking API channel registration out of main class * Cleanup * Removed debug on chat/command lookups * Optimized array merging * Fixed ClassCastException when running console commands * Skip preparing networking data if not a channel player * Renamed "networking-debug" to "network-debug" * Fixed failed handshake still registering players * Adjusted networking phrases * Renamed pluginchannel to channel Co-authored-by: Intelli <contact@intelli.software>
3.4 KiB
3.4 KiB
Networking API
The CoreProtect Networking API allows clients to receive data using packets.
Networking Details | |
---|---|
Networking Version: | 1 |
Plugin Version: | v21.3+ |
Packets
The server will not respond unless the player has the correct permission, which is coreprotect.networking
.
Server to Client
Data Packet
Sends data from the database.
- Channel:
coreprotect:data
Type: Int |
1 | 2 | 3 | 4 |
---|---|---|---|---|
Time: long |
Time: long |
Time: long |
Time: long |
|
Phrase selector: UTF |
Phrase selector: UTF |
Result User: UTF |
Result User: UTF |
|
Result User: UTF |
Result User: UTF |
Message: UTF |
Target: UTF |
|
Target: UTF |
Amount: Int |
Sign: Boolean |
||
Amount: Int |
X: Int |
X: Int |
||
X: Int |
Y: Int |
Y: Int |
||
Y: Int |
Z: Int |
Z: Int |
||
Z: Int |
World name: UTF |
World name: UTF |
||
World name: UTF |
||||
Rolledback: Boolean |
||||
isContainer: Boolean |
||||
Added: Boolean |
Example (Fabric):
ByteArrayInputStream in = new ByteArrayInputStream(buf.getWrittenBytes());
DataInputStream dis = new DataInputStream(in);
int type = dis.readInt();
long time = dis.readLong();
String selector = dis.readUTF();
String resultUser = dis.readUTF();
String target = dis.readUTF();
int amount = dis.readInt();
int x = dis.readInt();
int y = dis.readInt();
int z = dis.readInt();
String worldName = dis.readUTF();
boolean rolledback = dis.readBoolean();
boolean isContainer = dis.readBoolean();
boolean added = dis.readBoolean();
Handshake Packet
Sends handshake if player is registered.
- Channel:
coreprotect:handshake
- Registered:
Boolean
Client to Server
Handshake Packet
Sends handshake to register
- Channel:
coreprotect:handshake
- Mod Version:
UTF
- Mod Id:
UTF
- CoreProtect Protocol:
Int
Example (Fabric):
PacketByteBuf packetByteBuf = new PacketByteBuf(Unpooled.buffer());
ByteArrayOutputStream msgBytes = new ByteArrayOutputStream();
DataOutputStream msgOut = new DataOutputStream(msgBytes);
msgOut.writeUTF(modVersion);
msgOut.writeUTF(modId);
msgOut.writeInt(coreprotectProtocol);
packetByteBuf.writeBytes(msgBytes.toByteArray());
Debugging
/co network-debug
Allows you to debug the networking API if you are registered and have correct permissions.
To utilize the command, network-debug: true
must be set in the CoreProtect config.yml
.
Example
/co network-debug <type>