[docs/network-protocol.md] Added.

Unarelith · Jun 19, 2020 · cc85f5f · cc85f5f
1 parent 7e9d26b
commit cc85f5f
Show file tree

Hide file tree

Showing 14 changed files with 345 additions and 73 deletions.
diff --git a/README.md b/README.md
@@ -33,7 +33,7 @@ The long-term goal of this project is to provide a viable alternative to Minecra
     - [Mod API](https://openminer.readthedocs.io/en/latest/lua-api-mod/)
     - [GUI API](https://openminer.readthedocs.io/en/latest/lua-api-gui/)
     - [C++ classes in Lua](https://openminer.readthedocs.io/en/latest/lua-api-cpp/)
-- [Network Protocol](https://github.com/Unarelith/OpenMiner/wiki/Network-Protocol)
+- [Network Protocol](https://openminer.readthedocs.io/en/latest/network-protocol/)
 
 ## Keys
 

diff --git a/docs/index.md b/docs/index.md
@@ -20,3 +20,7 @@
     - [Progress bar](lua-api-gui-progress-bar.md)
     - [Scroll bar](lua-api-gui-scroll-bar.md)
 
+# Misc
+
+- [Network Protocol](network-protocol.md)
+
diff --git a/docs/network-protocol.md b/docs/network-protocol.md
@@ -0,0 +1,282 @@
+# Network Protocol
+
+**Note:** All packets are sent using TCP only.
+
+## Integer types
+
+Integer types are represented with `s8`/`s16`/`s32`/`s64` and `u8`/`u16`/`u32`/`u64`.
+
+The `s`/`u` means `signed`/`unsigned` and the number is the size of the type in bits.
+
+## Login
+
+### Clientbound
+
+#### ClientOk
+
+Packet sent from a server to accept a connection.
+
+| Field name    | Field type | Notes                                                |
+| ------------- | ---------- | ---------------------------------------------------- |
+| Client ID     | u16        | ID assigned by the server for this client            |
+| Singleplayer? | bool       | Whether or not the server runs a singleplayer game   |
+
+#### ClientRefused
+
+Packet sent from a server to refuse a connection.
+
+_This packet has no field._
+
+### Serverbound
+
+#### ClientConnect
+
+Packet sent from a client attempting to connect.
+
+_This packet has no field._
+
+#### ClientDisconnect
+
+Packet sent from a client attempting to disconnect.
+
+_This packet has no field._
+
+## Game
+
+### Clientbound
+
+#### ServerClosed
+
+| Field name    | Field type  | Notes                                                |
+| ------------- | ----------- | ---------------------------------------------------- |
+| Message       | std::string | Why the server has been closed                       |
+
+#### ChunkData
+
+| Field name    | Field type  | Notes                                                |
+| ------------- | ----------- | ---------------------------------------------------- |
+| Chunk X       | s32         | Chunk X coordinate                                   |
+| Chunk Y       | s32         | Chunk Y coordinate                                   |
+| Chunk Z       | s32         | Chunk Z coordinate                                   |
+| Array         |             |                                                      |
+| - Block data  | u32         | Block ID and data                                    |
+| - Light value | u8          | Sunlight and torchlight values                       |
+
+#### PlayerInvUpdate (clientbound)
+
+| Field name    | Field type  | Notes                                                |
+| ------------- | ----------- | ---------------------------------------------------- |
+| ID            | u16         | Player ID                                            |
+| Inventory     | Inventory   | Player inventory                                     |
+
+#### PlayerPosUpdate (clientbound)
+
+| Field name     | Field type  | Notes                                                |
+| -------------- | ----------- | ---------------------------------------------------- |
+| ID             | u16         | Player ID                                            |
+| Player X       | double      | Player X coordinate                                  |
+| Player Y       | double      | Player Y coordinate                                  |
+| Player Z       | double      | Player Z coordinate                                  |
+| Teleportation? | bool        | Whether or not this update is a teleportation        |
+
+#### PlayerSpawn
+
+| Field name     | Field type  | Notes                                                |
+| -------------- | ----------- | ---------------------------------------------------- |
+| ID             | u16         | Player ID                                            |
+| Player X       | double      | Player X coordinate                                  |
+| Player Y       | double      | Player Y coordinate                                  |
+| Player Z       | double      | Player Z coordinate                                  |
+
+#### PlayerChangeDimension
+
+| Field name    | Field type  | Notes                                                |
+| ------------- | ----------- | ---------------------------------------------------- |
+| ID            | u16         | Player ID                                            |
+| Spawn X       | s32         | Spawn X coordinate in the new dimension              |
+| Spawn Y       | s32         | Spawn Y coordinate in the new dimension              |
+| Spawn Z       | s32         | Spawn Z coordinate in the new dimension              |
+| Dimension     | u16         | New dimension ID                                     |
+
+#### BlockUpdate
+
+| Field name    | Field type  | Notes                                                |
+| ------------- | ----------- | ---------------------------------------------------- |
+| Block X       | s32         | Block X coordinate                                   |
+| Block Y       | s32         | Block Y coordinate                                   |
+| Block Z       | s32         | Block Z coordinate                                   |
+| Block ID      | u32         | Block ID and data                                    |
+
+#### BlockGUIData
+
+| Field name    | Field type  | Notes                                                |
+| ------------- | ----------- | ---------------------------------------------------- |
+| Width         | u16         | Width of the GUI                                     |
+| Height        | u16         | Height of the GUI                                    |
+| Centered?     | bool        | Whether or not the GUI is centered on the screen     |
+| Widget defs   | Array       | List of widget definitions (see LuaGUI::show)        |
+
+#### BlockInvUpdate (clientbound)
+
+| Field name    | Field type  | Notes                                                |
+| ------------- | ----------- | ---------------------------------------------------- |
+| Block X       | s32         | Block X coordinate                                   |
+| Block Y       | s32         | Block Y coordinate                                   |
+| Block Z       | s32         | Block Z coordinate                                   |
+| Inventory     | Inventory   | Block inventory                                      |
+
+#### BlockDataUpdate
+
+| Field name     | Field type    | Notes                                                 |
+| -------------- | ------------- | ----------------------------------------------------- |
+| Block X        | s32           | Block X coordinate                                    |
+| Block Y        | s32           | Block Y coordinate                                    |
+| Block Z        | s32           | Block Z coordinate                                    |
+| Metadata       | BlockMetadata | Block metadata                                        |
+| Use alt tiles? | bool          | Whether or not the block should use alternative tiles |
+
+#### RegistryData
+
+| Field name     | Field type    | Notes                                                 |
+| -------------- | ------------- | ----------------------------------------------------- |
+| Registry       | Registry      | Registry                                              |
+
+#### ChatMessage (clientbound)
+
+| Field name    | Field type  | Notes                                                |
+| ------------- | ----------- | ---------------------------------------------------- |
+| ID            | u16         | Player ID (`0` means it's a server message)          |
+| Message       | std::string | Message sent by the client                           |
+
+#### EntitySpawn
+
+| Field name    | Field type   | Notes                                                |
+| ------------- | ------------ | ---------------------------------------------------- |
+| ID            | entt::entity | Entity ID                                            |
+
+#### EntityDespawn
+
+| Field name    | Field type   | Notes                                                |
+| ------------- | ------------ | ---------------------------------------------------- |
+| ID            | entt::entity | Entity ID                                            |
+
+#### EntityPosition
+
+| Field name    | Field type   | Notes                                                |
+| ------------- | ------------ | ---------------------------------------------------- |
+| ID            | entt::entity | Entity ID                                            |
+| Entity X      | double       | Entity X coordinate                                  |
+| Entity Y      | double       | Entity Y coordinate                                  |
+| Entity Z      | double       | Entity Z coordinate                                  |
+
+#### EntityRotation
+
+| Field name      | Field type   | Notes                                                |
+| --------------- | ------------ | ---------------------------------------------------- |
+| ID              | entt::entity | Entity ID                                            |
+| Rotation        | glm::quat4   | Entity rotation quaternion                           |
+
+#### EntityAnimation
+
+| Field name    | Field type         | Notes                                                |
+| ------------- | ------------------ | ---------------------------------------------------- |
+| ID            | entt::entity       | Entity ID                                            |
+| Animation     | AnimationComponent | Entity animation data                                |
+
+#### EntityDrawableDef
+
+| Field name    | Field type         | Notes                                                |
+| ------------- | ------------------ | ---------------------------------------------------- |
+| ID            | entt::entity       | Entity ID                                            |
+| Drawable def  | DrawableDef        | Entity drawable component definition                 |
+
+### Serverbound
+
+#### ChunkRequest
+
+| Field name    | Field type  | Notes                                                |
+| ------------- | ----------- | ---------------------------------------------------- |
+| Chunk X       | s32         | Chunk X coordinate                                   |
+| Chunk Y       | s32         | Chunk Y coordinate                                   |
+| Chunk Z       | s32         | Chunk Z coordinate                                   |
+
+#### PlayerPlaceBlock
+
+| Field name    | Field type  | Notes                                                |
+| ------------- | ----------- | ---------------------------------------------------- |
+| Block X       | s32         | Block X coordinate                                   |
+| Block Y       | s32         | Block Y coordinate                                   |
+| Block Z       | s32         | Block Z coordinate                                   |
+| Block ID      | u32         | Block ID and data                                    |
+
+#### PlayerDigBlock
+
+| Field name    | Field type  | Notes                                                |
+| ------------- | ----------- | ---------------------------------------------------- |
+| Block X       | s32         | Block X coordinate                                   |
+| Block Y       | s32         | Block Y coordinate                                   |
+| Block Z       | s32         | Block Z coordinate                                   |
+
+#### PlayerInvUpdate (serverbound)
+
+| Field name    | Field type  | Notes                                                |
+| ------------- | ----------- | ---------------------------------------------------- |
+| Inventory     | Inventory   | Player inventory                                     |
+
+#### PlayerPosUpdate (serverbound)
+
+| Field name    | Field type  | Notes                                                |
+| ------------- | ----------- | ---------------------------------------------------- |
+| Player X      | double      | Player X coordinate                                  |
+| Player Y      | double      | Player Y coordinate                                  |
+| Player Z      | double      | Player Z coordinate                                  |
+
+#### PlayerRotUpdate
+
+| Field name    | Field type  | Notes                                                |
+| ------------- | ----------- | ---------------------------------------------------- |
+| Camera Yaw    | float       | Horizontal camera view angle                         |
+| Camera Pitch  | float       | Vertical camera view angle                           |
+
+#### PlayerHeldItemChanged
+
+| Field name    | Field type  | Notes                                                |
+| ------------- | ----------- | ---------------------------------------------------- |
+| Hotbar slot   | u8          | ID of the current hotbar slot                        |
+| Item ID       | u16         | Current item ID (to check match with server)         |
+
+#### BlockActivated
+
+| Field name    | Field type  | Notes                                                |
+| ------------- | ----------- | ---------------------------------------------------- |
+| Block X       | s32         | Block X coordinate                                   |
+| Block Y       | s32         | Block Y coordinate                                   |
+| Block Z       | s32         | Block Z coordinate                                   |
+| Screen width  | u16         | Client screen width                                  |
+| Screen height | u16         | Client screen height                                 |
+| GUI scale     | u8          | Client GUI scale                                     |
+
+#### BlockInvUpdate (serverbound)
+
+| Field name    | Field type  | Notes                                                |
+| ------------- | ----------- | ---------------------------------------------------- |
+| Block X       | s32         | Block X coordinate                                   |
+| Block Y       | s32         | Block Y coordinate                                   |
+| Block Z       | s32         | Block Z coordinate                                   |
+| Inventory     | Inventory   | Block inventory                                      |
+
+#### ChatMessage (serverbound)
+
+| Field name    | Field type  | Notes                                                |
+| ------------- | ----------- | ---------------------------------------------------- |
+| Message       | std::string | Message sent by the client                           |
+
+#### KeyPressed
+
+| Field name    | Field type  | Notes                                                |
+| ------------- | ----------- | ---------------------------------------------------- |
+| Key ID        | u16         | Key ID in the registry                               |
+| Screen width  | u16         | Client screen width                                  |
+| Screen height | u16         | Client screen height                                 |
+| GUI scale     | u8          | Client GUI scale                                     |
+
diff --git a/docs/script.js b/docs/script.js
@@ -0,0 +1,5 @@
+document.addEventListener("DOMContentLoaded", function() {
+	document.querySelectorAll("table").forEach(function(table) {
+		table.classList.add("docutils");
+	});
+});
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -24,10 +24,15 @@ nav:
         - 'Inventory widget': 'lua-api-gui-inventory.md'
         - 'Progress bar': 'lua-api-gui-progress-bar.md'
         - 'Scroll bar': 'lua-api-gui-scroll-bar.md'
+    - 'Misc':
+      - 'Network Protocol': 'network-protocol.md'
 
 theme:
     name: readthedocs
     highlightjs: true
     hljs_languages:
         - lua
 
+extra_javascript:
+  - script.js
+
diff --git a/requirements.txt b/requirements.txt
@@ -1 +1 @@
-mkdocs==1.1
+mkdocs==1.1.2
diff --git a/source/client/network/Client.cpp b/source/client/network/Client.cpp
@@ -40,7 +40,7 @@ void Client::connect(sf::IpAddress serverAddress, u16 serverPort) {
 		throw ClientConnectException("Network error: Unable to connect to server " + serverAddress.toString() + ":" + std::to_string(serverPort));
 
 	Network::Packet packet;
-	packet << Network::Command::ClientConnect << sf::IpAddress::getLocalAddress().toString();
+	packet << Network::Command::ClientConnect;
 	m_tcpSocket->send(packet);
 
 	Network::Packet answer;

diff --git a/source/client/network/ClientCommandHandler.cpp b/source/client/network/ClientCommandHandler.cpp
@@ -46,29 +46,22 @@
 void ClientCommandHandler::sendPlayerInvUpdate() {
 	Network::Packet invPacket;
 	invPacket << Network::Command::PlayerInvUpdate;
-	// FIXME: Sending client id shouldn't be necessary when sending this packet from client
-	invPacket << m_client.id();
 	invPacket << m_player.inventory();
 	m_client.send(invPacket);
 }
 
 void ClientCommandHandler::sendPlayerPosUpdate() {
 	Network::Packet packet;
 	packet << Network::Command::PlayerPosUpdate;
-	// FIXME: Sending client id shouldn't be necessary when sending this packet from client
-	packet << m_client.id();
 	packet << m_player.x();
 	packet << m_player.y();
 	packet << m_player.z();
-	packet << false;
 	m_client.send(packet);
 }
 
 void ClientCommandHandler::sendPlayerRotUpdate() {
 	Network::Packet packet;
 	packet << Network::Command::PlayerRotUpdate;
-	// FIXME: Sending client id shouldn't be necessary when sending this packet from client
-	packet << m_client.id();
 	packet << m_player.cameraYaw();
 	packet << m_player.cameraPitch();
 	m_client.send(packet);
@@ -124,16 +117,14 @@ void ClientCommandHandler::sendChunkRequest(s32 chunkX, s32 chunkY, s32 chunkZ)
 void ClientCommandHandler::sendChatMessage(const std::string &message) {
 	Network::Packet packet;
 	packet << Network::Command::ChatMessage;
-	// FIXME: Sending client id shouldn't be necessary
-	packet << m_client.id();
 	packet << message;
 	m_client.send(packet);
 }
 
 void ClientCommandHandler::sendKeyPressed(u16 keyID) {
 	Network::Packet packet;
 	packet << Network::Command::KeyPressed << keyID
-		<< Config::screenWidth << Config::screenHeight << Config::guiScale;
+		<< u16(Config::screenWidth) << u16(Config::screenHeight) << u8(Config::guiScale);
 	m_client.send(packet);
 }