Added GameAnalytics framework which can be used to collect usage statistics. When starting the game for the first time, the player can select whether they want to send usage data or not. Atm only used to collect crash reports.

2018-07-10 13:40:54 +03:00
parent 846291ff54
commit 51f2455ada
9 changed files with 135 additions and 10 deletions
@@ -9,6 +9,7 @@ using System;
 using System.Collections.Generic;
 using System.Diagnostics;
 using System.Reflection;
+using GameAnalyticsSDK.Net;

 namespace Barotrauma
 {
@@ -144,7 +145,7 @@ namespace Barotrauma

            Timing.Accumulator = 0.0f;
            fixedTime = new GameTime();
-
+            
            World = new World(new Vector2(0, -9.82f));
            FarseerPhysics.Settings.AllowSleep = true;
            FarseerPhysics.Settings.ContinuousPhysics = false;
@@ -232,6 +233,36 @@ namespace Barotrauma
            loadingCoroutine = CoroutineManager.StartCoroutine(Load());
        }

+        private void InitUserStats()
+        {
+            if (GameSettings.ShowUserStatisticsPrompt)
+            {
+                var userStatsPrompt = new GUIMessageBox(
+                    "Do you want to help us make Barotrauma better?",
+                    "Do you allow Barotrauma to send usage statistics and error reports to the developers? The data is anonymous, " +
+                    "does not contain any personal information and is only used to help us diagnose issues and improve Barotrauma.",
+                    new string[] { "Yes", "No" });
+                userStatsPrompt.Buttons[0].OnClicked += (btn, userdata) =>
+                {
+                    GameSettings.SendUserStatistics = true;
+                    GameAnalytics.ConfigureBuild(Version.ToString());
+                    GameAnalytics.Initialize("a3a073c20982de7c15d21e840e149122", "dbcdabf31c6481129a024df3ee6bad02aeddbab7");
+                    return true;
+                };
+                userStatsPrompt.Buttons[0].OnClicked += userStatsPrompt.Close;
+                userStatsPrompt.Buttons[1].OnClicked += (btn, userdata) => { GameSettings.SendUserStatistics = false; return true; };
+                userStatsPrompt.Buttons[1].OnClicked += userStatsPrompt.Close;
+            }
+            else
+            {
+                if (GameSettings.SendUserStatistics)
+                {
+                    GameAnalytics.ConfigureBuild(Version.ToString());
+                    GameAnalytics.Initialize("a3a073c20982de7c15d21e840e149122", "dbcdabf31c6481129a024df3ee6bad02aeddbab7");
+                }
+            }
+        }
+
        private IEnumerable<object> Load()
        {
            if (GameSettings.VerboseLogging)
@@ -241,6 +272,8 @@ namespace Barotrauma
            GUI.GraphicsDevice = base.GraphicsDevice;
            GUI.Init(Content);

+            InitUserStats();
+
            GUIComponent.Init(Window);
            DebugConsole.Init(Window);
            DebugConsole.Log(SelectedPackage == null ? "No content package selected" : "Content package \"" + SelectedPackage.Name + "\" selected");
@@ -472,7 +505,7 @@ namespace Barotrauma
        protected override void OnExiting(object sender, EventArgs args)
        {
            if (NetworkMember != null) NetworkMember.Disconnect();
-           
+            if (GameSettings.SendUserStatistics) GameAnalytics.OnStop();
            base.OnExiting(sender, args);
        }
    }
@@ -6,6 +6,7 @@ using System.Text;

 #if WINDOWS
 using System.Windows.Forms;
+using GameAnalyticsSDK.Net;
 using Microsoft.Xna.Framework.Graphics;
 #endif

@@ -135,7 +136,6 @@ namespace Barotrauma
            sb.AppendLine("Barotrauma Client crash report (generated on " + DateTime.Now + ")");
            sb.AppendLine("\n");
            sb.AppendLine("Barotrauma seems to have crashed. Sorry for the inconvenience! ");
-            sb.AppendLine("If you'd like to help fix the bug that caused the crash, please send this file to the developers on the Undertow Games forums.");
            sb.AppendLine("\n");
 #if DEBUG
            sb.AppendLine("Game version " + GameMain.Version + " (debug build)");
@@ -192,14 +192,25 @@ namespace Barotrauma
            {
                sb.AppendLine("[" + DebugConsole.Messages[i].Time + "] " + DebugConsole.Messages[i].Text);
            }
+
+            string crashReport = sb.ToString();
            
-            sw.WriteLine(sb.ToString());
+            sw.WriteLine(crashReport);
            sw.Close();

            if (GameSettings.SaveDebugConsoleLogs) DebugConsole.SaveLogs();

-            CrashMessageBox( "A crash report (\"crashreport.log\") was saved in the root folder of the game."+
-                " If you'd like to help fix this bug, please post the report on Barotrauma's GitHub issue tracker: https://github.com/Regalis11/Barotrauma/issues/");       
+            if (GameSettings.SendUserStatistics)
+            {
+                CrashMessageBox( "A crash report (\"crashreport.log\") was saved in the root folder of the game and sent to the developers.");
+                GameAnalytics.AddErrorEvent(EGAErrorSeverity.Error, crashReport);
+                GameAnalytics.OnStop();
+            }
+            else
+            {
+                CrashMessageBox("A crash report (\"crashreport.log\") was saved in the root folder of the game. The error was not sent to the developers because user statistics have been disabled, but" +
+                    " if you'd like to help fix this bug, you may post it on Barotrauma's GitHub issue tracker: https://github.com/Regalis11/Barotrauma/issues/");
+            }
        }
    }
 #endif