Add support for player 2. Ensure messages are exchanged in structured objects

Author: sruon

README.md

@@ -1,9 +1,5 @@
 # Sinden Companion
 
-## TODO
-- More game offsets
-- Pass logger to config
-
 ## Getting started
 - Download the most recent release from the release page
 - Unzip the content in the same folder as Lightgun.exe
@@ -70,8 +66,9 @@ game_profiles:
         title: "My Game"
     # Optional : Set a memory reader to read the game's memory and change profile dynamically
     memscan:
-        # Pointer path to use
-        code: mygame.exe+0x0018AC00,0x364,0x4
+        # Pointer paths to use. First element maps to Player 1, second to Player 2.
+        paths: 
+          - mygame.exe+0x0018AC00,0x364,0x4
         # Type of value to read (byte, short, int, uint)
         type: "byte"
         # Matching values
@@ -84,47 +81,6 @@ game_profiles:
           0x7: "Single" # Sniper
 ```
 
-## Simple configuration file for testing
-
-```yaml
-global:
-    recoil_on_switch: true
-    debug: true
-recoil_profiles:
-    - name: "Single"
-      automatic: false
-      pulse_length: 0
-      delay_between_pulses: 0
-      offscreen: false
-      strength: 50
-    - name: "Auto_Fast"
-      automatic: true
-      pulse_length: 40
-      delay_between_pulses: 3
-      offscreen: false
-      strength: 3
-game_profiles:
-    - name: "Notepad"
-      profile: "Auto_Fast"
-      match:
-        exe: "Notepad.exe"
-    - name: "Sinden"
-      profile: "Single"
-      match:
-        title: "SindenLightgun"
-    - name: "Assault Cube"
-      profile: "Single"
-      match:
-        exe: "ac_client.exe"
-      memscan:
-        code: ac_client.exe+0x0018AC00,0x364,0x4
-        size: 1
-        match: 
-          0x0: "Single" # Knife
-          0x1: "Single" # Glock
-          0x6: "Auto_Fast" # AR
-          0x7: "Single" # Sniper
-```
 
 Launching the application and switching between Notepad and Lightgun.exe should produce recoil events.
 

SindenCompanion/AppForm.cs

@@ -17,7 +17,7 @@ public partial class AppForm : Form
         private readonly Config _conf;
         public readonly RichTextBox WpfRichTextBox;
 
-        private Action<RecoilProfile> _callback;
+        private Action<int, RecoilProfile> _callback;
 
         private bool _userRequestedClose;
 
@@ -50,7 +50,7 @@ public AppForm(Config conf)
             WpfRichTextBox = wpfRichTextBox;
         }
 
-        public void SetCallback(Action<RecoilProfile> callback)
+        public void SetCallback(Action<int, RecoilProfile> callback)
         {
             _callback = callback;
         }
@@ -115,7 +115,7 @@ private void NotificationIconMenu_Opened(object sender, EventArgs e)
             foreach (var profile in _conf.RecoilProfiles)
             {
                 var item = new ToolStripMenuItem(profile.Name);
-                item.Click += (s, a) => { _callback(profile); };
+                item.Click += (s, a) => { _callback(-1,profile); };
                 changeProfileMenuItem.DropDownItems.Add(item);
             }
         }

SindenCompanion/Config.cs

@@ -87,14 +87,12 @@ public static Config GetInstance()
                 _fw.Filter = "config.yaml";
                 _fw.Changed += new FileSystemEventHandler((e, a) =>
                 {
-                    if (Logger != null)
-                    {
-                        Logger.Information("Detected changes to config file.");
-                    }
+                    if (Logger != null) Logger.Information("Detected changes to config file.");
                     _instance = null;
                 });
                 _fw.EnableRaisingEvents = true;
             }
+
             if (Logger != null)
                 Logger.Information("Loading configuration.");
 
@@ -110,7 +108,7 @@ public static Config GetInstance()
                     var result = validator.Validate(_instance);
                     if (!result.IsValid)
                     {
-                        string reason = "";
+                        var reason = "";
                         foreach (var failure in result.Errors)
                             reason += "Property " + failure.PropertyName + " failed validation. Error was: " +
                                       failure.ErrorMessage + "\n";
@@ -167,7 +165,7 @@ public bool Matches(ForegroundProcess fp)
 
             if ($"{fp.ProcessName}.exe" == Match.Exe) return true;
 
-            if (Match.Title == fp.WindowTitle) return true;
+            if (!string.IsNullOrEmpty(Match.Title) && Match.Title == fp.WindowTitle) return true;
 
             return false;
         }
@@ -199,8 +197,8 @@ public GameProfileValidator(Config parent)
                 .WithMessage(x => $"GameProfile.{x.Name}.Match.Exe must be set when title is empty.");
             RuleFor(x => x.Match.Title).NotNull().NotEmpty().When(x => x.Match != null && x.Match.Exe == null)
                 .WithMessage(x => $"GameProfile.{x.Name}.Match.Title must be set when exe is empty.");
-            RuleFor(x => x.Memscan.Code).NotNull().When(x => x.Memscan != null)
-                .WithMessage("A valid pointer path must be provided.");
+            RuleFor(x => x.Memscan.Paths).NotNull().NotEmpty().Must(x => x.Length <= 2).When(x => x.Memscan != null)
+                .WithMessage("At least one pointer path must be provided. At most two pointer paths can be provided.");
             RuleFor(x => x.Memscan.Type).NotNull().Must(ValidScanType).When(x => x.Memscan != null).WithMessage(x =>
                 $"GameProfile.{x.Name}.Memscan.Type: A valid type must be provided ({string.Join(", ", MemScan.TypeMap.Keys)})");
             RuleFor(x => x.Memscan.Match).NotNull().NotEmpty().When(x => x.Memscan != null)
@@ -233,7 +231,7 @@ public class MemScan
             //{"string", ScanType.String},
         };
 
-        public string Code { get; set; }
+        public string[] Paths { get; set; }
         public string Type { get; set; }
 
         public Dictionary<int, string> Match { get; set; }

SindenCompanion/Program.cs

@@ -17,7 +17,7 @@ public class App : IDisposable
         private readonly ServerInterface _server;
         private bool _clientReady = false;
         private Config _conf;
-        private RecoilProfile _currentProfile;
+        private List<RecoilProfile> _currentProfile = new List<RecoilProfile> { null, null };
 
         public App(ILogger logger)
         {
@@ -33,11 +33,20 @@ public void Dispose()
             foreach (var memlib in _memReaders.Values) memlib.CloseProcess();
         }
 
-        public void ChangeProfile(RecoilProfile rp)
+        public void ChangeProfile(int playerIndex, RecoilProfile rp)
         {
-            _server.SendMessage(MessageBuilder.Build("profile", rp).AsMessage());
-            if (_conf.Global.RecoilOnSwitch) _server.SendMessage(MessageBuilder.Build("recoil", null).AsMessage());
-            _currentProfile = rp;
+            var rpw = new RecoilProfileWrapper()
+            {
+                RecoilProfile = rp,
+                Player = playerIndex
+            };
+            _server.SendMessage(MessageBuilder.Build("profile", rpw).AsMessage());
+            if (_conf.Global.RecoilOnSwitch)
+                _server.SendMessage(MessageBuilder.Build("recoil", playerIndex).AsMessage());
+            if (playerIndex == -1)
+                _currentProfile = new List<RecoilProfile> { rp, rp };
+            else
+                _currentProfile[playerIndex] = rp;
         }
 
         public void InjectionNotification()
@@ -106,54 +115,75 @@ public void WindowEventHandler(IntPtr hWinEventHook, uint eventType, IntPtr hwnd
                                 return;
                             }
 
-                            dynamic value;
-                            string profName = null;
-                            switch (matchedGp.Memscan.Type)
+                            var idx = 0;
+                            foreach (var path in matchedGp.Memscan.Paths)
                             {
-                                case "byte":
-                                    value = memlib.ReadByte(matchedGp.Memscan.Code);
-                                    matchedGp.Memscan.Match.TryGetValue(value, out profName);
-                                    break;
-                                case "short":
-                                    value = memlib.Read2Byte(matchedGp.Memscan.Code);
-                                    matchedGp.Memscan.Match.TryGetValue(value, out profName);
-                                    break;
-                                case "int":
-                                    value = memlib.ReadInt(matchedGp.Memscan.Code);
-                                    matchedGp.Memscan.Match.TryGetValue(value, out profName);
-                                    break;
-                                case "uint":
-                                    value = memlib.ReadUInt(matchedGp.Memscan.Code);
-                                    matchedGp.Memscan.Match.TryGetValue(value, out profName);
-                                    break;
-                                default:
-                                    _logger.Error("Unsupported memory scan type: {@Type}", matchedGp.Memscan.Type);
-                                    return;
-                            }
+                                dynamic value;
+                                string profName = null;
+                                try
+                                {
+                                    switch (matchedGp.Memscan.Type)
+                                    {
+                                        case "byte":
+                                            value = memlib.ReadByte(path);
+                                            matchedGp.Memscan.Match.TryGetValue(value, out profName);
+                                            break;
+                                        case "short":
+                                            value = memlib.Read2Byte(path);
+                                            matchedGp.Memscan.Match.TryGetValue(value, out profName);
+                                            break;
+                                        case "int":
+                                            value = memlib.ReadInt(path);
+                                            matchedGp.Memscan.Match.TryGetValue(value, out profName);
+                                            break;
+                                        case "uint":
+                                            value = memlib.ReadUInt(path);
+                                            matchedGp.Memscan.Match.TryGetValue(value, out profName);
+                                            break;
+                                        default:
+                                            _logger.Error("Unsupported memory scan type: {@Type}",
+                                                matchedGp.Memscan.Type);
+                                            return;
+                                    }
+                                }
+                                catch (Exception e)
+                                {
+                                    _logger.Error(e,
+                                        "[P{@Index}] Exception while reading memory. The application may still be initializing or the pointer path is incorrect: {@Exception}",
+                                        idx + 1, e);
+                                    continue;
+                                }
 
-                            if (!string.IsNullOrEmpty(profName))
-                            {
-                                matchedRp = _conf.RecoilProfiles.FirstOrDefault(p => p.Name == profName);
-                                if (matchedRp == null)
+                                _logger.Debug("[P{@Index}] Memory scan result: {@Value} -> {@Profile}", idx + 1, value,
+                                    profName);
+                                if (!string.IsNullOrEmpty(profName))
+                                {
+                                    matchedRp = _conf.RecoilProfiles.FirstOrDefault(p => p.Name == profName);
+                                    if (matchedRp == null)
+                                    {
+                                        _logger.Error(
+                                            "[{@Game}][MEM][Player {@Index}] {@Value} -> {@Profile} not found. Check your configuration.",
+                                            matchedGp.Name, idx + 1, value, profName);
+                                        continue;
+                                    }
+                                }
+                                else
                                 {
                                     _logger.Error(
-                                        "[{@Game}][MEM] {@Value} -> {@Profile} not found. Check your configuration.",
-                                        matchedGp.Name, value, profName);
+                                        "[{@Game}][MEM][Player {@Index}] {@Value} -> No profile found. Check your configuration.",
+                                        matchedGp.Name, idx + 1, value);
                                     continue;
                                 }
-                            }
-                            else
-                            {
-                                _logger.Error("[{@Game}][MEM] {@Value} -> No profile found. Check your configuration.",
-                                    matchedGp.Name, value);
-                                continue;
-                            }
 
-                            if (matchedRp != _currentProfile)
-                            {
-                                _logger.Information("[{@Game}][MEM] {@Value} -> {@Profile}", matchedGp.Name, value,
-                                    matchedRp.Name);
-                                ChangeProfile(matchedRp);
+                                if (matchedRp != _currentProfile[idx])
+                                {
+                                    _logger.Information("[{@Game}][MEM][Player {@Index}] {@Value} -> {@Profile}",
+                                        matchedGp.Name, idx + 1, value,
+                                        matchedRp.Name);
+                                    ChangeProfile(idx, matchedRp);
+                                }
+
+                                idx++;
                             }
 
 
@@ -171,10 +201,10 @@ public void WindowEventHandler(IntPtr hWinEventHook, uint eventType, IntPtr hwnd
                         return;
                     }
 
-                    if (matchedRp != _currentProfile)
+                    if (matchedRp != _currentProfile[0])
                     {
                         _logger.Information("[{@Game}] {@Profile}", matchedGp.Name, matchedRp.Name);
-                        ChangeProfile(matchedRp);
+                        ChangeProfile(-1, matchedRp);
                     }
                 }
             }
@@ -192,22 +222,28 @@ select MessageBuilder.FromMessage(msg))
                         _clientReady = true;
                         break;
                     case "recoilack":
-                        if (!(bool)e.Payload)
-                            _logger.Error($"Failed to recoil");
+                        var recoilResp = RecoilResponse.FromString(e.Payload.ToString());
+                        if (!recoilResp.Success)
+                            _logger.Error("Failed to recoil: {@Reason}", recoilResp.Reason);
                         else
-                            _logger.Information($"Recoil ACK - Success");
+                            _logger.Information($"Recoil success");
                         break;
                     case "profileack":
-                        var suc = (bool)e.Payload;
-                        if (!suc)
-                        {
-                            _logger.Error($"Failed to apply profile, Sinden may still be initializing - will retry");
-                            _currentProfile = null;
-                        }
+                        var resp = RecoilProfileResponse.FromString(e.Payload.ToString());
+
+                        if (!resp.Success)
+                            switch (resp.Reason)
+                            {
+                                case "No lightgun at requested index.":
+                                    _logger.Error(
+                                        $"Failed to apply profile -> No lightgun detected at requested player index");
+                                    break;
+                                default:
+                                    _logger.Error("Failed to apply profile: {@Reason}", resp.Reason);
+                                    break;
+                            }
                         else
-                        {
-                            _logger.Information("Successfully applied profile. {@Profile}", _currentProfile);
-                        }
+                            _logger.Information("Successfully applied profiles. {@Profile}", _currentProfile);
 
                         break;
                 }
@@ -223,11 +259,7 @@ internal class Program
         [DllImport("user32.dll")]
         private static extern IntPtr SetWinEventHook(uint eventMin, uint eventMax, IntPtr hmodWinEventProc,
             WinEventDelegate lpfnWinEventProc, uint idProcess, uint idThread, uint dwFlags);
-        [DllImport("kernel32.dll", SetLastError = true)]
-        [return: MarshalAs(UnmanagedType.Bool)]
-        static extern bool AllocConsole();
-        [System.Runtime.InteropServices.DllImport("kernel32.dll")]
-        private static extern bool AttachConsole(int dwProcessId);
+
 
         [STAThread]
         private static void Main(string[] args)
@@ -236,13 +268,13 @@ private static void Main(string[] args)
             try
             {
                 conf = Config.GetInstance();
-
             }
             catch (Exception e)
             {
                 // Crash outright if we don't have a working config
                 throw new InvalidOperationException($"Failed to read configuration: {e}");
             }
+
             var mainForm = new AppForm(conf);
             var logger = Logger.CreateDesktopLogger(conf.Global.Debug, mainForm.WpfRichTextBox);
             Config.Logger = logger;