updated README

Armour · Apr 27, 2016 · 7327aec · 7327aec
1 parent e3905b3
commit 7327aec
Show file tree

Hide file tree

Showing 25 changed files with 144 additions and 24 deletions.
diff --git a/Images/1.jpg b/Images/1.jpg
diff --git a/Images/10.jpg b/Images/10.jpg
diff --git a/Images/11.jpg b/Images/11.jpg
diff --git a/Images/12.jpg b/Images/12.jpg
diff --git a/Images/13.jpg b/Images/13.jpg
diff --git a/Images/14.jpg b/Images/14.jpg
diff --git a/Images/15.jpg b/Images/15.jpg
diff --git a/Images/16.jpg b/Images/16.jpg
diff --git a/Images/17.jpg b/Images/17.jpg
diff --git a/Images/18.jpg b/Images/18.jpg
diff --git a/Images/19.jpg b/Images/19.jpg
diff --git a/Images/2.jpg b/Images/2.jpg
diff --git a/Images/20.jpg b/Images/20.jpg
diff --git a/Images/3.jpg b/Images/3.jpg
diff --git a/Images/4.jpg b/Images/4.jpg
diff --git a/Images/5.jpg b/Images/5.jpg
diff --git a/Images/6.jpg b/Images/6.jpg
diff --git a/Images/7.jpg b/Images/7.jpg
diff --git a/Images/8.jpg b/Images/8.jpg
diff --git a/Images/9.jpg b/Images/9.jpg
diff --git a/Images/jumping.png b/Images/jumping.png
diff --git a/Images/rotation.png b/Images/rotation.png
diff --git a/Images/shooting.png b/Images/shooting.png
diff --git a/Images/skeleton_overview.png b/Images/skeleton_overview.png
diff --git a/README.md b/README.md
@@ -1,40 +1,160 @@
 # Multiplayer-FPS
-A multiplayer first person shooter game based on Unity3D 
 
-# Screenshots
+A multiplayer first person shooter game based on Unity3D, to improve players' game experience, I added different kinds of input device such like Kinect, Xbox controller, Leap motion and VR Glasses. (All in different branches) 
 
-#### Unity3D
+### Game logic and function
 
-![screen shot 2016-01-26 at 12 15 58](https://cloud.githubusercontent.com/assets/5276065/12594059/0285dbea-c429-11e5-8268-13dcda54ca51.jpg)
+* Login panel
+    * Input your **player name** and the **room name** that you want to join
+    * Click **'join or create room'** button to join the room (or create and then join it) 
+    * The network connection state shows on the bottom left corner
+    ![img](Images/2.jpg)
+
+* Game interface
+    * **Player's HP** showing on the top left corner
+    * The **message panal** showing on the bottom left corner, which is used to notify player other players status (like dead or respawn)
+    * A **gun (AK-47)** will always show on the bottom right corner above every thing you can see
+    * A red **shooting sight** always in the center of the screen
+    <img src="Images/3.jpg" style="width:500px"></img>
+
+* Player model
+    * There are three type of player model:
+        * **Policeman**: a policeman-like model with yellow skin
+        * **RobotX**: a robot-like model with dark pink skin
+        * **RobotY**: a robot-like model with dark blue skin
+        * <img src="Images/9.jpg" style="width:150px"></img> <img src="Images/11.jpg" style="width:147px"></img> <img src="Images/10.jpg" style="width:149px"></img>
+
+    * Animation:
+        * **Walk** towards four different direction
+        * **Run** towards four different direction
+        * **Jump** without affact upper part body (**achieved by unity3d body mask**)
+        * **Shooting** without affact lower part body (**achieved by unity3d body mask**)   
+        * All the original models and their animation can be get from **Mixamo**, which is a pretty good game model website runned by Adobe
+    * **Unity Blend Tree**
+        * This is used to make the player walk or run more naturally, it uses interpolation function to map different combinations of user input to the different animations. 
+        * ![img](Images/4.jpg)
+
+    * **State Machine** 
+        * Player state machine with many layers 
+        * <img src="Images/5.jpg" style="width:420px"></img>
+        * <img src="Images/6.jpg" style="width:420px"></img>
+        * <img src="Images/7.jpg" style="width:420px"></img>
+        * <img src="Images/8.jpg" style="width:420px"></img>   
 
-#### Login 
+* Player movement
+    * Walking && Running && Aiming
+        * <img src="https://cloud.githubusercontent.com/assets/5276065/12594065/02a72084-c429-11e5-84b7-39de1a51d991.jpg" style="width:420px"></img>
+        * <img src="https://cloud.githubusercontent.com/assets/5276065/12594070/02be2234-c429-11e5-874a-880a710742c1.jpg" style="width:420px"></img>
+        * <img src="https://cloud.githubusercontent.com/assets/5276065/12594601/c34c19f0-c42b-11e5-9c90-2f2e384030ef.jpg" style="width:420px"></img>
+        * <img src="https://cloud.githubusercontent.com/assets/5276065/12594069/02b960be-c429-11e5-90b1-49e0ff6be56a.jpg" style="width:420px"></img>
+    * Jumping
+        * <img src="https://cloud.githubusercontent.com/assets/5276065/12594068/02b1568a-c429-11e5-9bbe-cee8760c079b.jpg" style="width:420px"></img>
+    * Dying
+        * <img src="https://cloud.githubusercontent.com/assets/5276065/12594067/02abdd9a-c429-11e5-887f-0c830090ff49.jpg" style="width:420px"></img> 
+        * <img src="https://cloud.githubusercontent.com/assets/5276065/12594066/02aa6d34-c429-11e5-86ce-ef458bb7f7c3.jpg" style="width:420px"></img>
 
-![screen shot 2016-01-26 at 12 23 18](https://cloud.githubusercontent.com/assets/5276065/12594060/028783be-c429-11e5-93c8-ca993f3ed9aa.jpg)
+* Gun model
+    * The orignal gun model (AK-47) was from Unity Assets Store
+    * **Added shooting animation** by setting keyframes in unity3d animation panel 
+    ![img](Images/12.jpg)
 
-#### Bullet Effects
+* Networking
+    * Used **Photon Unity Networking** which is a good network model in Unity Assets Store 
 
-![screen shot 2016-01-26 at 12 23 35](https://cloud.githubusercontent.com/assets/5276065/12594061/028f422a-c429-11e5-8e16-e57a3d60eb2b.jpg)
-![screen shot 2016-01-26 at 12 23 59](https://cloud.githubusercontent.com/assets/5276065/12594062/02928926-c429-11e5-8c94-fbba8c884be6.jpg)
-![screen shot 2016-01-26 at 12 24 20](https://cloud.githubusercontent.com/assets/5276065/12594063/029b2752-c429-11e5-95ee-4d3134abc4e3.jpg)
-![screen shot 2016-01-26 at 12 24 55](https://cloud.githubusercontent.com/assets/5276065/12594064/02a0bf82-c429-11e5-870d-0ab7fe59ac8f.jpg)
+* Bullet effects
+    * Bullet will have different effects when hit different materials 
+    * Wood
+    <img src="Images/13.jpg" style="width:510px"></img>
+    * Ground
+    <img src="Images/14.jpg" style="width:510px"></img>
+    * Metal
+    <img src="Images/15.jpg" style="width:510px"></img>
+    * Concrete
+    <img src="Images/16.jpg" style="width:510px"></img>
+    * Water
+    <img src="Images/17.jpg" style="width:510px"></img>
 
-#### Walking && Running && Aiming
+* Door animation
+    * Door will automatically open when there is someone near it, and close when no one around
+    * Before open
+    <img src="Images/18.jpg" style="width:550px"></img>
+    * After open
+    <img src="Images/19.jpg" style="width:550px"></img>
 
-![screen shot 2016-01-26 at 12 26 04](https://cloud.githubusercontent.com/assets/5276065/12594065/02a72084-c429-11e5-84b7-39de1a51d991.jpg)
-![screen shot 2016-01-26 at 12 30 59](https://cloud.githubusercontent.com/assets/5276065/12594070/02be2234-c429-11e5-874a-880a710742c1.jpg)
-![screen shot 2016-01-26 at 12 52 20](https://cloud.githubusercontent.com/assets/5276065/12594601/c34c19f0-c42b-11e5-9c90-2f2e384030ef.jpg)
-![screen shot 2016-01-26 at 12 29 04](https://cloud.githubusercontent.com/assets/5276065/12594069/02b960be-c429-11e5-90b1-49e0ff6be56a.jpg)
+
+### Script files
 
-#### Jumping
+* **CameraRotation.cs**
+    * Used to rotate the scene camera in every updated frame 
+* **DoorAnimtion.cs**
+    * Used to control the door animation, detect if player enter or exit the door trigger area
+* **GunFirstPersonView.cs**
+    * Used to control the first person view of gun shooting animation
+* **GunShooting.cs**
+    * Used to control the gun shooting action on the network domain, send shooting function to evert client if necessary
+* **IKControl.cs**
+    * Used to make sure the model hold the gun on their hand no matter how they moved and rotated
+* **ImpactLifeCycle.cs**
+    * Used to destory the bullet after several seconds to save CPU and memory
+* **NameTag.cs**
+    * Used to set other players' name above their head on local game
+* **NetworkManager.cs**
+    * Used to control the whole network connection
+* **PlayerHealth.cs**
+    * Used to calculate and update each player's health                 
+* **PlayerNetworkMover.cs**
+    * Used to sychronize player's postion among different clients
+* **ShowName.cs**
+    * Used to show the player name above their head
+* **WeaponPos.cs**
+    * Used to move the gun to the place near player's hand 
 
-![screen shot 2016-01-26 at 12 28 31](https://cloud.githubusercontent.com/assets/5276065/12594068/02b1568a-c429-11e5-9bbe-cee8760c079b.jpg)
+### Input Devices
 
-#### Dying
+* Mouse and keyboard 
+    * The traditional way
+    * Cheap and easy to use
+
+* Kinect
+    * Detail see below
+    * *This part was implemented by my friend [Ruochen Jiang](https://github.com/VHUCXAONG), thanks to him!*
 
-![screen shot 2016-01-26 at 12 27 20](https://cloud.githubusercontent.com/assets/5276065/12594067/02abdd9a-c429-11e5-887f-0c830090ff49.jpg)
-![screen shot 2016-01-26 at 12 26 54](https://cloud.githubusercontent.com/assets/5276065/12594066/02aa6d34-c429-11e5-86ce-ef458bb7f7c3.jpg)
+* Xbox Controller
+    * Like the combination of mouse and keyboard
+    * Most Xbox games use this way to play
+
+* Leap Motion
+    * User hand gestrue to control game
+    * More advance, maybe future it will be more popular
+
+* VR glasses 
+    * More vivid, like reality   
+    * Recently very popular but devices are most likely expensive 
+    * Player can't move now due to my device limitation
+
+### Kinect Detail
+
+* Tools and Platform:
+    - Kinect for Xbox One
+    - Kinect for Windows SDK
+    - Unity
+    - Visual Studio
+
+* Recogonition Method:
+    * Use Kinect for Windows SKD (BodySourceManager) to get the positions of skeleton of the player, then use those positions to judge the actions of moving, jumping, shooting and view rotation as game’s input.
+
+    * **Shooting**：
+Use the action of lifting right arm to shoot in the game, so I calculated the distance between the nodes of skeleton of right hand and right shoulder. If it reaches a critical value, then mark the action as shooting.
+
+   * **Moving**:
+Use the action of stepping front, back, left and right to move in the game, so I recognized moving actions by the offset of right foot’s skeleton node on x-z plane. If the offset reaches a critical value, it will be recognized as moving.
+
+    * **Jumping**:
+Use the action of jumping to jump in the game. I used offset of right foot’s skeleton node on z-axis to recognize jumping. If the offset reaches a critical value, I recognized the action as jumping.
+
+    * **View Rotation**:
+Use right hand as a virtual mouse to control the camera rotation. I record the initial position of left hand as the initial position of mouse. Then recognize the camera rotation by left hand’s offset.
+
+    * <img src="Images/skeleton_overview.png" style="width:110px"> </img><img src="Images/shooting.png" style="width:134px"></img> <img src="Images/jumping.png" style="width:122px"> </img><img src="Images/rotation.png" style="width:156px"></img>
 
-#### Door animation
 
-![screen shot 2016-01-26 at 12 50 54](https://cloud.githubusercontent.com/assets/5276065/12594599/c344dd48-c42b-11e5-8449-5bec596a4bb8.jpg)
-![screen shot 2016-01-26 at 12 51 39](https://cloud.githubusercontent.com/assets/5276065/12594600/c3477602-c42b-11e5-9cb7-f255fd3841cf.jpg)