Update Team Defaults and TeamConfig Docs

Lan2Play · Nov 11, 2024 · 7b14a24 · 7b14a24
1 parent 7e9de93
commit 7b14a24
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 5 deletions.
diff --git a/Docs/source/admin/configuration.rst b/Docs/source/admin/configuration.rst
@@ -60,6 +60,22 @@ Matchconfig Fields
 | team_mode                | 0               | Change how teams are defined. 0: Default (Teams are fix defined) 1: Scramble (Teams are scrambled when all players are ready) |
 +--------------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------+
 
+Team Fields
+'''''''''''''''''''''
++---------+-----------------+---------------------------------------------------------------------------------------------------+
+|  Field  |  DefaultValue   |                                            Description                                            |
++=========+=================+===================================================================================================+
+| id      | ULID            | Id for the Team, if not defined a new ULID will be generated                                      |
++---------+-----------------+---------------------------------------------------------------------------------------------------+
+| name    | none (required) | The Teamname                                                                                      |
++---------+-----------------+---------------------------------------------------------------------------------------------------+
+| tag     | none (required) | Currently not used                                                                                |
++---------+-----------------+---------------------------------------------------------------------------------------------------+
+| flag    | DE (required)   | The flag that is displayed                                                                        |
++---------+-----------------+---------------------------------------------------------------------------------------------------+
+| players | none            | The List of Players (SteamID and Username). If defined only the given players can join the match. |
++---------+-----------------+---------------------------------------------------------------------------------------------------+
+
 Matchconfig Example
 '''''''''''''''''''''
 
@@ -68,6 +84,7 @@ Matchconfig Example
    {
      "maplist": ["de_vertigo", "de_dust2", "de_inferno", "de_mirage", "de_nuke", "de_overpass", "de_ancient"],
      "team1": {
+       "id": "1",
        "name": "hallo",
        "tag": "hallo",
        "flag": "DE",
@@ -77,6 +94,7 @@ Matchconfig Example
        }
      },
      "team2": {
+       "id": "2",
        "name": "asd",
        "tag": "asd",
        "flag": "DE",

diff --git a/PugSharp.Config/PugSharp.Config.csproj b/PugSharp.Config/PugSharp.Config.csproj
@@ -11,6 +11,7 @@
 		<PackageReference Include="Microsoft.Extensions.Logging" Version="8.0.1" />
 		<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="8.0.2" />
 		<PackageReference Include="OneOf" Version="3.0.271" />
+		<PackageReference Include="Ulid" Version="1.3.4" />
 	</ItemGroup>
 
 	<ItemGroup>

diff --git a/PugSharp.Config/Team.cs b/PugSharp.Config/Team.cs
@@ -5,16 +5,16 @@ namespace PugSharp.Config;
 public class Team
 {
     [JsonPropertyName("id")]
-    public required string Id { get; set; }
+    public required string Id { get; set; } = Ulid.NewUlid().ToString();
 
     [JsonPropertyName("name")]
-    public required string Name { get; set; }
+    public required string Name { get; set; } = string.Empty;
 
     [JsonPropertyName("tag")]
     public string Tag { get; init; } = string.Empty;
 
     [JsonPropertyName("flag")]
-    public string Flag { get; init; } = string.Empty;
+    public string Flag { get; init; } = "DE";
 
     [JsonPropertyName("players")]
     public IDictionary<ulong, string> Players { get; init; } = new Dictionary<ulong, string>();

diff --git a/PugSharp.Match/MatchInfo.cs b/PugSharp.Match/MatchInfo.cs
@@ -8,9 +8,9 @@ public class MatchInfo
 {
     public MatchInfo(MatchConfig config)
     {
-        MatchMaps = Enumerable.Range(0, config.NumMaps).Select(n => new MatchMap(n)).ToList();
-        CurrentMap = MatchMaps[0];
         Config = config;
+        MatchMaps = Enumerable.Range(0, Config.NumMaps).Select(n => new MatchMap(n)).ToList();
+        CurrentMap = MatchMaps[0];
 
         MatchTeam1 = new MatchTeam(Config.Team1) { CurrentTeamSide = Contract.Team.Terrorist };
         MatchTeam2 = new MatchTeam(Config.Team2) { CurrentTeamSide = Contract.Team.CounterTerrorist };