Added messages design doc

docs/design/communication.md

@@ -0,0 +1,12 @@
+# Communication
+
+The following diagram shows the protocol communication used between client and server:
+
+Notes:
+- Orange arrows show UDP messages,
+- Purple arrows show preferred UDP messages.
+- Default color arrows show TCP messages.
+
+<p align="center">
+  <img src="http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/lemunozm/asciiarena/master/docs/design/diagrams/messages.puml"/>
+</p>

docs/design/diagrams/messages.puml

@@ -0,0 +1,59 @@
+@startuml
+
+' Orange color represents an UDP message
+' Purple color represents a prefered UDP message
+' Default color represents TCP message
+
+title Client - Server communication protocol
+
+participant Client
+participant Server
+
+== Initialization ==
+Client -> Server : Version
+Client <-- Server : Version
+
+== Server information subscription ==
+Client -> Server : SubscribeServerInfo
+Client <-- Server : ServerInfo
+group Any change in the server: e.g: a player login/logout
+    Client <<- Server : DynamicServerInfo
+end
+
+== Login/Logout ==
+Client -> Server : Login
+Client <-- Server : LoginStatus
+group If logged successful:
+    loop while not received UdpConnected, max 10
+        Client -[#orange]> Server : ConnectUdp
+        Client <[#orange]-- Server : UdpConnected
+    end
+    group If received UdpConnected:
+        Client -> Server : TrustUdp
+    end
+end
+...
+Client -> Server : Logout
+
+== Game/Arena system ==
+Client <- Server : StartGame
+loop there is not a game winner
+    Client <- Server : PrepareArena
+    ...
+    Client <- Server : StartArena
+    note over Client, Server
+       Arena round
+    end note
+    Client <- Server : EndArena
+end
+
+== Arena round ==
+loop each frame until there is an arena winner
+    group any of the following player actions:
+        Client ->> Server : MovePlayer
+        Client ->> Server : CastSkill
+    end
+    Client <[#purple]- Server : Step
+end
+
+@enduml

src/message.rs

@@ -4,6 +4,8 @@ use serde::{Serialize, Deserialize};
 
 use std::time::{Duration};
 
+// See the protocol diagram in docs/design/communication.md
+
 // ===================================================
 //     High level messages
 // ===================================================
@@ -24,8 +26,8 @@ pub enum ClientMessage {
     TrustUdp,
 
     // Arena real time messages
-    Move, //direction
-    Skill, //id
+    MovePlayer, //direction
+    CastSkill, //id
 }
 
 /// Messages that Server sends to Client

src/server/server_manager.rs

@@ -112,10 +112,10 @@ impl ServerManager {
                             ClientMessage::TrustUdp => {
                                 self.process_trust_udp(endpoint);
                             },
-                            ClientMessage::Move => {
+                            ClientMessage::MovePlayer => {
                                 //TODO
                             },
-                            ClientMessage::Skill => {
+                            ClientMessage::CastSkill => {
                                 //TODO
                             },
                         }