README.md

Engaging Players with Azure

---

Overview

Enable your game with the Azure cloud services. Microsoft Azure offers hundreds of cross-platform services for any device: Android, iOS and Windows. In this module, you will use a sample game, create a new Azure App Service in Azure portal and add it to your game to save game score in the cloud. Naturally, your app can take advantage of multiple services available in Azure: you can choose what services to use in your game to expand it to its full potential. In this module, we use Azure App Service and SQL Azure backend to save your score.

Objectives

In this module, you will see how to:

• Connect your Unity game to Microsoft Azure
• Use Microsoft Azure App Service in your game
• Store game score using Azure

Prerequisites

The following is required to complete this module:

• Windows 10.
• Visual Studio Community 2015 or greater.
• Unity 5.3.3

Note: You can take advantage of the Visual Studio Dev Essentials subscription in order to get everything you need to build and deploy your app on any platform.

Intended Audience

This module is intended for developer’s familiar with C# and Visual Studio. It does not require prior experience with Unity gaming platform.

---

Exercises

This module includes the following exercises:

1. Create Azure App Service for your game
2. Save game score in Azure App Service

Estimated time to complete this module: 60 minutes

Exercise 1: Create Azure App Service for your game

Most games need to save score and settings. Wouldn’t it be great if we can save user game score on one device, say a PC, and then when the user comes back to another device: his/her tablet or phone, the score is there? In this module, you’ll be able to do it and learn how to use Microsoft Azure portal.

For the purpose of this module, we use a popular Unity Tanks! tutorial game available from Unity3D Web site. Tanks! is a very nice multiplayer game example. In this code module, you’ll learn how to modify this game to add Azure functionality to the game.

Tanks Game

Task 1 - Create Azure Mobile App

Microsoft Azure provides hundreds of features game developers can take advantage of. One of them is Mobile Apps.

1. If you already have an Azure account go to Azure Portal or you can open a free one-month trial Free Azure One-Month Trial. Inside of the Azure portal, simply select New | Web + Mobile | Mobile App, which is the starting point to configure your Azure Mobile App backend.

   

   Create Azure Mobile App

2. You’ll need to provide App Service name (this is the URL where your backend will live), configure your subscription, and set your resource group and plan. You can choose location where your app to be most active.

   

   Configure Azure Mobile App

3. Once deployed, the Azure portal will bring you directly to the configuration screen with the settings tab open. All of the settings we’ll adjust can be found under the Mobile section.

   

   Configure Azure Settings

4. Our backend data will live in a database. Under the Data Connections section, select Add, and then configure a new SQL database.

   

   Configure Azure Database Settings

5. When the data connection is created, it will appear in the Mobile Apps data connections blade, which means it’s time to set up the data that will go in the new database. Click OK on all open blades and Azure will begin to create the database for us on the fly. When the data connection is created, it will appear in the Mobile Apps data connections blade, which means it’s time to set up the data that will go in the new database.

   

   Azure Database Connection

6. Under Mobile settings is a new section called Easy Tables, which enable us to easily set up and control the data coming to and from the iOS and Android apps. Select the Easy Tables section, and we’ll be prompted with a big blue warning asking us to configure Easy Tables/Easy APIs.

   

   Azure Easy Tables

7. Since we already setup the database, the only thing left to do is Initialize the app.

   

   Azure Initialize the App

8. When the app will be fully initialized you can add our first table of the database named GameScore. If you are adding Azure Mobile Apps to an existing application, this table name should match the class name of the data you with to store. The beautiful part of Easy Tables is that it will automatically update and add the columns in the table dynamically based on the data we pass in. For this example, I’ll simply allow full anonymous access to the table, however it is possible to add authentication with Facebook, Twitter, Google, Microsoft, and other OAuth login providers.

   

   Azure Add GameScore table

Exercise 2: Save game settings and score in Azure

Task 1 - Open Game Project in Visual Studio

1. Launch Unity from the Start Menu, click Open. In the Select Existing Unity Project dialog navigate to Ex2/Begin/UnityTanksWithAzure and click Select Folder. Unity will import your project.

   

   Open Unity Project

2. Next, you need to create a Windows UWP Universal Project from Unity. In Unity top menu select File | Build Settings, select Windows Store, make sure that SDK combo box has Universal 10 selected, and checkboxes Unity C# Projects and Development Build are checked. Then click Build. In the following dialog box Unity prompts you to select a target folder where it'll place Visual Studio Windows 10 project. Select Ex2\Begin\UnityTanksWithAzure\Ex2Begin folder.

   

   Generate UWP Project

3. Launch Visual Studio 2015 from the Start Menu. Then, open UnityTanksWithAzure solution that was generated in the previous step in Ex2\Begin\UnityTanksWithAzure\Ex2Begin by double clicking on it. Right click UnityTanksWithAzure (Universal Windows) project and select Rebuild All. After Visual Studio rebuilds the project you can run the project by pressing F5. This should start Tanks! game as a Windows Universal app.

   

   Visual Studio Solution

Note: At any point if you want to jump to the finished app, you can repeat steps in this task to generate a Ex2\End project, it contains completed source code.

Task 2 - Add code to save game score in Azure

1. First you need to create a data model for Azure Mobile app. The great thing about Azure Mobile apps is that as you change your data model, backend automatically picks up the changes. In our game we’ll save user and the best score achieved during the game. Add the following code to GameScore.cs file in Assets\Complete\Scripts\Build16 folder.

   (Code Snippet - GameAzure - Ex2 - GameScore.cs)

   public class GameScore
   {
       public string id { get; set; }
   
       public string user { get; set; }
   
       public float score { get; set; }
   
       public int tank { get; set; }
   }

2. Next, you need to connect your game to Azure. Add the following code to GameManager.cs Start method after //BUILD16 Connect to Azure comment. Please, make sure to replace <YOUR APP SERVICE> with the name of the service you created in Azure portal.

   (Code Snippet - GameAzure - Ex2 - ConnectToAzure)

   //BUILD16 Connect to Azure
   Debug.Log("Logging into Azure...");
   AzureMobileServices.Connect("https://<YOUR APP SERVICE>.azurewebsites.net");

3. Next, add the following code right after that, this will save initial score to Azure.

   (Code Snippet - GameAzure - Ex2 - InitialGameScore)

   //BUILD16 Save initial game score in Azure
   userId = System.Guid.NewGuid().ToString();
   GameScore score = new GameScore { user = userId, score = 0 };
   AzureMobileServices.Insert<GameScore>(score, (response) =>
   {
   	if (response.Status == CallbackStatus.Failure)
   	{
   		 Debug.LogError("Inserting record failed.");
   		 Debug.LogError(response.Exception.ToString());
   		 return;
   	}
   
   	// print something
   	Debug.Log("Successfully inserted item " + score.id);
   });

4. Each time a tank wins a round, you need to save game score in Azure App Service for that tank. You need to add this method to GameManager.cs. This method checks if there's a winning tank m_RoundWinner and saves the score for that tank in the database.

   (Code Snippet - GameAzure - Ex2 - SaveScoreInAzure)

   private void SaveScoreInAzure()
   {
   	if (m_RoundWinner != null)
   	{
   		 GameScore score = new GameScore { user = userId, tank = m_RoundWinner.m_PlayerNumber, score = m_RoundWinner.m_Wins };
   		 AzureMobileServices.Insert<GameScore>(score, (response) =>
   		 {
   			  if (response.Status == CallbackStatus.Failure)
   			  {
   					Debug.LogError("Inserting record failed.");
   					Debug.LogError(response.Exception.ToString());
   					return;
   			  }
   
   		 // print something
   		 Debug.Log("Successfully inserted item " + score.id);
   		 });
   	}
   }

5. Lastly, you need to invoke this method each time a round ends. Go to GameManager.cs, find RoundEnding method and add a call to your SaveScoreToAzure() method right below where the number of wins is incremented for the player. Don't forget to put both statements in curved brackets, like so.

   (Code Snippet - GameAzure - Ex2 - RoundEndUpdate)

   // If there is a winner, increment their score.
   if (m_RoundWinner != null)
   {
   	m_RoundWinner.m_Wins++;
   	SaveScoreInAzure();
   }

6. In Visual Studio you can fully debug your Unity game. Let's set a few breakpoints: in Visual Studio solution explorer navigate to GameManager.cs.

   

   Set Breakpoints

7. Set up a breakpoint before you call AzureMobileServices.Insert method.

   

   Set Breakpoints for Score

8. Now, build and run the game by pressing F5 in Visual Studio. After the app launches, you can see that the GameScore table you’ve just created has a new record. In Azure portal click the Game Score table.

   

   Game Score Inserted

9. Observe a new record added, or alternatively you can connect to the database directly from Visual Studio and check that records are inserted.

   

   Game Score Inserted Record

---

Summary

Congratulations on completing this module! You’ve learned how you can connect Microsoft Azure to your game with just a few lines of code. You learned how to use Microsoft Azure portal to create an manage Azure services. By completing this module, you should have:

• Created a Mobile App in Azure and connected to your game.
• Learned how to save game score in Azure

Additional Resources

• Microsoft Azure
• Azure App Service
• Unity Tanks Game