Merge branch 'main' into feat/overhaul-mod-loading-locations

.github/dependabot.yml

@@ -0,0 +1,9 @@
+# Configures dependabot
+
+version: 2
+updates:
+  # GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"

.github/labeler.yml

@@ -0,0 +1,9 @@
+# Add 'needs code review' label to any changes within the entire repository
+needs code review:
+- changed-files:
+  - any-glob-to-any-file: '**'
+
+# Add 'needs testing' label to any changes within the entire repository
+needs testing:
+- changed-files:
+  - any-glob-to-any-file: '**'

.github/pull_request_template.md

@@ -16,3 +16,11 @@ Note that commit messages in PRs will generally be squashed to keep commit histo
 -->
 
 Replace this line with a description of your change (and screenshots/screenrecordings if applicable).
+
+### Code review:
+
+Replace this line with anything specific to look out for during code reviews.
+
+### Testing:
+
+Replace this line with instructions on how to test your pull request. The more detailed, the easier it is for reviewers to test, the faster your PR gets merged.

.github/workflows/auto-label-pr.yml

@@ -0,0 +1,14 @@
+name: Auto-Labeler
+on:
+  pull_request_target:
+    types:
+      - opened
+
+jobs:
+  labeler:
+    permissions:
+      contents: read
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/labeler@v5

.github/workflows/ci.yml

@@ -24,7 +24,7 @@ jobs:
       - name: Setup msvc
         uses: ilammy/msvc-dev-cmd@v1
       - name: Configure cmake
-        run: cmake -G "Ninja" -DCMAKE_BUILD_TYPE:STRING="${{ env.BUILD_PROFILE }}"
+        run: cmake -G "Ninja" -B build -DCMAKE_BUILD_TYPE:STRING="${{ env.BUILD_PROFILE }}"
       - name: Setup resource file version
         shell: bash
         run: |
@@ -33,7 +33,7 @@ jobs:
           FILEVERSION=$(echo ${{ env.NORTHSTAR_VERSION }} | tr '.' ',' | sed -E 's/-rc[0-9]+//' | tr -d '[:alpha:]')
           sed -i "s/0,0,0,1/${FILEVERSION}/g" primedev/ns_version.h
       - name: Build
-        run: cmake --build .
+        run: cmake --build build/
       - name: Extract Short Commit Hash
         id: extract
         shell: bash
@@ -43,13 +43,13 @@ jobs:
         with:
           name: NorthstarLauncher-${{ matrix.config.name }}-${{ steps.extract.outputs.commit }}
           path: |
-            game/
+            build/game/
 
   format-check:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
-    - uses: DoozyX/clang-format-lint-action@v0.16.2
+    - uses: DoozyX/clang-format-lint-action@v0.18.2
       with:
         source: 'primedev'
         exclude: 'primedev/include primedev/thirdparty primedev/wsockproxy'

.github/workflows/release.yml

@@ -21,7 +21,7 @@ jobs:
       - name: Setup msvc
         uses: ilammy/msvc-dev-cmd@v1
       - name: Configure cmake
-        run: cmake -G "Ninja" -DCMAKE_BUILD_TYPE:STRING="Release"
+        run: cmake -G "Ninja" -B build -DCMAKE_BUILD_TYPE:STRING="Release"
       - name: Setup resource file version
         shell: bash
         run: |
@@ -30,22 +30,22 @@ jobs:
           FILEVERSION=$(echo ${{ env.NORTHSTAR_VERSION }} | tr '.' ',' | sed -E 's/-rc[0-9]+//' | tr -d '[:alpha:]')
           sed -i "s/0,0,0,1/${FILEVERSION}/g" primedev/ns_version.h
       - name: Build
-        run: cmake --build .
+        run: cmake --build build/
       - name: Upload launcher build as artifact
         uses: actions/upload-artifact@v3
         with:
           name: northstar-launcher
           path: |
-            game/*.exe
-            game/*.dll
-            game/bin/x64_retail/*.dll
+            build/game/*.exe
+            build/game/*.dll
+            build/game/bin/x64_retail/*.dll
       - name: Upload debug build artifact
         uses: actions/upload-artifact@v3
         with:
           name: launcher-debug-files
           path: |
-            game/*.pdb
-            game/bin/x64_retail/*.pdb
+            build/game/*.pdb
+            build/game/bin/x64_retail/*.pdb
 
   upload-launcher-to-release:
     if: startsWith(github.ref, 'refs/tags/v')

.gitignore

@@ -18,7 +18,7 @@ mono_crash.*
 
 # CMake output
 out/
-game/
+build/game/
 build/
 CMakeFiles/
 cmake_install.cmake

BUILD.md

@@ -37,18 +37,18 @@ Developers who can work a command line may be interested in using [Visual Studio
 
 - Follow the same steps as above for Visual Studio Build Tools, but instead of opening in Visual Studio, run the Command Prompt for VS 2022 and navigate to the NorthstarLauncher.
 
-- Run `cmake . -G "Ninja"` to generate build files.
+- Run `cmake . -G "Ninja" -B build` to generate build files.
 
-- Run `cmake --build .` to build the project.
+- Run `cmake --build build/` to build the project.
 
 ## Linux
 ### Steps
 1. Clone the GitHub repo
 2. Use `cd` to navigate to the cloned repo's directory
 3. Then, run the following commands in order:
 * `docker build --rm -t northstar-build-fedora .`
-* `docker run --rm -it -e CC=cl -e CXX=cl --mount type=bind,source="$(pwd)",destination=/build northstar-build-fedora cmake . -DCMAKE_BUILD_TYPE=Release -DCMAKE_SYSTEM_NAME=Windows -G "Ninja"`
-* `docker run --rm -it -e CC=cl -e CXX=cl --mount type=bind,source="$(pwd)",destination=/build northstar-build-fedora cmake --build .`
+* `docker run --rm -it -e CC=cl -e CXX=cl --mount type=bind,source="$(pwd)",destination=/build northstar-build-fedora cmake . -DCMAKE_BUILD_TYPE=Release -DCMAKE_SYSTEM_NAME=Windows -G "Ninja" -B build`
+* `docker run --rm -it -e CC=cl -e CXX=cl --mount type=bind,source="$(pwd)",destination=/build northstar-build-fedora cmake --build build/`
 
 #### Podman
 
@@ -57,5 +57,5 @@ When using [`podman`](https://podman.io/) instead of Docker on an SELinux enable
 As such the corresponding commands are
 
 * `podman build --rm -t northstar-build-fedora .`
-* `podman run --rm -it -e CC=cl -e CXX=cl --mount type=bind,source="$(pwd)",destination=/build,z northstar-build-fedora cmake . -DCMAKE_BUILD_TYPE=Release -DCMAKE_SYSTEM_NAME=Windows -G "Ninja"`
-* `podman run --rm -it -e CC=cl -e CXX=cl --mount type=bind,source="$(pwd)",destination=/build,z northstar-build-fedora cmake --build .`
+* `podman run --rm -it -e CC=cl -e CXX=cl --mount type=bind,source="$(pwd)",destination=/build,z northstar-build-fedora cmake . -DCMAKE_BUILD_TYPE=Release -DCMAKE_SYSTEM_NAME=Windows -G "Ninja" -B build`
+* `podman run --rm -it -e CC=cl -e CXX=cl --mount type=bind,source="$(pwd)",destination=/build,z northstar-build-fedora cmake --build build/`

Dockerfile

@@ -1,18 +1,18 @@
 FROM registry.fedoraproject.org/fedora-toolbox:38
 RUN dnf update -y && \
     dnf install -y \
-    	git \
-    	wine \
-	wine-mono \
-	python3 \
-	msitools \
-	python3-simplejson \
-	python3-six \
-	cmake \
-	ninja-build \
-	make \
-	samba \
-	libunwind && \
+        git \
+        wine \
+        wine-mono \
+        python3 \
+        msitools \
+        python3-simplejson \
+        python3-six \
+        cmake \
+        ninja-build \
+        make \
+        samba \
+        libunwind && \
     dnf clean all && \
     mkdir /opt/msvc/ /build
 

README.md

@@ -9,4 +9,6 @@ Check [BUILD.md](BUILD.md) for instructions on how to compile, you can also down
 
 ## Format
 
+For project coding standards check out [STANDARDS.md](STANDARDS.md).
+
 This project uses [clang-format](https://clang.llvm.org/docs/ClangFormat.html), make sure you run `clang-format -i --style=file --exclude=primedev/include primedev/*.cpp primedev/*.h` when opening a Pull Request. Check the tool's website for instructions on how to integrate it with your IDE.

STANDARDS.md

@@ -0,0 +1,53 @@
+# Code standards
+
+There are exceptions, ask for them!
+
+### Preamble
+
+You are more than welcome to reformat any existing files using these rules should they fail to match them but please SPLIT your formatting changes from the rest by making a separate PR!
+
+### General rules
+
+> Basic rules that apply all the time.
+
+Always assert your assumptions!
+
+Use PascalCase for all names.
+
+Suffix structs with `_t`.
+
+Prefix classes with `C` (class) and `I` (abstract class).
+
+Prefix all class member variables with `m_`.
+
+Prefixes `g_` for global variables and `s_` for static variables are welcome.
+
+For hooking we use `o_<function name>` for function pointers pointing to the original implementation and `h_<function name>` for functions we replace them with.
+
+Document all function implementations and their arguments (if the argument is self explanatory you don't need to document it) valve style:
+```
+//-----------------------------------------------------------------------------
+// Purpose: MH_MakeHook wrapper
+// Input  : *ppOriginal - Original function being detoured
+//          pDetour - Detour function
+// Output : true on success, false otherwise
+//-----------------------------------------------------------------------------
+```
+
+Don't overcomment your code unless nescessary, expect the reader to have limited knowledge.
+
+Use `FIXME` comments for possible improvements/issues, `NOTE` for important information one might want to look into.
+
+### Valve source files
+
+> Rules that apply to all files from original valve code base.
+
+When adding or just modifying a file that's present in valve source place it where valve put it.
+
+Always use hungarian notation in these files.
+
+### New files
+
+> Rules that apply to Respawn or our own files.
+
+When adding new files follow the general rules, you don't have to use hungarian notation. Put the file where you think it makes the most sense.

primedev/Northstar.cmake

@@ -69,6 +69,7 @@ add_library(
     "engine/r2engine.cpp"
     "engine/r2engine.h"
     "engine/runframe.cpp"
+    "game/client/clientmode_shared.cpp"
     "logging/crashhandler.cpp"
     "logging/crashhandler.h"
     "logging/logging.cpp"
@@ -151,7 +152,6 @@ add_library(
     "squirrel/squirrelautobind.cpp"
     "squirrel/squirrelautobind.h"
     "squirrel/squirrelclasstypes.h"
-    "squirrel/squirreldatatypes.h"
     "util/printcommands.cpp"
     "util/printcommands.h"
     "util/printmaps.cpp"
@@ -162,6 +162,23 @@ add_library(
     "util/version.h"
     "util/wininfo.cpp"
     "util/wininfo.h"
+    "vscript/languages/squirrel_re/include/squirrel.h"
+    "vscript/languages/squirrel_re/squirrel/sqarray.h"
+    "vscript/languages/squirrel_re/squirrel/sqclosure.h"
+    "vscript/languages/squirrel_re/squirrel/sqcompiler.h"
+    "vscript/languages/squirrel_re/squirrel/sqfunctionproto.h"
+    "vscript/languages/squirrel_re/squirrel/sqlexer.h"
+    "vscript/languages/squirrel_re/squirrel/sqobject.h"
+    "vscript/languages/squirrel_re/squirrel/sqopcodes.h"
+    "vscript/languages/squirrel_re/squirrel/sqstate.h"
+    "vscript/languages/squirrel_re/squirrel/sqstring.h"
+    "vscript/languages/squirrel_re/squirrel/sqstruct.h"
+    "vscript/languages/squirrel_re/squirrel/sqtable.h"
+    "vscript/languages/squirrel_re/squirrel/squserdata.h"
+    "vscript/languages/squirrel_re/squirrel/sqvector.h"
+    "vscript/languages/squirrel_re/squirrel/sqvm.h"
+    "vscript/languages/squirrel_re/vsquirrel.h"
+    "vscript/vscript.h"
     "windows/libsys.cpp"
     "windows/libsys.h"
     "dllmain.cpp"