diff --git a/build.gradle b/build.gradle index 0a9a4dd..3dd56ba 100644 --- a/build.gradle +++ b/build.gradle @@ -1,10 +1,5 @@ apply plugin: 'java' -wrapper { - gradleVersion = '5.3' - distributionType = Wrapper.DistributionType.BIN -} - project.group = projectGroup project.version = projectVersion diff --git a/src/main/java/mc/protocol/EmptyPacket.java b/src/main/java/mc/protocol/EmptyPacket.java new file mode 100644 index 0000000..15c98b7 --- /dev/null +++ b/src/main/java/mc/protocol/EmptyPacket.java @@ -0,0 +1,17 @@ +package mc.protocol; + +import mc.protocol.io.NetInputStream; +import mc.protocol.io.NetOutputStream; + +public abstract class EmptyPacket implements Packet { + + @Override + public void readSelf(NetInputStream netInputStream) { + // empty + } + + @Override + public void writeSelf(NetOutputStream netOutputStream) { + // empty + } +} diff --git a/src/main/java/mc/protocol/Packet.java b/src/main/java/mc/protocol/Packet.java index f1ee9d7..2b3809a 100644 --- a/src/main/java/mc/protocol/Packet.java +++ b/src/main/java/mc/protocol/Packet.java @@ -1,5 +1,8 @@ package mc.protocol; +import mc.protocol.io.NetInputStream; +import mc.protocol.io.NetOutputStream; + public interface Packet { void readSelf(NetInputStream netInputStream); diff --git a/src/main/java/mc/protocol/State.java b/src/main/java/mc/protocol/State.java index bce5511..df5038a 100644 --- a/src/main/java/mc/protocol/State.java +++ b/src/main/java/mc/protocol/State.java @@ -2,10 +2,8 @@ package mc.protocol; import com.google.common.collect.BiMap; import com.google.common.collect.ImmutableBiMap; -import lombok.AccessLevel; import lombok.Getter; import lombok.RequiredArgsConstructor; -import lombok.Setter; import mc.protocol.handshake.client.HandshakePacket; import mc.protocol.status.client.StatusServerRequest; import mc.protocol.status.server.StatusServerResponse; @@ -13,20 +11,23 @@ import mc.protocol.status.server.StatusServerResponse; @RequiredArgsConstructor public enum State { - HANDSHAKING(-1){{ - setServerBoundPackets(ImmutableBiMap.of( - 0x00, HandshakePacket.class - )); - }}, + HANDSHAKING(-1, + // server bound + ImmutableBiMap.of( + 0x00, HandshakePacket.class + ) + ), PLAY(0), - STATUS(1){{ - setServerBoundPackets(ImmutableBiMap.of( - 0x00, StatusServerRequest.class - )); - setClientBoundPackets(ImmutableBiMap.of( - 0x00, StatusServerResponse.class - )); - }}, + STATUS(1, + // server bound + ImmutableBiMap.of( + 0x00, StatusServerRequest.class + ), + // client bound + ImmutableBiMap.of( + 0x00, StatusServerResponse.class + ) + ), LOGIN(2); public static State getById(int id) { @@ -42,11 +43,20 @@ public enum State { @Getter private final int id; - @Setter(value = AccessLevel.PROTECTED) + private BiMap> serverBoundPackets; + private BiMap> clientBoundPackets; - @Setter(value = AccessLevel.PROTECTED) - private BiMap> serverBoundPackets; + State(int id, BiMap> serverBoundPackets) { + this.id = id; + this.serverBoundPackets = serverBoundPackets; + } + + State(int id, BiMap> serverBoundPackets, BiMap> clientBoundPackets) { + this.id = id; + this.serverBoundPackets = serverBoundPackets; + this.clientBoundPackets = clientBoundPackets; + } public Class getPacketById(PacketDirection direction, int id) { if (direction == PacketDirection.CLIENT_BOUND) { diff --git a/src/main/java/mc/protocol/handshake/client/HandshakePacket.java b/src/main/java/mc/protocol/handshake/client/HandshakePacket.java index 2d2f148..6f72ed9 100644 --- a/src/main/java/mc/protocol/handshake/client/HandshakePacket.java +++ b/src/main/java/mc/protocol/handshake/client/HandshakePacket.java @@ -1,11 +1,31 @@ package mc.protocol.handshake.client; import lombok.Data; -import mc.protocol.NetInputStream; -import mc.protocol.NetOutputStream; import mc.protocol.Packet; import mc.protocol.State; +import mc.protocol.io.NetInputStream; +import mc.protocol.io.NetOutputStream; +/** + * Handshake packet. + * + *

Данный пакет заставляет сервер переключить текущий {@link State}

+ * + *

Структура пакета + * 

+ * | FIELD            | TYPE           | NOTES                                        |
+ * |------------------|----------------|----------------------------------------------|
+ * | Protocol version | VarInt         | Версия протокола [1]                         |
+ * | Server address   | Stirng         | Hostname или IP                              |
+ * | Server port      | Unsigned Short | Порт сервера                                 |
+ * | Next stage       | VarInt         | ID State на который необходимо переключиться |
+ *
+ * [1] - Protocol version numbers
+ *

+ * + * @see Handshake + * @see State + */ @Data public class HandshakePacket implements Packet { diff --git a/src/main/java/mc/protocol/DecoderException.java b/src/main/java/mc/protocol/io/DecoderException.java similarity index 85% rename from src/main/java/mc/protocol/DecoderException.java rename to src/main/java/mc/protocol/io/DecoderException.java index ac45ea2..a30ee19 100644 --- a/src/main/java/mc/protocol/DecoderException.java +++ b/src/main/java/mc/protocol/io/DecoderException.java @@ -1,4 +1,4 @@ -package mc.protocol; +package mc.protocol.io; public class DecoderException extends RuntimeException { diff --git a/src/main/java/mc/protocol/NetInputStream.java b/src/main/java/mc/protocol/io/NetInputStream.java similarity index 96% rename from src/main/java/mc/protocol/NetInputStream.java rename to src/main/java/mc/protocol/io/NetInputStream.java index 968dfb8..fa2169e 100644 --- a/src/main/java/mc/protocol/NetInputStream.java +++ b/src/main/java/mc/protocol/io/NetInputStream.java @@ -1,4 +1,4 @@ -package mc.protocol; +package mc.protocol.io; import java.io.IOException; import java.io.InputStream; @@ -39,7 +39,7 @@ public abstract class NetInputStream extends InputStream { if (length == 0) { return ""; } else if (length > maxLength) { - throw new DecoderException("String length exceeds maximum length: " + length + " > " + maxLength); + throw new DecoderException("String length exceeds maximum length: " + length + " > " + maxLength); } else if (length < 0) { throw new DecoderException("String length less zero!"); } @@ -101,6 +101,8 @@ public abstract class NetInputStream extends InputStream { } public abstract byte readByte(); + public abstract int readBytes(byte[] buffer, int offset, int lengtn); + public abstract int readShort(); } diff --git a/src/main/java/mc/protocol/NetOutputStream.java b/src/main/java/mc/protocol/io/NetOutputStream.java similarity index 98% rename from src/main/java/mc/protocol/NetOutputStream.java rename to src/main/java/mc/protocol/io/NetOutputStream.java index aa0ca68..0435ad0 100644 --- a/src/main/java/mc/protocol/NetOutputStream.java +++ b/src/main/java/mc/protocol/io/NetOutputStream.java @@ -1,4 +1,4 @@ -package mc.protocol; +package mc.protocol.io; import java.io.IOException; import java.io.OutputStream; @@ -84,6 +84,8 @@ public abstract class NetOutputStream extends OutputStream { } public abstract void writeByte(int value); + public abstract void writeBytes(byte[] buffer, int offset, int lengtn); + public abstract void writeShort(int value); } diff --git a/src/main/java/mc/protocol/coder/ByteArrayNetOutputStream.java b/src/main/java/mc/protocol/io/coder/ByteArrayNetOutputStream.java similarity index 90% rename from src/main/java/mc/protocol/coder/ByteArrayNetOutputStream.java rename to src/main/java/mc/protocol/io/coder/ByteArrayNetOutputStream.java index 9329ffa..f42ee07 100644 --- a/src/main/java/mc/protocol/coder/ByteArrayNetOutputStream.java +++ b/src/main/java/mc/protocol/io/coder/ByteArrayNetOutputStream.java @@ -1,6 +1,6 @@ -package mc.protocol.coder; +package mc.protocol.io.coder; -import mc.protocol.NetOutputStream; +import mc.protocol.io.NetOutputStream; import java.io.ByteArrayOutputStream; diff --git a/src/main/java/mc/protocol/coder/ProtocolDecoder.java b/src/main/java/mc/protocol/io/coder/ProtocolDecoder.java similarity index 68% rename from src/main/java/mc/protocol/coder/ProtocolDecoder.java rename to src/main/java/mc/protocol/io/coder/ProtocolDecoder.java index 9715c7b..4acad4c 100644 --- a/src/main/java/mc/protocol/coder/ProtocolDecoder.java +++ b/src/main/java/mc/protocol/io/coder/ProtocolDecoder.java @@ -1,22 +1,10 @@ -package mc.protocol.coder; - -/* -Packet format: - -| FIELD | TYPE | NOTES | -+------------+--------+-----------------------------------+ -| SIZE | VarInt | = sizeOf(id) + sizeOf(byte_array) | -| PACKET ID | VarInt | | -| BYTE ARRAY | bytes | | - -https://wiki.vg/index.php?title=Protocol&oldid=7368#Without_compression -*/ +package mc.protocol.io.coder; import lombok.RequiredArgsConstructor; -import mc.protocol.NetInputStream; import mc.protocol.Packet; import mc.protocol.PacketDirection; import mc.protocol.State; +import mc.protocol.io.NetInputStream; import java.util.Objects; diff --git a/src/main/java/mc/protocol/coder/ProtocolEncoder.java b/src/main/java/mc/protocol/io/coder/ProtocolEncoder.java similarity index 58% rename from src/main/java/mc/protocol/coder/ProtocolEncoder.java rename to src/main/java/mc/protocol/io/coder/ProtocolEncoder.java index a30170f..973cf8d 100644 --- a/src/main/java/mc/protocol/coder/ProtocolEncoder.java +++ b/src/main/java/mc/protocol/io/coder/ProtocolEncoder.java @@ -1,22 +1,13 @@ -package mc.protocol.coder; +package mc.protocol.io.coder; import lombok.RequiredArgsConstructor; -import mc.protocol.*; +import mc.protocol.Packet; +import mc.protocol.PacketDirection; +import mc.protocol.State; +import mc.protocol.io.NetOutputStream; import java.util.Objects; -/* -Packet format: - -| FIELD | TYPE | NOTES | -+------------+--------+-----------------------------------+ -| SIZE | VarInt | = sizeOf(id) + sizeOf(byte_array) | -| PACKET ID | VarInt | | -| BYTE ARRAY | bytes | | - -https://wiki.vg/index.php?title=Protocol&oldid=7368#Without_compression -*/ - @RequiredArgsConstructor public class ProtocolEncoder { diff --git a/src/main/java/mc/protocol/io/coder/package-info.java b/src/main/java/mc/protocol/io/coder/package-info.java new file mode 100644 index 0000000..aa5d0b8 --- /dev/null +++ b/src/main/java/mc/protocol/io/coder/package-info.java @@ -0,0 +1,13 @@ +/* +Формат пакета без компрессии + +| FIELD | TYPE | NOTES | +|-------------|--------|-----------------------------------| +| SIZE | VarInt | = sizeOf(id) + sizeOf(byte_array) | +| PACKET ID | VarInt | | +| PACKET DATA | bytes | | + +https://wiki.vg/index.php?title=Protocol&oldid=7368#Without_compression +*/ + +package mc.protocol.io.coder; \ No newline at end of file diff --git a/src/main/java/mc/protocol/io/package-info.java b/src/main/java/mc/protocol/io/package-info.java new file mode 100644 index 0000000..80569dc --- /dev/null +++ b/src/main/java/mc/protocol/io/package-info.java @@ -0,0 +1,29 @@ +/* +Data types + +| Type | Size (bytes) | Кодирование | Коментарий | +|----------------|-----------------------|-----------------------------------------------------|--------------------------------------------------------------------------| +| Boolean | 1 | True или False | True = 0x01; False = 0x00 | +| Byte | 1 | Число от -128 до 127 | 8-bit число со знаком | +| Unsigned Byte | 1 | Число от 0 до 255 | 8-bit без знаковое число | +| Short | 2 | Число от -32768 до 32767 | 16-bit число со знаком | +| Unsigned Short | 2 | Число от -32768 до 32767 | 16-bit без знаковое число | +| Int | 4 | Число от -2147483648 и 2147483647 | 32-bit число со знаком | +| Long | 8 | Число от -9223372036854775808 и 9223372036854775807 | 64-bit число со знаком | +| Float | 4 | 32-bit число одинарной точности (IEEE 754-2008) | [1] | +| Double | 8 | 64-bit число одинарной точности (IEEE 754-2008) | [2] | +| String (n) | >= 1 ; <= (n * 4) + 3 | Последовательность Unicode scalar values | В начале пишется длина строки в VarInt, после чего записываются символы. | +| | | | Каждый символ может состоять максимум из 4 байт. [3] | +| | | | Максимальная длина строки - 32767 (3 - это как раз размер VarInt для | +| | | | этого числа). | +| VarInt | >= 1 ; <= 5 | Число от -2147483648 и 2147483647 | 32-bit число с плавающей размерностью от 1 до 5 байт | +| VarLong | >= 1 ; <= 10 | Число от -9223372036854775808 и 9223372036854775807 | 64-bit число с плавающей размерностью от 1 до 10 байт | + +[1] - https://en.wikipedia.org/wiki/Single-precision_floating-point_format +[2] - https://en.wikipedia.org/wiki/Double-precision_floating-point_format +[3] - http://unicode.org/glossary/#unicode_scalar_value + +https://wiki.vg/index.php?title=Protocol&oldid=7368#Data_types + */ + +package mc.protocol.io; \ No newline at end of file diff --git a/src/main/java/mc/protocol/status/client/StatusServerRequest.java b/src/main/java/mc/protocol/status/client/StatusServerRequest.java index 4bf640a..59ae612 100644 --- a/src/main/java/mc/protocol/status/client/StatusServerRequest.java +++ b/src/main/java/mc/protocol/status/client/StatusServerRequest.java @@ -1,18 +1,12 @@ package mc.protocol.status.client; -import mc.protocol.NetInputStream; -import mc.protocol.NetOutputStream; -import mc.protocol.Packet; +import mc.protocol.EmptyPacket; -public class StatusServerRequest implements Packet { +/** + * Status server packet, request. + * + *

Клиент запрашивает получение информации о сервере

+ */ +public class StatusServerRequest extends EmptyPacket { - @Override - public void readSelf(NetInputStream netInputStream) { - // empty - } - - @Override - public void writeSelf(NetOutputStream netOutputStream) { - // empty - } } diff --git a/src/main/java/mc/protocol/status/server/StatusServerResponse.java b/src/main/java/mc/protocol/status/server/StatusServerResponse.java index ea78013..f540f12 100644 --- a/src/main/java/mc/protocol/status/server/StatusServerResponse.java +++ b/src/main/java/mc/protocol/status/server/StatusServerResponse.java @@ -1,10 +1,24 @@ package mc.protocol.status.server; import lombok.Data; -import mc.protocol.NetInputStream; -import mc.protocol.NetOutputStream; import mc.protocol.Packet; +import mc.protocol.io.NetInputStream; +import mc.protocol.io.NetOutputStream; +/** + * Status server packet, response. + * + *

Информация о сервере

+ * + *

Структура пакета + * 

+ * | FIELD         | TYPE   | NOTES                                   |
+ * |---------------|--------|-----------------------------------------|
+ * | JSON Response | String | Информация о сервере в JSON формате [1] |
+ *
+ * [1] - Server List Ping: Response
+ *

+ */ @Data public class StatusServerResponse implements Packet {