Release v0.4

.coderabbit.yaml

@@ -0,0 +1,10 @@
+reviews:
+  request_changes_workflow: false
+  high_level_summary: true
+  poem: false
+  review_status: false
+  collapse_walkthrough: false
+  auto_review:
+    enabled: false
+chat:
+  auto_reply: false

.editorconfig

@@ -20,7 +20,7 @@ indent_style = tab
 indent_size = 4
 
 # Json Code Style settings
-[*.{json,vsconfig}]
+[*.json]
 indent_style = space
 indent_size = 2
 
@@ -49,6 +49,9 @@ trim_trailing_whitespace = unset
 indent_style = unset
 indent_size = unset
 
+[.vsconfig]
+generated_code = true
+
 # C++ Code Style settings
 [*.{c++,cc,cpp,cppm,cxx,h,h++,hh,hpp,hxx,inl,ipp,ixx,tlh,tli}]
 

.github/ISSUE_TEMPLATE/feature_enhancement.yml → .github/DISCUSSION_TEMPLATE/ideas-and-feedback.yml

@@ -1,35 +1,18 @@
-name: Feature or Enhancement Suggestion
-description: Open an issue to suggest a feature or an enhancement.
-title: "Your new feature title here"
+title: "Your new feature or enhancement title here"
 labels: ["Feature / Enhancement"]
 body:
   - type: markdown
     attributes:
       value: |
-        *__NOTE:__ Feature requests are usually low-priority unless it's a feature that's supported by a majority of users or some developer has interest in that particular feature. Please understand that Phobos contributors work on the project for fun and are not obliged to implement every suggestion.*
+        > **Warning**
+        > Before posting a suggestion, please read the **checklist at the bottom**.
 
         Thanks for taking the time to submit out this feature suggestion! If you wish to discuss the feature in detail first, join us on the [C&C Mod Haven Discord](https://discord.gg/an3bDxtksM) server in the __#phobos-chat__ channel.
 
         Please make sure you follow these instructions and fill in every question with as much detail as possible.
 
-  - type: checkboxes
-    id: checks
-    attributes:
-      label: First check
-      description: Please confirm and check all the following options;
-      options:
-        - label: The suggestion is **NOT** related to functionality of Ares, HAres, Kratos or any other YR engine extension.
-          required: true
-        - label: The suggested feature / enhancement is **NOT** implemented in Ares/Phobos yet and the existing possibilites are not viable or good enough to achieve the wanted result.
-          required: true
-        - label: I agree to elaborate the details if requested and provide thorough testing if the feature is implemented.
-          required: true
-        - label: I added a very descriptive title to this issue.
-          required: true
-        - label: I used the GitHub search and read the issue list to find a similar issue and didn't find it.
-          required: true
-        - label: I thought out how the feature / enhancement should work and described it in the most detailed and clear way.
-          required: true
+        > **Note**
+        > Feature requests are usually low-priority unless it's a feature that's supported by a majority of users or some developer has interest in that particular feature. Please understand that Phobos contributors work on the project for fun and are not obliged to implement every suggestion.*
 
   - type: textarea
     id: description
@@ -58,3 +41,22 @@ body:
       label: Additional context
       description: |
         Attach additional files or links to content related to the feature report here (example images, gifs, videos to illustrate the suggestion etc).
+
+  - type: checkboxes
+    id: checks
+    attributes:
+      label: Checklist
+      description: Please read and ensure you followed all the following options.
+      options:
+        - label: The suggestion is **NOT** related to functionality of Ares, HAres, Kratos or any other YR engine extension.
+          required: true
+        - label: The suggested feature / enhancement is **NOT** implemented in Ares/Phobos yet and the existing possibilites are not viable or good enough to achieve the wanted result.
+          required: true
+        - label: I agree to elaborate the details if requested and provide thorough testing if the feature is implemented.
+          required: true
+        - label: I added a very descriptive title to this topic.
+          required: true
+        - label: I used the GitHub search and read the topic list to find a similar topic and didn't find it.
+          required: true
+        - label: I thought out how the feature / enhancement should work and described it in the most detailed and clear way.
+          required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -1,5 +1,8 @@
 blank_issues_enabled: false
 contact_links:
+  - name: Suggest a feature or enhancement
+    url: https://github.com/Phobos-developers/Phobos/discussions/new?category=ideas-and-feedback
+    about: If you want to suggest your idea to the project and/or upvote some idea.
   - name: Official channels on C&C Mod Haven
     url: https://discord.gg/an3bDxtksM
     about: If you want to discuss something with us without filing an issue.

.github/ISSUE_TEMPLATE/phobos_bug_report.yml

@@ -6,27 +6,13 @@ body:
   - type: markdown
     attributes:
       value: |
+        > **Warning**
+        > Before posting a suggestion, please read the **checklist at the bottom**.
+
         Thanks for taking the time to fill out this bug report! If you need real-time help, join us on the [C&C Mod Haven Discord](https://discord.gg/an3bDxtksM) server in the __#phobos-chat__ channel.
 
         Please make sure you follow these instructions and fill in every question with as much detail as possible.
 
-  - type: checkboxes
-    id: checks
-    attributes:
-      label: First check
-      description: Please confirm and check all the following options;
-      options:
-        - label: The issue happens on the **latest official** version of Phobos and wasn't fixed yet.
-          required: true
-        - label: I agree to elaborate the details if requested and provide thorough testing if the bugfix is implemented.
-          required: true
-        - label: I added a very descriptive title to this issue.
-          required: true
-        - label: I used the GitHub search and read the issue list to find a similar issue and didn't find it.
-          required: true
-        - label: I have attached as much information as possible *(screenshots, gifs, videos, debug and exception logs, etc)*.
-          required: true
-
   - type: textarea
     id: description
     attributes:
@@ -106,3 +92,20 @@ body:
         - a savegame file with used mod to reproduce the exact conditions;
         - a debug log, crash dump and exception file (mandatory if you're submitting a crash report);
         - sync logs, crash dumps for all the players (mandatory in case you're submitting a desync report).
+
+  - type: checkboxes
+    id: checks
+    attributes:
+      label: Checklist
+      description: Please read and ensure you followed all the following options.
+      options:
+        - label: The issue happens on the **latest official** version of Phobos and wasn't fixed yet.
+          required: true
+        - label: I agree to elaborate the details if requested and provide thorough testing if the bugfix is implemented.
+          required: true
+        - label: I added a very descriptive title to this issue.
+          required: true
+        - label: I used the GitHub search and read the issue list to find a similar issue and didn't find it.
+          required: true
+        - label: I have attached as much information as possible *(screenshots, gifs, videos, debug and exception logs, etc)*.
+          required: true

.github/ISSUE_TEMPLATE/vanilla_bugfix_request.yml

@@ -6,29 +6,13 @@ body:
   - type: markdown
     attributes:
       value: |
+        > **Warning**
+        > Before posting a suggestion, please read the **checklist at the bottom**.
+
         Thanks for taking the time to fill out this bug report! If you need real-time help, join us on the [C&C Mod Haven Discord](https://discord.gg/an3bDxtksM) server in the __#phobos-chat__ channel.
 
         Please make sure you follow these instructions and fill in every question with as much detail as possible.
 
-  - type: checkboxes
-    id: checks
-    attributes:
-      label: First check
-      description: Please confirm and check all the following options;
-      options:
-        - label: The issue is not introduced by Phobos or any other engine extension, such as Ares, Kratos etc.
-          required: true
-        - label: The issue wasn't fixed in the most recent version of Ares/Phobos yet.
-          required: true
-        - label: I agree to elaborate the details if requested and provide thorough testing if the bugfix is implemented.
-          required: true
-        - label: I added a very descriptive title to this issue.
-          required: true
-        - label: I used the GitHub search and read the issue list to find a similar issue and didn't find it.
-          required: true
-        - label: I have attached as much information as possible *(screenshots, gifs, videos, debug and exception logs, etc)*.
-          required: true
-
   - type: textarea
     id: description
     attributes:
@@ -99,3 +83,22 @@ body:
         - a savegame file with used mod to reproduce the exact conditions;
         - a debug log, crash dump and exception file (mandatory if you're submitting a crash report);
         - sync logs, crash dumps for all the players (mandatory in case you're submitting a desync report).
+
+  - type: checkboxes
+    id: checks
+    attributes:
+      label: Checklist
+      description: Please read and ensure you followed all the following options.
+      options:
+        - label: The issue is not introduced by Phobos or any other engine extension, such as Ares, Kratos etc.
+          required: true
+        - label: The issue wasn't fixed in the most recent version of Ares/Phobos yet.
+          required: true
+        - label: I agree to elaborate the details if requested and provide thorough testing if the bugfix is implemented.
+          required: true
+        - label: I added a very descriptive title to this issue.
+          required: true
+        - label: I used the GitHub search and read the issue list to find a similar issue and didn't find it.
+          required: true
+        - label: I have attached as much information as possible *(screenshots, gifs, videos, debug and exception logs, etc)*.
+          required: true

.github/actions/build-phobos/action.yml

@@ -11,12 +11,9 @@ runs:
   using: "composite"
   steps:
   - name: Add MSBuild to PATH
-    uses: microsoft/setup-msbuild@v1
-
-  - name: Restore NuGet packages
-    working-directory: ${{env.GITHUB_WORKSPACE}}
-    run: nuget restore ${{inputs.sln-path}}
-    shell: cmd
+    uses: microsoft/[email protected]
+    with:
+      vs-version: '[16.0, )'
 
   - uses: ammaraskar/msvc-problem-matcher@master
 
@@ -29,9 +26,9 @@ runs:
 
   - name: Upload Artifact
     if: ${{success()}}
-    uses: actions/upload-artifact@v2
+    uses: actions/upload-artifact@v4
     with:
       name: compiled-dll-${{github.sha}}
       path: |
         ${{inputs.sln-path}}/${{inputs.build-config}}/Phobos.dll
-        ${{inputs.sln-path}}/${{inputs.build-config}}/IntDir/Phobos.pdb
+        ${{inputs.sln-path}}/${{inputs.build-config}}/Phobos.pdb

.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"

.github/workflows/nightly.yml

@@ -23,7 +23,7 @@ jobs:
     runs-on: windows-2019
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
       with:
         submodules: recursive
 

.github/workflows/pr-nightly-comment.yml

@@ -8,33 +8,51 @@ jobs:
     if: github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion == 'success'
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/github-script@v3
+      - name: Get the PR number
+        run: |
+          # Query the issue search API to get the PR associated with it
+          PR_RAW=$(curl 'https://api.github.com/search/issues?q=${{ github.event.workflow_run.head_commit.id }}')
+          # Get the event number from the search results, which will
+          # be the PR number
+          # Filter by PRs only in this repository, as a PR with an identical head commit may be made in another repository (e.g. a fork)
+          # Assume the 0th index in the array of found PRs is the correct one (it seems to usually be the latest one)
+          PR_NUM=$(echo $PR_RAW | jq '.items | map(select(.repository_url=="https://api.github.com/repos/${{ github.repository }}")) | .[0].number')
+          echo "PR_NUM=${PR_NUM}" >> ${GITHUB_ENV}
+
+      - name: Comment on PR
+        uses: actions/github-script@v7
         with:
           # This snippet is public-domain, taken from
           # https://github.com/oprypin/nightly.link/blob/master/.github/workflows/pr-comment.yml
+          # and modified to allow comments on external PRs
           script: |
-            const {owner, repo} = context.repo;
-            const run_id = ${{github.event.workflow_run.id}};
-            const pull_head_sha = '${{github.event.workflow_run.head_sha}}';
-            const pull_user_id = ${{github.event.sender.id}};
+            async function upsertComment(owner, repo, issue_number, purpose, body) {
+              const {data: comments} = await github.rest.issues.listComments(
+                {owner, repo, issue_number});
+
+              const marker = `<!-- bot: ${purpose} -->`;
+              body = marker + "\n" + body;
 
-            const issue_number = await (async () => {
-              const pulls = await github.pulls.list({owner, repo});
-              for await (const {data} of github.paginate.iterator(pulls)) {
-                for (const pull of data) {
-                  if (pull.head.sha === pull_head_sha && pull.user.id === pull_user_id) {
-                    return pull.number;
-                  }
-                }
+              const existing = comments.filter((c) => c.body.includes(marker));
+              if (existing.length > 0) {
+                const last = existing[existing.length - 1];
+                core.info(`Updating comment ${last.id}`);
+                await github.rest.issues.updateComment({
+                  owner, repo,
+                  body,
+                  comment_id: last.id,
+                });
+              } else {
+                core.info(`Creating a comment in issue / PR #${issue_number}`);
+                await github.rest.issues.createComment({issue_number, body, owner, repo});
               }
-            })();
-            if (issue_number) {
-              core.info(`Using pull request ${issue_number}`);
-            } else {
-              return core.error(`No matching pull request found`);
             }
 
-            const {data: {artifacts}} = await github.actions.listWorkflowRunArtifacts({owner, repo, run_id});
+            const {owner, repo} = context.repo;
+            const run_id = ${{github.event.workflow_run.id}};
+
+            const artifacts = await github.paginate(
+              github.rest.actions.listWorkflowRunArtifacts, {owner, repo, run_id});
             if (!artifacts.length) {
               return core.error(`No artifacts found`);
             }
@@ -43,14 +61,8 @@ jobs:
               body += `\n* [${art.name}.zip](https://nightly.link/${owner}/${repo}/actions/artifacts/${art.id}.zip)`;
             }
 
-            body += `\nThis comment is automatic and is meant to allow guests to get latest nightly builds without registering. It is updated on every successful build.`;
+            body += `\nThese artifacts will expire in 90 days and will not be available for download after that time.`;
+            body += `\n\n_This comment is automatic and is meant to allow guests to get latest nightly builds for this pull request without registering. It is updated on every successful build._`;
 
-            const {data: comments} = await github.issues.listComments({repo, owner, issue_number});
-            const existing_comment = comments.find((c) => c.user.login === 'github-actions[bot]');
-            if (existing_comment) {
-              core.info(`Updating comment ${existing_comment.id}`);
-              await github.issues.updateComment({repo, owner, comment_id: existing_comment.id, body});
-            } else {
-              core.info(`Creating a comment`);
-              await github.issues.createComment({repo, owner, issue_number, body});
-            }
+            core.info("Review thread message body:", body);
+            await upsertComment(owner, repo, ${{ env.PR_NUM }}, "nightly-link", body);

.github/workflows/pr-nightly.yml

@@ -19,7 +19,7 @@ jobs:
     runs-on: windows-2019
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
       with:
         submodules: recursive
         # ref: ${{ github.event.pull_request.head.sha }}

.gitignore

@@ -21,3 +21,8 @@ docs/locale/.doctrees/
 /.vscode/c_cpp_properties.json
 /.vscode/cspell.json
 /.vscode/settings.json
+
+build
+cmake-*
+out
+.idea