Change Unknown0x284 in GcBuildingGlobals

.github/CONTRIBUTING.md

@@ -0,0 +1,23 @@
+## Contributing to MBINCompiler
+
+There are a number of ways that anyone can contribute to the development of MBINCompiler, but the main two ways are as follows:
+
+#### Providing Updated versions of structs
+
+Every time Hello Games pushes an update to the game we check to see if there are any structs that have changed. If there have been changes then an issue will be created which has the *Update Info* tag.
+
+If you have some reverse engineering skills you can create a Pull Request which fixes some or all of the structs that were broken by the update.
+
+If your pull request would result in every struct that was changed being fixed (or finishes off the list of structs requiring updating in a given issue), then you should add `closes #XYZ` (where `XYZ` is the number of the issue that should be closed) to the text of the PR.
+
+#### Providing names for unknowns in globals
+
+As of NMS 2.0, HG removed the names of variables in all globals exept for the camera globals. Because of this, we have gone back to having a number of variables which have their effect unknown. This is a great place to start off contributing to MBINCompiler as it doesn't require any reverse engineering knowledge and can be done by simply using cheat engine to try and determine the values.
+
+A number of globals also have some comments in the source code which indicate some suggestions for what the variables *may* do. In this case testing is required to confirm or deny whether the variable is in fact related to what the comment suggests.
+
+### General protocol for opening a Pull Request
+
+ - If you are working on a PR which may end up having a few commits, you can prepend the name of your PR with `[WIP]` to indicate that the PR is not yet complete.
+ - Once you are happy with your PR, the title must be prepended with `[MRG]` to indicate that the PR is ready to go and the review process can take place.
+ - Currently there is no testing done on the MBINCompile code base on a CI service, however this will hopefully come in the future and when it does, no PR will be able to be merged unless it passes any CI tests.

.github/ISSUE_TEMPLATE/-bug-report-.md

@@ -0,0 +1,46 @@
+---
+name: "[Bug Report]"
+about: Create a bug report to submit information about program errors, unpexpected
+  behaviours and other unintended mistakes.
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+_Fill in the details for each relevant section._
+_When you're done, then delete any instructions, example text and irrelevant sections._  
+_Please select the project on the sidebar where you encountered the problem._
+
+**Things to check before you raise an issue**
+- Make sure that you have looked at the log file and determined that the issue is in fact an issue with MBINCompiler, and not an issue with the mxml file being modified incorrect etc.
+- Check to see that an issue has not already been raised of the same manner.
+- If there has been a recent update, check to see for any issues marked `[UPDATE]` to see if the struct you are having issues with is in fact supported yet or not. If not ticked off, please do not post an issue.
+**IMPORTANT**: If there was a recent release and there is no issue with the update info, please do not raise an issue about single broken files. It may take some time for this issue to be created, so please be patient. Opening multiple issues will not help and they will just be closed.
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+Include a summary of the error message if there is one.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Steps To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Specs (please complete the following information, if applicable):**
+ - libMBIN (MBINCompiler) Version: [eg 1.0.0.0]
+ - NMS Game Version or Steam Build Number: [eg 1.0.0.0, or 4154325] (To find the build number, right click on the game in steam, select `Properties`, then click on the `LOCAL FILES` tab and the buildID is at the bottom).
+ - MBIN File: [eg GCPLAYERGLOBALS.GLOBAL.MBIN]
+ - MBIN File Version: [eg 1.0.0.0]
+
+**Additional Information**
+Add any other information here that you think might be helpful.
+
+_Attachments:_
+_Always include the entire log file._
+_Do not attach MBIN files unless requested._

.github/ISSUE_TEMPLATE/-feature-request-.md

@@ -0,0 +1,20 @@
+---
+name: "[Feature Request]"
+about: Suggest an idea for this project.
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/pipeline.yml

@@ -0,0 +1,151 @@
+name: MBINCompiler
+
+on:
+  # Run on all branches except for the gh-pages branch
+  push:
+    paths-ignore:
+      - '*.md'
+    branches-ignore:
+      - 'gh-pages'
+  pull_request:
+    paths-ignore:
+      - '*.md'
+    branches-ignore:
+      - 'gh-pages'
+  create:
+
+jobs:
+  build_test:
+    name: Build artefacts - ${{ matrix.os.name }}/${{ matrix.dotnet.framework }}
+    runs-on: ${{ matrix.os.name }}-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [{name: 'Ubuntu', runtime: 'linux-x64'}, {name: 'Windows', runtime: 'win-x64'}]
+        dotnet: [{framework: 'net6.0', version: '6.0.0'}, {framework: 'net8.0', version: '8.0.0'}]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-dotnet@v5
+        with:
+          # Install both sdk versions.
+          dotnet-version: |
+            6.0.100
+            8.0.100
+      - name: Build ${{ matrix.os.name }}-dotnet ${{ matrix.dotnet }} binaries
+        run: |
+          sed -i '\|<TargetFrameworks>net6.0;net8.0</TargetFrameworks>|a\    <RuntimeFrameworkVersion>${{ matrix.dotnet.version }}</RuntimeFrameworkVersion>' ./MBINCompiler/MBINCompiler.csproj
+          sed -i '\|<TargetFrameworks>net6.0;net8.0</TargetFrameworks>|a\    <RuntimeFrameworkVersion>${{ matrix.dotnet.version }}</RuntimeFrameworkVersion>' ./libMBIN-DLL/libMBIN-DLL.csproj
+          dotnet publish libMBIN-DLL --no-self-contained -c Release -f ${{ matrix.dotnet.framework }} -r ${{ matrix.os.runtime }} /nowarn:cs0618 /nowarn:cs0169 /nowarn:cs0414
+          dotnet publish MBINCompiler --no-self-contained -c Release -f ${{ matrix.dotnet.framework }} -r ${{ matrix.os.runtime }} /nowarn:cs0618 /nowarn:cs0169 /nowarn:cs0414
+      - name: Move the exe so the tests can find it easier
+        run: |
+          cp Build/Release/${{ matrix.dotnet.framework }}/${{ matrix.os.runtime }}/publish/MBINCompiler.exe MBINCompiler.exe
+          cp Build/Release/${{ matrix.dotnet.framework }}/${{ matrix.os.runtime }}/publish/libMBIN.dll libMBIN.dll
+        if: ${{matrix.os.name  == 'Windows' }}
+      - name: Move the exe so the tests can find it easier
+        run: |
+          cp Build/Release/${{ matrix.dotnet.framework }}/${{ matrix.os.runtime }}/publish/MBINCompiler MBINCompiler.exe
+          cp Build/Release/${{ matrix.dotnet.framework }}/${{ matrix.os.runtime }}/publish/libMBIN.dll libMBIN.dll
+        if: ${{matrix.os.name  == 'Ubuntu' }}
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.9"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip uv
+          uv sync
+      - name: Run tests
+        run: uv run python -m pytest --mbincompiler_path="./MBINCompiler.exe" --tb=no --report
+      - name: Upload Windows binaries
+        uses: actions/upload-artifact@v4
+        with:
+          name: MBINCompiler-${{ matrix.os.name }}-${{ matrix.dotnet.framework }}
+          path: |
+            MBINCompiler.exe
+            libMBIN.dll
+        if: ${{matrix.os.name  == 'Windows' }}
+      - name: Upload Linux binaries
+        uses: actions/upload-artifact@v4
+        with:
+          name: MBINCompiler-${{ matrix.os.name }}-${{ matrix.dotnet.framework }}
+          path: |
+            MBINCompiler.exe
+            MBINCompiler.dll
+            libMBIN.dll
+        if: ${{matrix.os.name  == 'Ubuntu' }}
+      - name: Upload report
+        uses: actions/upload-artifact@v4
+        with:
+          name: MBINCompiler-report
+          path: report.json
+        if: ${{matrix.os.name  == 'Windows' && matrix.dotnet.framework == 'net6.0'}}
+  save_mapping:
+    name: Build save file mapping and generate mapping
+    runs-on: Windows-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Build SaveFileMapping binary
+        run: dotnet publish SaveFileMapping -c Release -f net8.0 -r win-x64 -o Build/Release/net8/ /nowarn:cs0618 /nowarn:cs0169 /nowarn:cs0414
+      - name: Generate save data mapping
+        run : Build/Release/net8/SaveFileMapping.exe
+        shell: bash
+      - name: Upload report
+        uses: actions/upload-artifact@v4
+        with:
+          name: savedata-mapping
+          path: mapping.json
+  release:
+    name: Release MBINCompiler binaries and other data
+    # Only run this job if the commit was tagged.
+    if: ${{ startsWith(github.ref, 'refs/tags/') }}
+    runs-on: windows-latest
+    needs: [build_test, save_mapping]
+    steps:
+      - name: Download files for release
+        uses: actions/download-artifact@v4
+      - name: Rename files for release
+        run: |
+          mv MBINCompiler-Windows-net6.0/MBINCompiler.exe MBINCompiler-dotnet6.exe
+          mv MBINCompiler-Windows-net6.0/libMBIN.dll libMBIN-dotnet6.dll
+          mv MBINCompiler-Windows-net8.0/MBINCompiler.exe MBINCompiler.exe
+          mv MBINCompiler-Windows-net8.0/libMBIN.dll libMBIN.dll
+          mv MBINCompiler-Ubuntu-net6.0/MBINCompiler.exe MBINCompiler-linux-dotnet6
+          mv MBINCompiler-Ubuntu-net6.0/libMBIN.dll libMBIN-linux-dotnet6.so
+          mv MBINCompiler-Ubuntu-net8.0/MBINCompiler.exe MBINCompiler-linux
+          mv MBINCompiler-Ubuntu-net8.0/libMBIN.dll libMBIN-linux.so
+          mv savedata-mapping/mapping.json mapping.json
+          mv MBINCompiler-report/report.json report.json
+      - name: Get MBINCompiler tag version
+        run: |
+          echo "VERSION=$(./MBINCompiler.exe version | awk '{print $2}')" >> $GITHUB_ENV
+          echo "TAG=${GITHUB_REF/refs\/tags\//}" >> $GITHUB_ENV
+        shell: bash
+      - name: Upload resources if version matches
+        if: env.VERSION == env.TAG
+        uses: softprops/action-gh-release@v2
+        with:
+          name: "${{ env.TAG }}"
+          tag_name: ${{ env.TAG }}
+          prerelease: true
+          files: |
+            MBINCompiler.exe
+            libMBIN.dll
+            MBINCompiler-dotnet6.exe
+            libMBIN-dotnet6.dll
+            MBINCompiler-linux
+            libMBIN-linux.so
+            MBINCompiler-linux-dotnet6
+            libMBIN-linux-dotnet6.so
+            report.json
+            mapping.json
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Check if tag doesn't match version
+        if: env.VERSION != env.TAG
+        run: |
+          echo "There is a version mismatch between the tag and MBINCompiler version!"
+          echo "MBINCompiler version: ${{ env.VERSION }}"
+          echo "Tag version: ${{ env.TAG }}"
+          exit 1
+        shell: bash

.gitignore

@@ -254,4 +254,31 @@ paket-files/
 
 # CodeRush
 .cr/
-/MBINCompilerTests/app.config
+*.manifest
+
+**/launchSettings.json
+/.nuget/
+
+# python-related files
+*.pyc
+.pytest_cache/
+.venv/
+
+# test data
+tests/**/*.MBIN
+tests/**/.version
+tests/**/_*.txt
+tests/data/*
+report.json
+results.txt
+
+# Auto-generated documentation
+docs/classes/
+html_docs/
+
+# auto-extraction script output
+Tools/auto_extract/output/**/*.cs
+Tools/auto_extract/*.projitems
+Tools/auto_extract/summary.txt
+Tools/auto_extract/extract.cfg
+Tools/auto_extract/guids_*.json

.vscode/launch.json

@@ -0,0 +1,24 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": ".NET Core Launch (console)",
+            "type": "coreclr",
+            "request": "launch",
+            "preLaunchTask": "build",
+            "program": "${workspaceFolder}/Build/Debug/net6.0/MBINCompiler.dll",
+            "args": [],
+            "cwd": "${workspaceFolder}/MBINCompiler",
+            "console": "internalConsole",
+            "stopAtEntry": false
+        },
+        {
+            "name": ".NET Core Attach",
+            "type": "coreclr",
+            "request": "attach"
+        }
+    ]
+}

.vscode/tasks.json

@@ -0,0 +1,41 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "build",
+            "command": "dotnet",
+            "type": "process",
+            "args": [
+                "build",
+                "${workspaceFolder}/MBINCompiler.sln",
+                "/property:GenerateFullPaths=true",
+                "/consoleloggerparameters:NoSummary;ForceNoAlign"
+            ],
+            "problemMatcher": "$msCompile"
+        },
+        {
+            "label": "publish",
+            "command": "dotnet",
+            "type": "process",
+            "args": [
+                "publish",
+                "${workspaceFolder}/MBINCompiler.sln",
+                "/property:GenerateFullPaths=true",
+                "/consoleloggerparameters:NoSummary;ForceNoAlign"
+            ],
+            "problemMatcher": "$msCompile"
+        },
+        {
+            "label": "watch",
+            "command": "dotnet",
+            "type": "process",
+            "args": [
+                "watch",
+                "run",
+                "--project",
+                "${workspaceFolder}/MBINCompiler.sln"
+            ],
+            "problemMatcher": "$msCompile"
+        }
+    ]
+}