Updated to pymhf 0.1.15 and added some extra functions and example mod

Author: monkeyman192

README.md

@@ -7,7 +7,7 @@ It should also be noted that Game updates can very easily break mods utilising N
 Any responsibility for broken saves is entirely on the users of this library.
 
 Also note that this library will never contain functions relating to online functionality to avoid any abuse.
-The author of this library condones any use of this for any usage that is detrimental to other players.
+The author of this library condones any use of this code for any purpose that is directly detrimental to other players.
 
 ## Installation
 
@@ -23,7 +23,8 @@ To run NMS.py, enter the following command into a terminal:
 pymhf run nmspy
 ```
 
-This will display some config options to complete. The only option to consider is the location of the mods folder. It is recommended that you create a new folder inside the normal MODS folder which can contain all the python scripts you want to be run.
+This will display some config options to complete. The only option to consider is the location of the mods folder. It is recommended that you specify the `MODS` folder inside the `GAMEDATA` folder as your mod directory (ie. the same one you put normal mods in).
+All mods will be placed in either this folder, or in a chcild folder of this. You can essentially think of any mod using NMS.py being able to be "installed" in the same way you would any other normal mod.
 
 If NMS.py starts up successfully you should see two extra windows; an auto-created GUI from pyMHF, and a terminal window which will show the logs for pyMHF.
 

example_mods copy/audio_test_mod.py

@@ -0,0 +1,132 @@
+# /// script
+# dependencies = ["pymhf[gui]>=0.1.13"]
+#
+# [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 audio thing"
+# ///
+from __future__ import annotations
+
+import ctypes
+import logging
+from dataclasses import dataclass
+
+from pymhf import Mod, ModState
+from pymhf.core.hooking import disable
+from pymhf.core.utils import set_main_window_active
+from pymhf.gui.decorators import BOOLEAN, STRING, gui_button, gui_combobox
+
+from nmspy.data.audiokinetic import AK
+from nmspy.data.enums import GcAudioWwiseEvents
+import nmspy.data.types as nms
+
+logger = logging.getLogger("AudioNames")
+
+
+AUDIO_EVENTS = {i.name: i.value for i in GcAudioWwiseEvents}
+AUDIO_EVENTS_REV = {i.value: i.name for i in GcAudioWwiseEvents}
+EVENT_NAMES = [i.name for i in GcAudioWwiseEvents]
+
+
+@dataclass
+class AudioState(ModState):
+    event_id: int = 0
+    obj_id: int = 0
+    play_sounds: bool = True
+    log_sounds: bool = True
+
+
+@disable
+class AudioNames(Mod):
+    __author__ = "monkeyman192"
+    __description__ = "Log (almost) all audio events when they happen"
+    __version__ = "0.1"
+
+    state = AudioState()
+
+    def __init__(self):
+        super().__init__()
+        self.audio_manager = None
+
+    @gui_combobox("Audio ID:", items=EVENT_NAMES)
+    def select_audio_id(self, sender, app_data: str, user_data):
+        event_id = AUDIO_EVENTS.get(app_data, 0)
+        self.state.event_id = event_id
+
+    @gui_button("Play sound")
+    def play_sound(self):
+        if self.state.event_id and self.state.obj_id and self.audio_manager is not None:
+            set_main_window_active()
+            audioid = nms.TkAudioID()
+            audioid.muID = self.state.event_id
+            self.audio_manager.Play(
+                event=ctypes.byref(audioid), object=self.state.obj_id
+            )
+
+    @property
+    @STRING("Event ID", decimal=True)
+    def event_id(self):
+        return self.state.event_id
+
+    @event_id.setter
+    def event_id(self, value):
+        self.state.event_id = int(value)
+
+    @property
+    @STRING("Object ID", decimal=True)
+    def obj_id(self):
+        return self.state.obj_id
+
+    @obj_id.setter
+    def obj_id(self, value):
+        self.state.obj_id = int(value)
+
+    @property
+    @BOOLEAN("Log sounds")
+    def log_sounds(self):
+        return self.state.log_sounds
+
+    @log_sounds.setter
+    def log_sounds(self, value):
+        self.state.log_sounds = value
+
+    @disable
+    @AK.SoundEngine.PostEvent.before
+    def play_event(self, *args):
+        if self.state.log_sounds:
+            event_id = args[0]
+            event_name = AUDIO_EVENTS_REV.get(event_id, "unknown event thing...")
+            logger.info(f"{args} -> {event_name}")
+
+    @AK.SoundEngine.RegisterGameObj.before
+    def register_object(self, in_GameObj, in_pszObjName):
+        if self.state.log_sounds:
+            logger.info(f"{in_GameObj} name: {ctypes.c_char_p(in_pszObjName).value}")
+
+    @disable
+    @nms.cTkAudioManager.Play.after
+    def after_play(
+        self,
+        this: ctypes._Pointer[nms.cTkAudioManager],
+        event: ctypes._Pointer[nms.TkAudioID],
+        object_,
+    ):
+        audioID = event.contents
+        logger.info(f"After play: ID: {audioID.muID}, object: {object_}")
+        self.audio_manager = this.contents
+        self.state.event_id = audioID.muID
+        self.state.obj_id = object_
+
+    @disable
+    @nms.cTkAudioManager.Play_attenuated.after
+    def after_play_attenuated(self, *args):
+        logger.info(f"Just played an attenuated sound: {args}")

example_mods/gravityManipulator.py

@@ -1,5 +1,5 @@
 # /// script
-# dependencies = ["pymhf[gui]>=0.1.14"]
+# dependencies = ["pymhf[gui]>=0.1.15"]
 #
 # [tool.pymhf]
 # exe = "NMS.exe"

nmspy/data/exported_types.py

@@ -19,10 +19,7 @@ class cGcSolarSystemData(Structure):
 
 @partial_struct
 class cGcNGuiTextData(Structure):
-    Text: Annotated[
-        basic.cTkDynamicArray[ctypes.c_char],
-        Field(basic.cTkDynamicArray[ctypes.c_char], 0x88),
-    ]
+    Text: Annotated[basic.cTkDynamicArray[ctypes.c_char], 0x88]
 
 
 class cGcScanEventData(Structure):
@@ -31,7 +28,7 @@ class cGcScanEventData(Structure):
 
 @partial_struct
 class cGcInteractionComponentData(Structure):
-    mInteractionType: Annotated[c_enum32[enums.GcInteractionType], 0x31C]
+    InteractionType: Annotated[c_enum32[enums.GcInteractionType], 0x32C]
 
 
 @partial_struct

nmspy/data/types.py

@@ -398,7 +398,21 @@ def GetDominantHand(self, this: "ctypes._Pointer[cGcPlayer]") -> ctypes.c_int64:
 
 
 class cGcPlayerState(Structure):
-    pass
+    @function_hook("48 89 5C 24 ? 48 89 6C 24 ? 48 89 74 24 ? 57 48 83 EC ? 44 8B 81 ? ? ? ? 48 8D 2D")
+    def AwardUnits(
+        self,
+        this: "ctypes._Pointer[cGcPlayerState]",
+        liChange: ctypes.c_int32,
+    ) -> ctypes.c_uint64:
+        pass
+
+    @function_hook("48 89 5C 24 ? 48 89 6C 24 ? 48 89 74 24 ? 57 48 83 EC ? 44 8B 81 ? ? ? ? 48 8D 35")
+    def AwardNanites(
+        self,
+        this: "ctypes._Pointer[cGcPlayerState]",
+        liChange: ctypes.c_int32,
+    ) -> ctypes.c_uint64:
+        pass
 
 
 class cGcGameState(Structure):

pyproject.toml

@@ -23,9 +23,9 @@ classifiers = [
   "Programming Language :: Python :: 3 :: Only",
 ]
 dependencies = [
-  "pymhf[gui]>=0.1.14"
+  "pymhf[gui]>=0.1.15"
 ]
-version = "147408.0"
+version = "147408.1"
 
 [dependency-groups]
 dev = [

tools/data.json

@@ -543,5 +543,15 @@
   "name": "cGcPlanetGenerator::Generate",
   "signature": "48 89 5C 24 ? 48 89 74 24 ? 48 89 7C 24 ? 55 41 54 41 55 41 56 41 57 48 8D AC 24 ? ? ? ? 48 81 EC ? ? ? ? 4D 8B F8 C6 85",
   "mangled_name": "?Generate@cGcPlanetGenerator@@QEAAXAEAVcGcPlanetData@@AEBVcGcPlanetGenerationInputData@@PEAVcGcPlanet@@@Z"
+ },
+ {
+  "name": "cGcPlayerState::AwardUnits",
+  "signature": "48 89 5C 24 ? 48 89 6C 24 ? 48 89 74 24 ? 57 48 83 EC ? 44 8B 81 ? ? ? ? 48 8D 2D",
+  "mangled_name": "?AwardUnits@cGcPlayerState@@QEAAIH@Z"
+ },
+ {
+  "name": "cGcPlayerState::AwardNanites",
+  "signature": "48 89 5C 24 ? 48 89 6C 24 ? 48 89 74 24 ? 57 48 83 EC ? 44 8B 81 ? ? ? ? 48 8D 35",
+  "mangled_name": "?AwardNanites@cGcPlayerState@@QEAAIH@Z"
  }
 ]