feat: handshake message and add missing docs

Author: RedVortexDev

src/main/java/com/mcdiamondfire/proto/ModAPIMessages.java

@@ -5,6 +5,7 @@
 import com.mcdiamondfire.proto.messages.clientbound.plot.*;
 import com.mcdiamondfire.proto.messages.clientbound.server.*;
 import com.mcdiamondfire.proto.messages.serverbound.player.*;
+import com.mcdiamondfire.proto.messages.serverbound.server.C2SModAPIConnect;
 
 import java.util.*;
 
@@ -22,6 +23,7 @@ public final class ModAPIMessages {
 
 		// Server.
 		registerMessage(S2CServerInfo.class, "s2c_server_info");
+		registerMessage(S2CConnectionResult.class, "s2c_connection_result");
 		registerMessage(S2CServerBooster.class, "s2c_server_booster");
 
 		// Plot.

src/main/proto/clientbound_player.proto

@@ -82,18 +82,18 @@ message S2CChestReference {
 
 		// A standard return value, which contains the value and descriptions fields.
 		message Standard {
-			Value value_type = 1;
-			repeated string descriptions = 2;
+			Value value_type = 1; // The value type of the return value.
+			repeated string descriptions = 2; // The description of the return value as a list of serialized components in JSON format.
 		}
 
 		// A simple return value, which only contains a text field.
 		message Simple {
-			string text = 1;
+			string text = 1; // The text of the return value as a serialized component in JSON format.
 		}
 
 		oneof return_value_type {
-			Standard standard_value = 1;
-			Simple simple_value = 2;
+			Standard standard_value = 1; // A standard return value.
+			Simple simple_value = 2; // A simple return value.
 		}
 	}
 

src/main/proto/clientbound_plot.proto

@@ -34,6 +34,7 @@ message S2CPlotInfo {
 		MISCELLANEOUS = 12; // Plots that don't really fit the other categories!
 	}
 
+	// Represents a cuboid region in the world.
 	message Region {
 		WorldLocation min = 1; // The minimum corner of the region.
 		WorldLocation max = 2; // The maximum corner of the region.
@@ -59,6 +60,7 @@ message S2CPlotInfo {
 // error is true if the operation failed (see each operation for details),
 // template is not empty only if a get operation succeeded.
 message S2CCodeOperationResult {
+	// Represents an error that occurred while performing a code operation.
 	enum Error {
 		NONE = 0; // No error, the operation succeeded.
 		NO_PERMISSION = 1; // The player does not have developer permissions on the plot.
@@ -101,6 +103,7 @@ message S2CPlotLineStarters {
 // Sent when a line starter is added or removed from the plot,
 // requires the player to have developer permissions on the plot.
 message S2CPlotLineStarterUpdate {
+	// Represents an action performed on a line starter.
 	enum Action {
 		ADD = 0; // A line starter was added.
 		REMOVE = 1; // A line starter was removed.

src/main/proto/clientbound_server.proto

@@ -3,7 +3,7 @@ syntax = "proto3";
 option java_package = "com.mcdiamondfire.proto.messages.clientbound.server";
 option java_multiple_files = true;
 
-// Sent when the player joins the server.
+// Sent when the player joins the server, the server is ready to accept a S2CModAPIConnect message.
 message S2CServerInfo {
 	// Represents a server type.
 	enum DFServerType {
@@ -22,6 +22,16 @@ message S2CServerInfo {
 	DFServerType server_type = 4; // The type of the server.
 }
 
+// Sent as a response to a C2SModAPIConnect message.
+message S2CConnectionResult {
+	enum Error {
+		NONE = 0; // No error, the connection was successful.
+		INVALID_PROTOCOL = 1; // The given protocol version is invalid.
+		INCOMPATIBLE_PROTOCOL = 2; // The given protocol version is incompatible with the server.
+	}
+	optional Error error = 1; // The error, if any.
+}
+
 // Sent when the player joins the server.
 message S2CServerBooster {
 	// Represents an active booster.

src/main/proto/serverbound_player.proto

@@ -9,10 +9,3 @@ option java_multiple_files = true;
 message C2SPlayerTeleport {
 	WorldLocation location = 1; // The location to teleport to.
 }
-
-// Notifies the server you are interested in receiving ModAPI messages.
-// This must be sent before any ModAPI messages are sent by the client.
-// If the protocol versions are major version incompatible, the request will be voided.
-message C2SModAPIConnect {
-	string protocol_version = 1; // The version of the protocol the client is using.
-}

src/main/proto/serverbound_server.proto

@@ -0,0 +1,12 @@
+syntax = "proto3";
+import "data_type.proto";
+
+option java_package = "com.mcdiamondfire.proto.messages.serverbound.server";
+option java_multiple_files = true;
+
+// Notifies the server you are interested in receiving ModAPI messages.
+// This must be sent before any ModAPI messages are sent by the client.
+// A S2CConnectionResult message will be sent in response.
+message C2SModAPIConnect {
+  string protocol_version = 1; // The version of the protocol the client is using.
+}