feat: More examples for Mirror Cloud Service (#2029)

* fixing pong spawn points

* renaming files and asmdef

* More Cloud examples

* Moving pong example to cloud folder
* Moving shared code to GUI folder
* Adding readme for examples
* Adding tank example

Assets/Mirror/Cloud/Mirror.CloudServices.asmdef → Assets/Mirror/Cloud/Mirror.Cloud.asmdef

@@ -1,5 +1,5 @@
 {
-    "name": "Mirror.CloudServices",
+    "name": "Mirror.Cloud",
     "references": [
         "Mirror"
     ],

Assets/Mirror/Examples/Cloud/GUI/README.md

@@ -0,0 +1,8 @@
+# Cloud GUI
+
+This folder contains an example of a List server canvas and scripts that can help set up a GUI.
+
+
+## Other Examples
+
+See `PongWithListServer` or `TanksWithListServer` for playable examples

Assets/Mirror/Examples/PongWithListServer/Scripts/ApiUpdater.cs → Assets/Mirror/Examples/Cloud/GUI/Scripts/ApiUpdater.cs

@@ -4,14 +4,17 @@
 
 namespace Mirror.CloudServices.Example
 {
+    /// <summary>
+    /// This component should be put on the NetworkManager object
+    /// </summary>
     public class ApiUpdater : MonoBehaviour
     {
-        NetworkManagerListServerPong manager;
+        NetworkManagerListServer manager;
         ApiConnector connector;
 
         void Start()
         {
-            manager = NetworkManager.singleton as NetworkManagerListServerPong;
+            manager = NetworkManager.singleton as NetworkManagerListServer;
             connector = manager.GetComponent<ApiConnector>();
 
             manager.onPlayerListChanged += onPlayerListChanged;

Assets/Mirror/Examples/PongWithListServer/Scripts/InstantiateNetworkManager.cs → Assets/Mirror/Examples/Cloud/GUI/Scripts/InstantiateNetworkManager.cs

@@ -2,6 +2,9 @@
 
 namespace Mirror.CloudServices.Examples
 {
+    /// <summary>
+    /// Instantiate a new NetworkManager if one does not already exist
+    /// </summary>
     public class InstantiateNetworkManager : MonoBehaviour
     {
         public GameObject prefab;

Assets/Mirror/Examples/PongWithListServer/Scripts/Mirror.Examples.CloudService.asmdef → Assets/Mirror/Examples/Cloud/GUI/Scripts/Mirror.Examples.Cloud.GUI.asmdef

@@ -1,9 +1,8 @@
 {
-    "name": "Mirror.Examples.CloudService",
+    "name": "Mirror.Examples.Cloud.GUI",
     "references": [
         "Mirror",
-        "Mirror.Components",
-        "Mirror.CloudServices"
+        "Mirror.Cloud"
     ],
     "optionalUnityReferences": [],
     "includePlatforms": [],

Assets/Mirror/Examples/PongWithListServer/Scripts/NetworkManagerListServerPong.cs → Assets/Mirror/Examples/Cloud/GUI/Scripts/NetworkManagerListServer.cs

@@ -2,7 +2,10 @@
 
 namespace Mirror.CloudServices.Example
 {
-    public class NetworkManagerListServerPong : NetworkManager
+    /// <summary>
+    /// Network Manager with events that are used by the list server
+    /// </summary>
+    public class NetworkManagerListServer : NetworkManager
     {
         /// <summary>
         /// Called when Server Starts

Assets/Mirror/Examples/PongWithListServer/Scripts/QuitButton.cs → Assets/Mirror/Examples/Cloud/GUI/Scripts/QuitButtonHUD.cs

@@ -2,7 +2,10 @@
 
 namespace Mirror.Examples.Pong
 {
-    public class QuitButton : MonoBehaviour
+    /// <summary>
+    /// Simular to NetworkManagerHUD but just quit buttons
+    /// </summary>
+    public class QuitButtonHUD : MonoBehaviour
     {
         void OnGUI()
         {

Assets/Mirror/Examples/PongWithListServer/Scripts/ServerListManager.cs → Assets/Mirror/Examples/Cloud/GUI/Scripts/ServerListManager.cs

@@ -3,6 +3,9 @@
 
 namespace Mirror.CloudServices.Example
 {
+    /// <summary>
+    /// Uses the ApiConnector on NetworkManager to update the Server list
+    /// </summary>
     public class ServerListManager : MonoBehaviour
     {
         [Header("UI")]

Assets/Mirror/Examples/PongWithListServer/Scripts/ServerListUI.cs → Assets/Mirror/Examples/Cloud/GUI/Scripts/ServerListUI.cs

@@ -4,6 +4,9 @@
 
 namespace Mirror.CloudServices.Example
 {
+    /// <summary>
+    /// Displays the list of servers
+    /// </summary>
     public class ServerListUI : MonoBehaviour
     {
         [SerializeField] ServerListUIItem itemPrefab = null;

Assets/Mirror/Examples/PongWithListServer/Scripts/ServerListUIItem.cs → Assets/Mirror/Examples/Cloud/GUI/Scripts/ServerListUIItem.cs

@@ -5,6 +5,9 @@
 
 namespace Mirror.CloudServices.Example
 {
+    /// <summary>
+    /// Displays a server created by ServerListUI
+    /// </summary>
     public class ServerListUIItem : MonoBehaviour
     {
         [SerializeField] Text nameText = null;

Assets/Mirror/Examples/PongWithListServer/Prefabs/NetworkManager.prefab → Assets/Mirror/Examples/Cloud/PongWithListServer/Prefabs/NetworkManagerPong.prefab

@@ -14,7 +14,7 @@ GameObject:
   - component: {fileID: 1442807832621757098}
   - component: {fileID: 4798169800353248834}
   m_Layer: 0
-  m_Name: NetworkManager
+  m_Name: NetworkManagerPong
   m_TagString: Untagged
   m_Icon: {fileID: 0}
   m_NavMeshLayer: 0
@@ -51,7 +51,7 @@ MonoBehaviour:
   _onServerListUpdated:
     m_PersistentCalls:
       m_Calls: []
-    m_TypeName: Mirror.CloudServices.ServerListEvent, Mirror.CloudServices, Version=0.0.0.0,
+    m_TypeName: Mirror.CloudServices.ServerListEvent, Mirror.Cloud, Version=0.0.0.0,
       Culture=neutral, PublicKeyToken=null
 --- !u!114 &5399210850297115757
 MonoBehaviour:
@@ -80,10 +80,10 @@ MonoBehaviour:
   dontDestroyOnLoad: 1
   runInBackground: 1
   startOnHeadless: 1
-  showDebugMessages: 1
+  showDebugMessages: 0
   serverTickRate: 30
-  offlineScene: Assets/Mirror/Examples/PongWithListServer/Scenes/ListServerLobbyScene.unity
-  onlineScene: Assets/Mirror/Examples/PongWithListServer/Scenes/PongGameScene.unity
+  offlineScene: Assets/Mirror/Examples/Cloud/PongWithListServer/Scenes/ListServerLobbyScenePong.unity
+  onlineScene: Assets/Mirror/Examples/Cloud/PongWithListServer/Scenes/PongGameScene.unity
   transport: {fileID: 4798169800353248834}
   networkAddress: localhost
   maxConnections: 2

Assets/Mirror/Examples/Cloud/PongWithListServer/README.md

@@ -0,0 +1,19 @@
+# Pong with Cloud List server
+
+This is an example that uses the list server to find games of pong
+
+## Setup
+
+Add the following scenes to build settings
+```
+Mirror\Examples\Cloud\PongWithListServer\Scenes\ListServerLobbyScenePong.unity
+Mirror\Examples\Cloud\PongWithListServer\Scenes\PongGameScene.unity
+```
+> Note: you can not connect to your own public ip address, to test out ServerOnly you will need a 2nd person (or a 2nd internet connection)
+
+## Api Key
+
+Api key on the NetworkManager is a demo key that should not be used in production.
+
+Visit [Mirror Networking](https://mirror-networking.com/list-server/) to get an api key that you can use in your game.
+

Assets/Mirror/Examples/Cloud/PongWithListServer/Scripts/Mirror.Examples.Cloud.Pong.asmdef

@@ -0,0 +1,16 @@
+{
+    "name": "Mirror.Examples.Cloud.Pong",
+    "references": [
+        "Mirror",
+        "Mirror.Cloud",
+        "Mirror.Examples.Cloud.GUI"
+    ],
+    "optionalUnityReferences": [],
+    "includePlatforms": [],
+    "excludePlatforms": [],
+    "allowUnsafeCode": false,
+    "overrideReferences": false,
+    "precompiledReferences": [],
+    "autoReferenced": true,
+    "defineConstraints": []
+}

Assets/Mirror/Examples/Cloud/PongWithListServer/Scripts/NetworkManagerListServerPong.cs

@@ -0,0 +1,20 @@
+using UnityEngine;
+
+namespace Mirror.CloudServices.Example
+{
+    public sealed class NetworkManagerListServerPong : NetworkManagerListServer
+    {
+        public override void OnServerAddPlayer(NetworkConnection conn)
+        {
+            Debug.Assert(startPositions.Count == 2, "Pong Scene should have 2 start Poitions");
+            // add player at correct spawn position
+            Transform startPos = numPlayers == 0 ? startPositions[0] : startPositions[1];
+
+            GameObject player = startPos != null
+                ? Instantiate(playerPrefab, startPos.position, startPos.rotation)
+                : Instantiate(playerPrefab);
+
+            NetworkServer.AddPlayerForConnection(conn, player);
+        }
+    }
+}