Merge pull request #12 from monkeyman192/update/147323

Update for 147323 and test for pipeline changes

Author: monkeyman192

.github/scripts/version_check.sh

@@ -3,6 +3,12 @@
 # This script is copied directly from https://github.com/MathieuMoalic/action-python-package-new-version/blob/main/entrypoint.sh
 # This is just until there is extra functionality as part of that repo to allow specifying a different index.
 
+########## helper ##########
+error_exit() {
+    echo "Error: $1" >&2
+    exit 1
+}
+
 # Check if pyproject.toml exists
 PYPROJECT_FILE=pyproject.toml
 
@@ -18,15 +24,15 @@ fi
 echo "Version is $VERSION"
 
 # Step 2: Get package name from pyproject.toml
-PACKAGE_NAME=$(awk -F'=' '/^name/ {gsub(/[" ]/, "", $2); print $2}' "$PYPROJECT_FILE")
+PACKAGE_NAME=$(awk -F'=' '/^name/ {gsub(/[" ]/, "", $2); print $2;exit;}' "$PYPROJECT_FILE")
 if [ -z "$PACKAGE_NAME" ]; then
     error_exit "Unable to extract package name from $PYPROJECT_FILE"
 fi
-echo "PACKAGE_NAME is $PACKAGE_NAME"
+echo "PACKAGE_NAME is ${PACKAGE_NAME}..."
 
 # Step 3: Get latest release version from PyPI
 INDEX="${PYPI_INDEX:-pypi.org}"
-PUBLISHED_VERSIONS=$(curl -s "https://$INDEX/pypi/$PACKAGE_NAME/json" | jq -r '.releases | keys | .[]')
+PUBLISHED_VERSIONS=$(curl -s "https://${INDEX}/pypi/${PACKAGE_NAME}/json" | jq -r '.releases | keys | .[]')
 
 if [ -z "$PUBLISHED_VERSIONS" ]; then
     error_exit "Unable to retrieve published version from $INDEX for $PACKAGE_NAME"
@@ -44,5 +50,5 @@ done
 
 echo "PUBLISHING is $PUBLISHING"
 echo "PUBLISHING=$PUBLISHING" >> $GITHUB_ENV
-echo "PUBLISHING_${INDEX/./_}=$PUBLISHING" >> $GITHUB_ENV
+echo "PUBLISHING_${INDEX//./_}=$PUBLISHING" >> $GITHUB_ENV
 echo "PACKAGE_VERSION=$VERSION" >> $GITHUB_ENV

.github/workflows/pipeline.yml

@@ -34,8 +34,8 @@ jobs:
         run: uv build
       - name: Lint and format code
         run: |
-          uv run ruff check ./nmspy
-          uv run ruff format --check ./nmspy
+          uv run ruff check ./nmspy ./example_mods
+          uv run ruff format --check ./nmspy ./example_mods
           uv run python -m twine check ./dist/*
       - name: Upload Wheels
         uses: actions/upload-artifact@v4
@@ -48,8 +48,9 @@ jobs:
       - build_test
     runs-on: ubuntu-latest
     outputs:
-      should_release_pypi: ${{ steps.whether_to_release_pypi.outputs.should_release_pypi}}
-      should_release_test_pypi: ${{ steps.whether_to_release_test_pypi.outputs.should_release_pypi_test}}
+      package_version: ${{ steps.set_version.outputs.package_version }}
+      should_release_pypi: ${{ steps.whether_to_release_pypi.outputs.should_release_pypi }}
+      should_release_test_pypi: ${{ steps.whether_to_release_test_pypi.outputs.should_release_pypi_test }}
     permissions:
       id-token: write  # IMPORTANT: this permission is required to write to github envs
     steps:
@@ -63,6 +64,9 @@ jobs:
         run: |
           export PYPI_INDEX=test.pypi.org
           ./.github/scripts/version_check.sh
+      - name: Globalise determined version
+        id: set_version
+        run: echo "package_version=${{ env.PACKAGE_VERSION }}" >> "$GITHUB_OUTPUT"
       - name: Assign whether to release to pypi to output
         id: whether_to_release_pypi
         run: echo "should_release_pypi=${{ env.PUBLISHING_pypi_org }}" >> "$GITHUB_OUTPUT"
@@ -71,8 +75,12 @@ jobs:
         run: echo "should_release_test_pypi=${{ env.PUBLISHING_test_pypi_org }}" >> "$GITHUB_OUTPUT"
   release:
     name: Release NMSpy wheels and source build to PyPI
-    # Only run this job if we merge into master, we need to do a release, and we don't specifically have some tag to skip publishing to pypi.
-    if: ${{ github.ref == 'refs/heads/master' && needs.release_check.outputs.should_release_pypi == 'true' && !startsWith(github.event.head_commit.message, '[skip pypi]') }}
+    # Only run this job if the following conditions are met:
+    # 1. We merge into master.
+    # 2. We need to do a release.
+    # 3. The commit message doesn't start with [skip pypi].
+    # 4. The version isn't a dev version.
+    if: ${{ github.ref == 'refs/heads/master' && needs.release_check.outputs.should_release_pypi == 'true' && !startsWith(github.event.head_commit.message, '[skip pypi]') && !contains(needs.release_check.outputs.package_version, 'dev') }}
     needs:
       - build_test
       - release_check

example_mods/gravityManipulator.py

@@ -1,10 +1,26 @@
+# /// script
+# dependencies = ["pymhf[gui]>=0.1.14"]
+#
+# [tool.pymhf]
+# exe = "NMS.exe"
+# steam_gameid = 275850
+# start_paused = false
+#
+# [tool.pymhf.gui]
+# always_on_top = true
+#
+# [tool.pymhf.logging]
+# log_dir = "."
+# log_level = "info"
+# window_name_override = "NMS Example gravity manipulator"
+# ///
+
 import logging
 import ctypes
 from dataclasses import dataclass, field
 
+from pymhf import Mod, ModState
 from pymhf.core.hooking import on_key_pressed
-from pymhf.core.mod_loader import ModState
-from pymhf import Mod
 from pymhf.gui import FLOAT
 import nmspy.data.types as nms
 
@@ -25,9 +41,8 @@ class gravityManipulator(Mod):
     # General "Nice To Have"s
     __author__ = ["ThatBomberBoi", "monkeyman192"]
     __description__ = "Gravity Manipulator"
-    __version__ = "0.2"
-    __NMSPY_required_version__ = "0.7.0"
-    
+    __version__ = "0.3"
+
     # Create an instance of the persistant ModState Class in your mod class.
     state = gravModState()
 
@@ -44,7 +59,7 @@ def gravMult(self):
     # Used to actually update the persisted value with the one input by the user in the GUI.
     @gravMult.setter
     def gravMult(self, value):
-        self.state.gravity = value 
+        self.state.gravity = value
 
     # Functions are hooked by specifying the function to be hooked from the list of in game functions
     # available. You can specify whether you want your detour to run either before or after the original
@@ -67,4 +82,6 @@ def modifyGravity(self):
             # Call an in-game function directly from your mod code.
             # You will need to provide the arguments for the in-game function
             planet.UpdateGravity(self.state.gravity)
-        logger.info(f"Set Planetary Gravity Multiplier To {self.state.gravity} For All Planets") 
+        logger.info(
+            f"Set Planetary Gravity Multiplier To {self.state.gravity} For All Planets"
+        )

nmspy/data/audiokinetic.py

@@ -0,0 +1,42 @@
+# pyright: reportReturnType=false
+# pyright: reportArgumentType=false
+
+# NMS uses AudioKinetic as a 3rd party audio library.
+# This exposes a number of useful functions relating to audio.
+# These functions are all the direct AK functions which are provided as exports by the binary.
+
+import ctypes
+
+from pymhf.core.hooking import Structure, static_function_hook
+
+
+class AK(Structure):
+    class SoundEngine(Structure):
+        @static_function_hook(
+            exported_name="?RegisterGameObj@SoundEngine@AK@@YA?AW4AKRESULT@@_KPEBD@Z"
+        )
+        @staticmethod
+        def RegisterGameObj(
+            in_GameObj: ctypes.c_uint64,
+            in_pszObjName: ctypes.c_uint64,
+        ) -> ctypes.c_int64:
+            pass
+
+        @static_function_hook(
+            exported_name=(
+                "?PostEvent@SoundEngine@AK@@YAII_KIP6AXW4AkCallbackType@@PEAUAkCallbackInfo@@@ZPEAXIPEAUAkExt"
+                "ernalSourceInfo@@I@Z"
+            )
+        )
+        @staticmethod
+        def PostEvent(
+            in_ulEventID: ctypes.c_uint32,
+            in_GameObjID: ctypes.c_uint64,
+            in_uiFlags: ctypes.c_uint32 = 0,
+            callback: ctypes.c_uint64 = 0,
+            in_pCookie: ctypes.c_void_p = 0,
+            in_cExternals: ctypes.c_uint32 = 0,
+            in_pExternalSources: ctypes.c_uint64 = 0,
+            in_PlayingID: ctypes.c_uint32 = 0,
+        ) -> ctypes.c_uint64:
+            pass

nmspy/data/types.py

@@ -373,7 +373,7 @@ def CheckFallenThroughFloor(self, this: "ctypes._Pointer[cGcPlayer]"):
         pass
 
     @function_hook(
-        "48 8B C4 48 89 58 ?? 4C 89 48 ?? 44 89 40 ?? 55 56 57 41 54 41 55 41 56 41 57 48 8D A8"
+        "48 8B C4 48 89 58 ? 44 89 40 ? 55 56 57 41 54 41 55 41 56 41 57 48 8D A8 ? ? ? ? 48 81 EC ? ? ? ? 4C 8B 35"
     )
     def TakeDamage(
         self,

pyproject.toml

@@ -1,7 +1,8 @@
 [project]
 name = "NMSpy"
 description = "No Man's Sky python modding API"
-requires-python = ">=3.9"
+readme = "README.md"
+requires-python = ">=3.9, <3.12"
 # TODO: Add
 license = {file = "LICENSE.md"}
 keywords = ["hooking", "games", "hacking", "modding"]
@@ -22,9 +23,9 @@ classifiers = [
   "Programming Language :: Python :: 3 :: Only",
 ]
 dependencies = [
-  "pymhf[gui]>=0.1.13"
+  "pymhf[gui]>=0.1.14.dev8"
 ]
-version = "146545.0"
+version = "147323.0.dev1"
 
 [dependency-groups]
 dev = [
@@ -37,6 +38,14 @@ dev = [
 [tool.uv]
 python-preference = "only-system"
 
+[tool.uv.sources]
+pymhf = { index = "pypi_test" }
+
+[[tool.uv.index]]
+name = "pypi_test"
+url = "https://test.pypi.org/simple/"
+explicit = true
+
 [tool.setuptools.package-dir]
 nmspy = "nmspy"
 

tools/data.json

@@ -331,7 +331,7 @@
  },
  {
   "name": "cGcPlayer::TakeDamage",
-  "signature": "48 8B C4 48 89 58 ?? 4C 89 48 ?? 44 89 40 ?? 55 56 57 41 54 41 55 41 56 41 57 48 8D A8",
+  "signature": "48 8B C4 48 89 58 ? 44 89 40 ? 55 56 57 41 54 41 55 41 56 41 57 48 8D A8 ? ? ? ? 48 81 EC ? ? ? ? 4C 8B 35",
   "mangled_name": "?TakeDamage@cGcPlayer@@QEAAXMW4eDamageType@@AEBT?$TkID@$0IA@@@AEBVcTkVector3@@PEAVcGcOwnerConcept@@AEBV?$vector@VcGcCombatEffectDamageMultiplier@@V?$TkSTLAllocatorShim@VcGcCombatEffectDamageMultiplier@@$03$0?0@@@std@@@Z"
  },
  {
@@ -436,7 +436,7 @@
  },
  {
   "name": "cGcPlanet::Generate",
-  "signature": "48 89 5C 24 ? 57 48 83 EC ? 48 8D 91 ? ? ? ? 33 FF",
+  "signature": "48 8B C4 4C 89 40 ? 88 50 ? 55 53",
   "mangled_name": "?Generate@cGcPlanet@@QEAAX_NAEBVcTkVector3@@AEBVcGcDiscoveryData@@AEBVcGcPlanetGenerationInputData@@@Z"
  }
 ]