Merge pull request #961 from splewis/development

Release 0.12

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,46 @@
+name: Bug Report
+description: If you've found a bug or have a problem that you think may be a bug.
+title: "[Bug]: "
+labels: ["unverified bug"]
+body:
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Documentation
+      description: |
+        Before you submit an issue, make sure you've read [the documentation](https://splewis.github.io/get5). You should also check if an issue already exists.
+      options:
+        - label: I have looked in [the documentation](https://splewis.github.io/get5) and cannot find a solution to my problem.
+          required: true
+        - label: I have searched [existing issues](https://github.com/splewis/get5/issues) and this bug has not been addressed.
+          required: true
+  - type: input
+    id: version
+    attributes:
+      label: Get5 Version
+      description: |
+        What version of Get5 are you using? Use [`get5_status`](https://splewis.github.io/get5/latest/commands/#get5_status) in your server console to print it. Note that we only provide support for official builds, so if you compiled Get5 yourself, please run an official build and verify that you still have the problem. You may also download a nightly/prerelease build and verify that you still have the bug then. You can download the latest versions [here](https://github.com/splewis/get5/releases).
+        
+        Please note that "latest" is **not** a version.
+    validations:
+      required: true
+  - type: textarea
+    id: issue
+    attributes:
+      label: The Issue
+      description: Explain the problem. Please be detailed.
+    validations:
+      required: true
+  - type: textarea
+    id: match-config
+    attributes:
+      label: Match Configuration
+      description: Please paste the [match configuration](https://splewis.github.io/get5/latest/match_schema/) you loaded, if any.
+      render: log
+  - type: textarea
+    id: logs
+    attributes:
+      label: Debug Info
+      description: Please copy and paste the output from [`get5_debuginfo`](https://splewis.github.io/get5/latest/commands/#get5_debuginfo). The file is located at `addons/sourcemod/logs/get5_debuginfo.txt` by default. You should preferably run this command as you encounter the issue.
+      render: log
+

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Discord Community Support
+    url: https://discord.gg/zmqEa4keCk
+    about: For support that does not fit the GitHub issue format, please use Discord.

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,33 @@
+name: Feature Request
+description: If you want to request a new feature or a change to an existing feature.
+title: "[Feature Request]: "
+labels: ["feature request"]
+body:
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Prereleases & Documentation
+      description: |
+        Before you submit a feature request, make sure you've read [the documentation](https://splewis.github.io/get5) and that the feature you request has not already been added in a prerelease.
+      options:
+        - label: I have looked in [the documentation](https://splewis.github.io/get5) and I don't see the feature anywhere.
+          required: true
+        - label: I have looked for [pre-releases](https://github.com/splewis/get5/releases) and the feature has not been added.
+          required: true
+  - type: input
+    id: version
+    attributes:
+      label: Get5 Version
+      description: |
+        What version of Get5 are you using? Use [`get5_status`](https://splewis.github.io/get5/latest/commands/#get5_status) in your server console to print it. You can download the latest versions [here](https://github.com/splewis/get5/releases).
+        
+        Please note that "latest" is **not** a version.
+    validations:
+      required: true
+  - type: textarea
+    id: issue
+    attributes:
+      label: The Feature
+      description: Explain the feature you want - and why. Remember that a feature should be widely applicable and make sense for other users.
+    validations:
+      required: true

.github/workflows/build.yml

@@ -88,7 +88,7 @@ jobs:
           myToken: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Tag And Attach Nightly Build
-        uses: ncipollo/release-action@v1.11.1
+        uses: ncipollo/release-action@v1.12.0
         with:
           token: "${{ secrets.GITHUB_TOKEN }}"
           artifacts: "artifacts/${{ needs.build.outputs.filename }}.zip,artifacts/${{ needs.build.outputs.filename }}.tar.gz"
@@ -124,7 +124,7 @@ jobs:
           path: artifacts
 
       - name: Tag And Draft Release
-        uses: ncipollo/release-action@v1.11.1
+        uses: ncipollo/release-action@v1.12.0
         with:
           token: "${{ secrets.GITHUB_TOKEN }}"
           artifacts: "artifacts/${{ needs.build.outputs.filename }}.zip,artifacts/${{ needs.build.outputs.filename }}.tar.gz"

configs/get5/commands.cfg

@@ -0,0 +1,6 @@
+"Commands"
+{
+    // See the documentation for a list of all the available commands you can map.
+    // The syntax is, as a key-value:
+    // "customalias" "command"
+}

configs/get5/tests/default_valid.cfg

@@ -0,0 +1,61 @@
+"Match"
+{
+    "matchid"                  "test_match_valid"
+    "match_title"              "Test {MAPNUMBER} of {MAXMAPS}"
+    "num_maps"                 "3"
+    "skip_veto"                "1"
+    "clinch_series"            "1"
+    "side_type"                "never_knife"
+    "players_per_team"         "5"
+    "coaches_per_team"         "1"
+    "min_players_to_ready"     "3"
+    "min_spectators_to_ready"  "1"
+    "veto_first"               "team2"
+    "maplist"
+    {
+        "de_dust2"   ""
+        "de_mirage"  ""
+        "de_inferno" ""
+        "de_ancient" ""
+    }
+    "map_sides"
+    {
+        "knife"   ""
+        "team1_t" ""
+    }
+    "favored_percentage_team1" "75"
+    "favored_percentage_text"  "team percentage text"
+    "team1"
+    {
+        "name"       "Team A Default"
+        "tag"        "TAG-A"
+        "flag"       "US"
+        "logo"       "logofilename"
+        "players"
+        {
+            "76561197996413459"   "PlayerAName1"
+            "76561197996426756"   "PlayerAName2"
+            "76561197996426757"   "PlayerAName3"
+            "76561197996426758"   "PlayerAName4"
+            "76561197996426759"   "PlayerAName5"
+        }
+        "coaches"
+        {
+            "76561197996426735"   "CoachAName1"
+            "76561197946789735"   "CoachAName2"
+        }
+        "matchtext"  "Defending Champions"
+    }
+    "team2"
+    {
+        "fromfile"   "addons/sourcemod/configs/get5/tests/team2.cfg"
+    }
+    "spectators"
+    {
+        "name"       "Spectator Team Name"
+        "players"
+        {
+            "76561197996426761"   "SpectatorName1"
+        }
+    }
+}

configs/get5/tests/default_valid.json

@@ -0,0 +1,52 @@
+{
+  "matchid": "test_match_valid",
+  "match_title": "Test {MAPNUMBER} of {MAXMAPS}",
+  "num_maps": 3,
+  "skip_veto": true,
+  "clinch_series": true,
+  "side_type": "never_knife",
+  "players_per_team": 5,
+  "coaches_per_team": 1,
+  "min_players_to_ready": 3,
+  "min_spectators_to_ready": 1,
+  "veto_first": "team2",
+  "maplist": [
+    "de_dust2",
+    "de_mirage",
+    "de_inferno",
+    "de_ancient"
+  ],
+  "map_sides": [
+    "knife",
+    "team1_t"
+  ],
+  "favored_percentage_team1": 75,
+  "favored_percentage_text": "team percentage text",
+  "team1": {
+    "name": "Team A Default",
+    "tag": "TAG-A",
+    "flag": "US",
+    "logo": "logofilename",
+    "players": {
+      "76561197996413459": "PlayerAName1",
+      "76561197996426756": "PlayerAName2",
+      "76561197996426757": "PlayerAName3",
+      "76561197996426758": "PlayerAName4",
+      "76561197996426759": "PlayerAName5"
+    },
+    "coaches": {
+      "76561197996426735": "CoachAName1",
+      "76561197946789735": "CoachAName2"
+    },
+    "matchtext": "Defending Champions"
+  },
+  "team2": {
+    "fromfile": "addons/sourcemod/configs/get5/tests/team2.json"
+  },
+  "spectators": {
+    "name": "Spectator Team Name",
+    "players": {
+      "76561197996426761": "SpectatorName1"
+    }
+  }
+}

configs/get5/tests/default_valid_team1t.json

@@ -0,0 +1,30 @@
+{
+  "num_maps": 3,
+  "skip_veto": true,
+  "map_sides": [
+    "team1_ct",
+    "team1_t",
+    "knife"
+  ],
+  "maplist": [
+    "de_mirage",
+    "de_dust2",
+    "de_inferno"
+  ],
+  "team1": {
+    "name": "Team A Start T",
+    "flag": "NO",
+    "matchtext": "GG T WIN",
+    "logo": "start_t_logo",
+    "series_score": 1,
+    "players": {
+      "STEAM_0:1:52245092": "PlayerName"
+    }
+  },
+  "team2": {
+    "name": "Team B",
+    "players": [
+      "STEAM_1:1:46796472"
+    ]
+  }
+}

configs/get5/tests/fromfile_maplist_empty.json

@@ -0,0 +1,18 @@
+{
+  "num_maps": 3,
+  "maplist": {
+    "fromfile": "addons/sourcemod/configs/get5/tests/maplist_empty.json"
+  },
+  "team1": {
+    "name": "Team A",
+    "players": {
+      "STEAM_0:1:52245092": "PlayerName"
+    }
+  },
+  "team2": {
+    "name": "Team B",
+    "players": [
+      "STEAM_1:1:46796472"
+    ]
+  }
+}

configs/get5/tests/fromfile_maplist_empty_string.json

@@ -0,0 +1,18 @@
+{
+  "num_maps": 3,
+  "maplist": {
+    "fromfile": ""
+  },
+  "team1": {
+    "name": "Team A",
+    "players": {
+      "STEAM_0:1:52245092": "PlayerName"
+    }
+  },
+  "team2": {
+    "name": "Team B",
+    "players": [
+      "STEAM_1:1:46796472"
+    ]
+  }
+}

configs/get5/tests/fromfile_maplist_invalid.cfg

@@ -0,0 +1,20 @@
+"Match"
+{
+    "num_maps"        "3"
+    "maplist"
+    {
+        "fromfile" "addons/sourcemod/configs/get5/tests/maplist_invalid.cfg"
+    }
+    "team1"
+    {
+        "name"        "Team A"
+        "players"
+        {
+            "STEAM_0:1:52245092"        "PlayerName"
+        }
+    }
+    "team2"
+    {
+        "fromfile" "addons/sourcemod/configs/get5/tests/team2.cfg"
+    }
+}

configs/get5/tests/fromfile_maplist_not_array.json

@@ -0,0 +1,18 @@
+{
+  "num_maps": 3,
+  "maplist": {
+    "fromfile": "addons/sourcemod/configs/get5/tests/maplist_invalid_not_array.json"
+  },
+  "team1": {
+    "name": "Team A",
+    "players": {
+      "STEAM_0:1:52245092": "PlayerName"
+    }
+  },
+  "team2": {
+    "name": "Team B",
+    "players": [
+      "STEAM_1:1:46796472"
+    ]
+  }
+}

configs/get5/tests/fromfile_maplist_not_found.json

@@ -0,0 +1,18 @@
+{
+  "num_maps": 3,
+  "maplist": {
+    "fromfile": "addons/sourcemod/configs/get5/tests/maplist_not_found.json"
+  },
+  "team1": {
+    "name": "Team A",
+    "players": {
+      "STEAM_0:1:52245092": "PlayerName"
+    }
+  },
+  "team2": {
+    "name": "Team B",
+    "players": [
+      "STEAM_1:1:46796472"
+    ]
+  }
+}

configs/get5/tests/fromfile_maplist_valid.cfg

@@ -0,0 +1,20 @@
+"Match"
+{
+    "num_maps"        "3"
+    "maplist"
+    {
+        "fromfile" "addons/sourcemod/configs/get5/tests/maplist_valid.cfg"
+    }
+    "team1"
+    {
+        "name"        "Team A"
+        "players"
+        {
+            "STEAM_0:1:52245092"        "PlayerName"
+        }
+    }
+    "team2"
+    {
+        "fromfile" "addons/sourcemod/configs/get5/tests/team2.cfg"
+    }
+}