Merge pull request #21 from monkeyman192/update/155759.0

Update for 155759 and lots more

Author: monkeyman192

README.md

@@ -14,6 +14,9 @@ The author of this library does not condone any use of this code for any purpose
 **Note:**
 It is recommended that you download python from the [official site](https://www.python.org/downloads) as the windows store version may have issues, as well as the managed python which [uv](https://docs.astral.sh/uv/) installs.
 
+**Note:**
+Python 3.14 is not yet supported. This will come in time but requires some changes to a dependency in pyMHF.
+
 The recommended way to install NMS.py is to simply run `python -m pip install nmspy`. This will install NMS.py and its' dependency [`pyMHF`](https://github.com/monkeyman192/pyMHF) into your system python. You can of course install it in a venv or as a dependency using uv if you prefer.
 
 ## Usage
@@ -34,7 +37,22 @@ If you want to stop NMS, you can press `ctrl + C` in the window you started the
 
 Currently the best way to see how to write a mod is to look at the `example_mods` folder, as well as looking at the [pyMHF docs](https://monkeyman192.github.io/pyMHF/) which has comprehensive details on how to use pyMHF.
 
-### Credits
+## Contributing
+
+NMS.py can always be better! If you are interested in improving it, the best way to do so is to either make mods using it, or, if you have reverse engineering skills, you can contribute either new functions or new field offsets.
+
+### Adding new functions to hook
+
+To add a new function to hook you need to add the details to `tools/data.json` as well as the `nmspy/data/types.py` file.
+The data for these can generally be found by comparing the structure of the function in the latest exe to either the mac binary or the 4.13 binary.
+It is recommended to use either [IDA Fusion](https://github.com/senator715/IDA-Fusion) or [SigmakerEX](https://github.com/kweatherman/sigmakerex) for IDA or some other plugin for any other disassembler to get the unique byte pattern for the function you are providing.
+
+### Adding new struct fields
+
+This is a bit trickier and will often involve a good amount of reverse engineering of the exe, comparing the data to the 4.13 binary as well as potentially the mac binary.
+It is best if a comment is made above the added field so that it's possible to find it again when the game updates so that it's possible to check if the offset has changed.
+
+## Credits
 
 Thanks to the developers of minhook, cyminhook and pymem, all of which are instrumental in making this framework possible.
 

nmspy/_internal_mods/singletons.py

@@ -7,7 +7,7 @@
 from pymhf.core.hooking import one_shot, hook_manager
 from pymhf.core.memutils import map_struct, get_addressof
 from pymhf import ModState
-import nmspy.common as nms_state
+from nmspy.common import gameData
 import nmspy.data.types as nms
 import nmspy.data.basic_types as basic
 from pymhf import Mod
@@ -35,7 +35,7 @@ class _INTERNAL_LoadSingletons(Mod):
     def fsm_state_change(self, this: ctypes._Pointer[nms.cTkFSM], *args):
         # One shot to instantiate the cGcApplication object.
         # This logic looks funny, but it's because the cGcApplication has cTkFSM as a base class.
-        nms_state.GcApplication = map_struct(get_addressof(this), nms.cGcApplication)
+        gameData.GcApplication = map_struct(get_addressof(this), nms.cGcApplication)
 
     @nms.cTkFSMState.StateChange.after
     def state_change(

nmspy/common.py

@@ -1,39 +1,30 @@
+from typing import Optional
+
 import nmspy.data.types as nms
 
-# TODO:
-# Store all the globals here like this so that we may access them easily and
-# from anywhere.
-GcAISpaceshipGlobals = None
-GcAtlasGlobals = None
-GcAudioGlobals = None
-GcBuildingGlobals = None
-GcCameraGlobals = None
-GcCharacterGlobals = None
-GcCreatureGlobals = None
-GcDebugOptions = None
-GcEffectsGlobals = None
-GcEnvironmentGlobals = None
-GcFleetGlobals = None
-GcFreighterBaseGlobals = None
-GcGalaxyGlobals = None
-GcGameplayGlobals = None
-GcGraphicsGlobals = None
-GcMultiplayerGlobals = None
-GcPlacementGlobals = None
-GcPlayerGlobals = None
-GcRichPresenceGlobals = None
-GcRobotGlobals = None
-GcSceneOptions = None
-GcScratchpadGlobals = None
-GcSettlementGlobals = None
-GcSimulationGlobals = None
-GcSkyGlobals = None
-GcSmokeTestOptions = None
-GcSolarGenerationGlobals = None
-GcSpaceshipGlobals = None
-GcTerrainGlobals = None
-GcUIGlobals = None
-GcVehicleGlobals = None
-GcWaterGlobals = None
-
-GcApplication: nms.cGcApplication = None  # type: ignore
+
+class GameData:
+    GcApplication: nms.cGcApplication = None  # type: ignore
+
+    @property
+    def game_state(self) -> Optional[nms.cGcGameState]:
+        if self.GcApplication is not None:
+            return self.GcApplication.mpData.contents.mGameState
+
+    @property
+    def simulation(self) -> Optional[nms.cGcSimulation]:
+        if self.GcApplication is not None:
+            return self.GcApplication.mpData.contents.mSimulation
+
+    @property
+    def player(self) -> Optional[nms.cGcPlayer]:
+        if (sim := self.simulation) is not None:
+            return sim.mPlayer
+
+    @property
+    def player_state(self) -> Optional[nms.cGcPlayerState]:
+        if (game_state := self.game_state) is not None:
+            return game_state.mPlayerState
+
+
+gameData = GameData()

nmspy/data/basic_types.py

@@ -107,6 +107,11 @@ class Vector3f(ctypes.Structure):
         ("_padding", ctypes.c_byte * 0x4),
     ]
 
+    def __init__(self, x: float, y: float, z: float):
+        self.x = x
+        self.y = y
+        self.z = z
+
     def __iadd__(self, other: "Vector3f"):
         self.x += other.x
         self.y += other.y
@@ -208,6 +213,9 @@ class cTkPhysRelVec3(ctypes.Structure):
         ("offset", Vector3f),
     ]
 
+    def __str__(self):
+        return f"<{self.__qualname__}; local: {str(self.local)}, offset: {str(self.offset)}"
+
 
 class GcResource(ctypes.Structure):
     ResourceID: int
@@ -593,3 +601,5 @@ def __str__(self):
 cTkFixedString0x200 = cTkFixedString[0x200]
 cTkFixedString0x400 = cTkFixedString[0x400]
 cTkFixedString0x800 = cTkFixedString[0x800]
+# Vector type aliases
+cTkBigPos = cTkPhysRelVec3

nmspy/data/enums/__init__.py

@@ -115,9 +115,9 @@
     cGcRainbowType,
     cGcPlayerConflictData,
     cGcSolarSystemClass,
-    cGcPlanetSentinelLevel,
     cGcPlanetSize,
     cGcPlanetClass,
+    cGcPlanetSentinelLevel,
     cGcBiomeType,
     cGcBiomeSubType,
     cGcSolarSystemLocatorTypes,
@@ -252,21 +252,21 @@
     cGcRarity,
     cGcProceduralProductCategory,
     cGcProductCategory,
+    cGcNameGeneratorSectorTypes,
     cGcNameGeneratorTypes,
     cGcProceduralTechnologyCategory,
     cGcModularCustomisationResourceType,
     cGcMaintenanceElementGroups,
-    cGcNameGeneratorSectorTypes,
     cGcInventoryType,
-    cGcInventoryLayoutSizeType,
     cGcItemNeedPurpose,
+    cGcInventoryLayoutSizeType,
     cGcInventorySpecialSlotType,
     cGcLegality,
     cGcInventoryStackSizeGroup,
     cGcFrigateClass,
     cGcDiscoveryTrimGroup,
-    cGcDiscoveryTrimScoringCategory,
     cGcFrigateTraitStrength,
+    cGcDiscoveryTrimScoringCategory,
     cGcDiscoveryType,
     cGcInventoryClass,
     cGcExpeditionCategory,

nmspy/data/enums/external_enums.py

@@ -3515,13 +3515,6 @@ class cGcSolarSystemClass(IntEnum):
     GameStart = 0x3
 
 
-class cGcPlanetSentinelLevel(IntEnum):
-    Low = 0x0
-    Default = 0x1
-    Aggressive = 0x2
-    Corrupt = 0x3
-
-
 class cGcPlanetSize(IntEnum):
     Large = 0x0
     Medium = 0x1
@@ -3536,6 +3529,13 @@ class cGcPlanetClass(IntEnum):
     InInitialSystem = 0x2
 
 
+class cGcPlanetSentinelLevel(IntEnum):
+    Low = 0x0
+    Default = 0x1
+    Aggressive = 0x2
+    Corrupt = 0x3
+
+
 class cGcBiomeType(IntEnum):
     Lush = 0x0
     Toxic = 0x1
@@ -5675,6 +5675,21 @@ class cGcProductCategory(IntEnum):
     ExhibitBone = 0xA
 
 
+class cGcNameGeneratorSectorTypes(IntEnum):
+    Generic = 0x0
+    Elevated = 0x1
+    Low = 0x2
+    Trees = 0x3
+    LushTrees = 0x4
+    Lush = 0x5
+    Wet = 0x6
+    Cave = 0x7
+    Dead = 0x8
+    Buildings = 0x9
+    Water = 0xA
+    Ice = 0xB
+
+
 class cGcNameGeneratorTypes(IntEnum):
     Generic = 0x0
     Mineral = 0x1
@@ -5721,27 +5736,21 @@ class cGcMaintenanceElementGroups(IntEnum):
     RobotHeads = 0x9
 
 
-class cGcNameGeneratorSectorTypes(IntEnum):
-    Generic = 0x0
-    Elevated = 0x1
-    Low = 0x2
-    Trees = 0x3
-    LushTrees = 0x4
-    Lush = 0x5
-    Wet = 0x6
-    Cave = 0x7
-    Dead = 0x8
-    Buildings = 0x9
-    Water = 0xA
-    Ice = 0xB
-
-
 class cGcInventoryType(IntEnum):
     Substance = 0x0
     Technology = 0x1
     Product = 0x2
 
 
+class cGcItemNeedPurpose(IntEnum):
+    None_ = 0x0
+    Crafting = 0x1
+    Building = 0x2
+    Repairing = 0x3
+    Charging = 0x4
+    Paying = 0x5
+
+
 class cGcInventoryLayoutSizeType(IntEnum):
     SciSmall = 0x0
     SciMedium = 0x1
@@ -5790,15 +5799,6 @@ class cGcInventoryLayoutSizeType(IntEnum):
     CorvetteStorage = 0x2C
 
 
-class cGcItemNeedPurpose(IntEnum):
-    None_ = 0x0
-    Crafting = 0x1
-    Building = 0x2
-    Repairing = 0x3
-    Charging = 0x4
-    Paying = 0x5
-
-
 class cGcInventorySpecialSlotType(IntEnum):
     Broken = 0x0
     TechOnly = 0x1
@@ -5848,17 +5848,6 @@ class cGcDiscoveryTrimGroup(IntEnum):
     Boring = 0x3
 
 
-class cGcDiscoveryTrimScoringCategory(IntEnum):
-    IsNamedSystem = 0x0
-    RecentlyVisitedSystem = 0x1
-    RecentDiscoveryInSystem = 0x2
-    NumDiscoveredPlanetsInSystem = 0x3
-    IsNamedPlanet = 0x4
-    NumBasesOnPlanet = 0x5
-    NumWondersOnPlanet = 0x6
-    NumNamedDiscoveries = 0x7
-
-
 class cGcFrigateTraitStrength(IntEnum):
     NegativeLarge = 0x0
     NegativeMedium = 0x1
@@ -5872,6 +5861,17 @@ class cGcFrigateTraitStrength(IntEnum):
     Primary = 0x9
 
 
+class cGcDiscoveryTrimScoringCategory(IntEnum):
+    IsNamedSystem = 0x0
+    RecentlyVisitedSystem = 0x1
+    RecentDiscoveryInSystem = 0x2
+    NumDiscoveredPlanetsInSystem = 0x3
+    IsNamedPlanet = 0x4
+    NumBasesOnPlanet = 0x5
+    NumWondersOnPlanet = 0x6
+    NumNamedDiscoveries = 0x7
+
+
 class cGcDiscoveryType(IntEnum):
     Unknown = 0x0
     SolarSystem = 0x1