149 team info module

EvoSC.sln

@@ -118,11 +118,15 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "LocalRecordsModule.Tests",
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ForceTeamModule", "src/Modules/ForceTeamModule/ForceTeamModule.csproj", "{ACFF2B23-0518-493C-93A0-08CF9FD4F8E6}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ForceTeamModule.Tests", "tests\Modules\ForceTeamModule.Tests\ForceTeamModule.Tests.csproj", "{DE9532E8-F0ED-400B-9592-AF8F74BC83EB}"
+EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TeamSettingsModule", "src\Modules\TeamSettingsModule\TeamSettingsModule.csproj", "{C10A11E5-4AD8-4229-81F1-57D7DC364E27}"
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TeamSettingsModule.Tests", "tests\Modules\TeamSettingsModule.Tests\TeamSettingsModule.Tests.csproj", "{B1745099-0081-4443-BF79-26A888765E16}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ForceTeamModule.Tests", "tests\Modules\ForceTeamModule.Tests\ForceTeamModule.Tests.csproj", "{DE9532E8-F0ED-400B-9592-AF8F74BC83EB}"
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TeamInfoModule", "src\Modules\TeamInfoModule\TeamInfoModule.csproj", "{5E178B0D-5F29-4990-8DCF-DC7FF113C4F0}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TeamInfoModule.Tests", "tests\Modules\TeamInfoModule.Tests\TeamInfoModule.Tests.csproj", "{71D8BDA5-6787-471A-8064-CEEE4203EBEF}"
 EndProject
 
 
@@ -366,6 +370,14 @@ Global
 		{DE9532E8-F0ED-400B-9592-AF8F74BC83EB}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{DE9532E8-F0ED-400B-9592-AF8F74BC83EB}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{DE9532E8-F0ED-400B-9592-AF8F74BC83EB}.Release|Any CPU.Build.0 = Release|Any CPU
+		{5E178B0D-5F29-4990-8DCF-DC7FF113C4F0}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{5E178B0D-5F29-4990-8DCF-DC7FF113C4F0}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{5E178B0D-5F29-4990-8DCF-DC7FF113C4F0}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{5E178B0D-5F29-4990-8DCF-DC7FF113C4F0}.Release|Any CPU.Build.0 = Release|Any CPU
+		{71D8BDA5-6787-471A-8064-CEEE4203EBEF}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{71D8BDA5-6787-471A-8064-CEEE4203EBEF}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{71D8BDA5-6787-471A-8064-CEEE4203EBEF}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{71D8BDA5-6787-471A-8064-CEEE4203EBEF}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -420,9 +432,11 @@ Global
 		{098D1F9B-054D-4158-BB6C-AC908C4595F6} = {6D75D6A2-6ECD-4DE4-96C5-CAD7D134407A}
 		{1D8DBFC8-EC21-4DDA-9D88-DE7CA04C8449} = {DC47658A-F421-4BA4-B617-090A7DFB3900}
 		{7401429B-B842-4316-B7A2-B77E9AD966CB} = {6D75D6A2-6ECD-4DE4-96C5-CAD7D134407A}
-		{ACFF2B23-0518-493C-93A0-08CF9FD4F8E6} = {DC47658A-F421-4BA4-B617-090A7DFB3900}
 		{C10A11E5-4AD8-4229-81F1-57D7DC364E27} = {DC47658A-F421-4BA4-B617-090A7DFB3900}
 		{B1745099-0081-4443-BF79-26A888765E16} = {6D75D6A2-6ECD-4DE4-96C5-CAD7D134407A}
+		{5E178B0D-5F29-4990-8DCF-DC7FF113C4F0} = {DC47658A-F421-4BA4-B617-090A7DFB3900}
+		{71D8BDA5-6787-471A-8064-CEEE4203EBEF} = {6D75D6A2-6ECD-4DE4-96C5-CAD7D134407A}
+		{ACFF2B23-0518-493C-93A0-08CF9FD4F8E6} = {DC47658A-F421-4BA4-B617-090A7DFB3900}
 		{DE9532E8-F0ED-400B-9592-AF8F74BC83EB} = {6D75D6A2-6ECD-4DE4-96C5-CAD7D134407A}
 	EndGlobalSection
 EndGlobal

src/EvoSC/EvoSC.csproj

@@ -49,6 +49,7 @@
         <ProjectReference Include="..\Modules\MatchManagerModule\MatchManagerModule.csproj" />
         <ProjectReference Include="..\Modules\ASayModule\ASayModule.csproj" />
         <ProjectReference Include="..\Modules\SpectatorTargetInfoModule\SpectatorTargetInfoModule.csproj" />
+        <ProjectReference Include="..\Modules\TeamInfoModule\TeamInfoModule.csproj" />
         <ProjectReference Include="..\Modules\TeamSettingsModule\TeamSettingsModule.csproj" />
         <ProjectReference Include="..\Modules\WorldRecordModule\WorldRecordModule.csproj" />
         <ProjectReference Include="..\Modules\MotdModule\MotdModule.csproj" />
@@ -68,5 +69,4 @@
     <ItemGroup>
       <Folder Include="bin\Debug\net8.0\config\" />
     </ItemGroup>
-
 </Project>

src/EvoSC/InternalModules.cs

@@ -22,6 +22,7 @@
 using EvoSC.Modules.Official.Scoreboard;
 using EvoSC.Modules.Official.SetName;
 using EvoSC.Modules.Official.SpectatorTargetInfoModule;
+using EvoSC.Modules.Official.TeamInfoModule;
 using EvoSC.Modules.Official.TeamSettingsModule;
 using EvoSC.Modules.Official.WorldRecordModule;
 using FluentMigrator.Runner.Exceptions;
@@ -55,7 +56,8 @@ public static class InternalModules
         typeof(MapListModule),
         typeof(LocalRecordsModule),
         typeof(ForceTeamModule),
-        typeof(TeamSettingsModule)
+        typeof(TeamSettingsModule),
+        typeof(TeamInfoModule)
     ];
 
     /// <summary>
@@ -77,7 +79,7 @@ public static void RunInternalModuleMigrations(this IMigrationManager migrations
             }
         }
     }
-    
+
     /// <summary>
     /// Load all internal modules.
     /// </summary>

src/Modules/TeamInfoModule/Config/ITeamInfoSettings.cs

@@ -0,0 +1,18 @@
+using System.ComponentModel;
+using Config.Net;
+using EvoSC.Modules.Attributes;
+
+namespace EvoSC.Modules.Official.TeamInfoModule.Config;
+
+[Settings]
+public interface ITeamInfoSettings
+{
+    [Option(DefaultValue = 0.0), Description("Specifies the horizontal center position of the widget.")]
+    public double X { get; set; }
+
+    [Option(DefaultValue = 80.0), Description("Specifies the vertical top edge position of the wigdet. Values from -90 to 90 allowed.")]
+    public double Y { get; set; }
+
+    [Option(DefaultValue = false), Description("If enabled a smaller version of the widget is shown, without the large team name.")]
+    public bool CompactMode { get; set; }
+}

src/Modules/TeamInfoModule/Controllers/TeamInfoEventController.cs

@@ -0,0 +1,81 @@
+using EvoSC.Common.Controllers;
+using EvoSC.Common.Controllers.Attributes;
+using EvoSC.Common.Events.Attributes;
+using EvoSC.Common.Interfaces.Controllers;
+using EvoSC.Common.Models;
+using EvoSC.Common.Remote;
+using EvoSC.Common.Remote.EventArgsModels;
+using EvoSC.Modules.Official.TeamInfoModule.Interfaces;
+using GbxRemoteNet.Events;
+
+namespace EvoSC.Modules.Official.TeamInfoModule.Controllers;
+
+[Controller]
+public class TeamInfoEventController(ITeamInfoService teamInfoService) : EvoScController<IEventControllerContext>
+{
+    [Subscribe(ModeScriptEvent.Scores)]
+    public async Task OnScoresAsync(object sender, ScoresEventArgs eventArgs)
+    {
+        var isTeamsModeActive = await teamInfoService.GetModeIsTeamsAsync();
+
+        if (!eventArgs.UseTeams)
+        {
+            if (!isTeamsModeActive)
+            {
+                return;
+            }
+
+            await teamInfoService.SetModeIsTeamsAsync(false);
+            await teamInfoService.HideTeamInfoWidgetEveryoneAsync();
+
+            return;
+        }
+
+        if (!isTeamsModeActive)
+        {
+            await teamInfoService.SetModeIsTeamsAsync(true);
+        }
+
+        var teamInfos = eventArgs.Teams.ToList();
+        var team1Points = teamInfos[0]!.MatchPoints;
+        var team2Points = teamInfos[1]!.MatchPoints;
+
+        if (eventArgs.Section is ModeScriptSection.EndRound or ModeScriptSection.Undefined)
+        {
+            await teamInfoService.UpdatePointsAsync(team1Points, team2Points);
+        }
+    }
+
+    [Subscribe(ModeScriptEvent.StartRoundStart)]
+    public async Task OnRoundStartAsync(object sender, RoundEventArgs args)
+    {
+        if (!await teamInfoService.GetModeIsTeamsAsync())
+        {
+            return;
+        }
+
+        await teamInfoService.UpdateRoundNumberAsync(args.Count);
+    }
+
+    [Subscribe(ModeScriptEvent.PodiumStart)]
+    public async Task OnPodiumStartAsync(object sender, PodiumEventArgs args)
+    {
+        if (!await teamInfoService.GetModeIsTeamsAsync())
+        {
+            return;
+        }
+
+        await teamInfoService.HideTeamInfoWidgetEveryoneAsync();
+    }
+
+    [Subscribe(GbxRemoteEvent.EndMap)]
+    public async Task OnEndMapAsync(object sender, MapGbxEventArgs args)
+    {
+        if (!await teamInfoService.GetModeIsTeamsAsync())
+        {
+            return;
+        }
+
+        await teamInfoService.HideTeamInfoWidgetEveryoneAsync();
+    }
+}

src/Modules/TeamInfoModule/Interfaces/ITeamInfoService.cs

@@ -0,0 +1,81 @@
+using EvoSC.Modules.Official.TeamInfoModule.Models;
+
+namespace EvoSC.Modules.Official.TeamInfoModule.Interfaces;
+
+public interface ITeamInfoService
+{
+    /// <summary>
+    /// Triggers detection if team mode is active.
+    /// </summary>
+    /// <returns></returns>
+    public Task InitializeModuleAsync();
+
+    /// <summary>
+    /// Gets the current mode script settings for teams mode.
+    /// </summary>
+    /// <returns></returns>
+    public Task<ModeScriptTeamSettings> GetModeScriptTeamSettingsAsync();
+
+    /// <summary>
+    /// Get the text displayed at the bottom of the team info widget.
+    /// </summary>
+    /// <param name="modeScriptTeamSettings"></param>
+    /// <returns></returns>
+    public Task<string?> GetInfoBoxTextAsync(ModeScriptTeamSettings modeScriptTeamSettings);
+
+    /// <summary>
+    /// Gets all necessary data for the widget.
+    /// </summary>
+    /// <returns></returns>
+    public Task<dynamic> GetWidgetDataAsync();
+
+    /// <summary>
+    /// Determines whether a team has match point.
+    /// </summary>
+    /// <param name="teamPoints"></param>
+    /// <param name="opponentPoints"></param>
+    /// <param name="pointsLimit"></param>
+    /// <param name="pointsGap"></param>
+    /// <returns></returns>
+    public Task<bool> DoesTeamHaveMatchPointAsync(int teamPoints, int opponentPoints, int pointsLimit, int pointsGap);
+
+    /// <summary>
+    /// Sends the team info widget to all players.
+    /// </summary>
+    /// <returns></returns>
+    public Task SendTeamInfoWidgetEveryoneAsync();
+
+    /// <summary>
+    /// Hides the team info widget for all players.
+    /// </summary>
+    /// <returns></returns>
+    public Task HideTeamInfoWidgetEveryoneAsync();
+
+    /// <summary>
+    /// Sets the current round number.
+    /// </summary>
+    /// <param name="round"></param>
+    /// <returns></returns>
+    public Task UpdateRoundNumberAsync(int round);
+
+    /// <summary>
+    /// Updates the points for both teams.
+    /// </summary>
+    /// <param name="team1Points"></param>
+    /// <param name="team2Points"></param>
+    /// <returns></returns>
+    public Task UpdatePointsAsync(int team1Points, int team2Points);
+
+    /// <summary>
+    /// Tells whether the service is currently active for teams mode.
+    /// </summary>
+    /// <returns></returns>
+    public Task<bool> GetModeIsTeamsAsync();
+
+    /// <summary>
+    /// Sets whether the service is active for teams mode or not.
+    /// </summary>
+    /// <param name="modeIsTeams"></param>
+    /// <returns></returns>
+    public Task SetModeIsTeamsAsync(bool modeIsTeams);
+}

src/Modules/TeamInfoModule/Localization.resx

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="utf-8"?>
+<root>
+  <xsd:schema xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata" id="root">
+    <xsd:element name="root" msdata:IsDataSet="true">
+    </xsd:element>
+  </xsd:schema>
+  <resheader name="resmimetype">
+    <value>text/microsoft-resx</value>
+  </resheader>
+  <resheader name="version">
+    <value>1.3</value>
+  </resheader>
+  <resheader name="reader">
+    <value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
+  </resheader>
+  <resheader name="writer">
+    <value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
+  </resheader>
+</root>

src/Modules/TeamInfoModule/Models/ModeScriptTeamSettings.cs

@@ -0,0 +1,70 @@
+namespace EvoSC.Modules.Official.TeamInfoModule.Models;
+
+public class ModeScriptTeamSettings
+{
+    /// <summary>
+    /// The amount of points a team has to reach to win the match.
+    /// </summary>
+    public int PointsLimit { init; get; } = 5;
+
+    /// <summary>
+    /// Finish timeout.
+    /// </summary>
+    public int FinishTimeout { init; get; } = -1;
+
+    /// <summary>
+    /// The maximum number of points attributed to the first player to cross the finish line.
+    /// </summary>
+    public int MaxPointsPerRound { init; get; } = 6;
+
+    /// <summary>
+    /// Defines how much points difference there has to be for a team to win (tennis mode).
+    /// </summary>
+    public int PointsGap { init; get; } = 1;
+
+    /// <summary>
+    /// Use a custom points repartition.
+    /// If false points repartition is [10, 6, 4, 3, 2, 1].
+    /// </summary>
+    public bool UseCustomPointsRepartition { init; get; } = false;
+
+    /// <summary>
+    /// At the end of the round both teams win their players points.
+    /// </summary>
+    public bool CumulatePoints { init; get; } = false;
+
+    /// <summary>
+    /// Number of rounds to play on one map, before going to the next one.
+    /// </summary>
+    public int RoundsPerMap { init; get; } = -1;
+
+    /// <summary>
+    /// Number of maps to play before the match ends.
+    /// </summary>
+    public int MapsPerMatch { init; get; } = -1;
+
+    /// <summary>
+    /// Continue to play the map until the tie is broken.
+    /// </summary>
+    public bool UseTieBreak { init; get; } = true;
+
+    /// <summary>
+    /// Number of warmups.
+    /// </summary>
+    public int WarmUpNb { init; get; } = 0;
+
+    /// <summary>
+    /// Duration of one warmup in seconds.
+    /// </summary>
+    public int WarmUpDuration { init; get; } = 0;
+
+    /// <summary>
+    /// Use alternate rules.
+    /// </summary>
+    public bool UseAlternateRules { init; get; } = true;
+
+    /// <summary>
+    /// Neutral emblem URL.
+    /// </summary>
+    public string NeutralEmblemUrl { init; get; } = "";
+}