Add some extra data and checked patterns for 146545

Author: monkeyman192

.github/workflows/pipeline.yml

@@ -34,7 +34,6 @@ jobs:
         run: uv build
       - name: Lint and format code
         run: |
-          uv run python -m twine check ./dist/*
           uv run ruff check ./nmspy
           uv run ruff format --check ./nmspy
           uv run python -m twine check ./dist/*
@@ -45,8 +44,8 @@ jobs:
           path: dist/
   release:
     name: Release NMSpy wheels and source build to PyPI
-    # Only run this job if the commit was tagged.
-    if: startsWith(github.ref, 'refs/tags')
+    # Only run this job if we merge into master. Addition check is added later.
+    if: github.ref == 'refs/heads/master'
     needs:
       - build_test
     runs-on: ubuntu-latest
@@ -68,8 +67,8 @@ jobs:
 
   test-release:
     name: Release NMSpy wheels and source build to test-PyPI
-    # Release to the test PyPI if we have merged into master or if we have tagged.
-    if: ${{ (github.ref == 'refs/heads/master') || startsWith(github.ref, 'refs/tags') }}
+    # Only run this job if we merge into master. Addition check is added later.
+    if: github.ref == 'refs/heads/master'
     needs:
       - build_test
     runs-on: ubuntu-latest

nmspy/data/enums.py

@@ -1,4 +1,4 @@
-from enum import IntEnum, Enum
+from enum import IntEnum, Enum, auto
 
 
 class RespawnReason(IntEnum):
@@ -184,6 +184,240 @@ class GcInteractionType(IntEnum):
     BoneShop = 0x90
 
 
+class GcDamageType(IntEnum):
+    Gun = 0x0
+    Laser = 0x1
+    Shotgun = 0x2
+    Burst = 0x3
+    Rail = 0x4
+    Cannon = 0x5
+    Explosion = 0x6
+    Melee = 0x7
+    ShipGun = 0x8
+    ShipLaser = 0x9
+    ShipShotgun = 0xA
+    ShipMinigun = 0xB
+    ShipRockets = 0xC
+    ShipPlasma = 0xD
+    VehicleGun = 0xE
+    VehicleLaser = 0xF
+    SentinelLaser = 0x10
+    PlayerDamage = 0x11
+    PlayerWeapons = 0x12
+    ShipWeapons = 0x13
+    VehicleWeapons = 0x14
+    CombatEffects = 0x15
+    Fiend = 0x16
+    FreighterLaser = 0x17
+    FreighterTorpedo = 0x18
+
+
+class GcStatsTypes(IntEnum):
+    Unspecified = 0
+    Weapon_Laser = auto()
+    Weapon_Laser_Damage = auto()
+    Weapon_Laser_Mining_Speed = auto()
+    Weapon_Laser_HeatTime = auto()
+    Weapon_Laser_Bounce = auto()
+    Weapon_Laser_ReloadTime = auto()
+    Weapon_Laser_Recoil = auto()
+    Weapon_Laser_Drain = auto()
+    Weapon_Laser_StrongLaser = auto()
+    Weapon_Laser_ChargeTime = auto()
+    Weapon_Laser_MiningBonus = auto()
+    Weapon_Projectile = auto()
+    Weapon_Projectile_Damage = auto()
+    Weapon_Projectile_Range = auto()
+    Weapon_Projectile_Rate = auto()
+    Weapon_Projectile_ClipSize = auto()
+    Weapon_Projectile_ReloadTime = auto()
+    Weapon_Projectile_Recoil = auto()
+    Weapon_Projectile_Bounce = auto()
+    Weapon_Projectile_Homing = auto()
+    Weapon_Projectile_Dispersion = auto()
+    Weapon_Projectile_BulletsPerShot = auto()
+    Weapon_Projectile_MinimumCharge = auto()
+    Weapon_Projectile_MaximumCharge = auto()
+    Weapon_Projectile_BurstCap = auto()
+    Weapon_Projectile_BurstCooldown = auto()
+    Weapon_ChargedProjectile = auto()
+    Weapon_ChargedProjectile_ChargeTime = auto()
+    Weapon_ChargedProjectile_CooldownDuration = auto()
+    Weapon_ChargedProjectile_Drain = auto()
+    Weapon_ChargedProjectile_ExtraSpeed = auto()
+    Weapon_Rail = auto()
+    Weapon_Shotgun = auto()
+    Weapon_Burst = auto()
+    Weapon_Flame = auto()
+    Weapon_Cannon = auto()
+    Weapon_Grenade = auto()
+    Weapon_Grenade_Damage = auto()
+    Weapon_Grenade_Radius = auto()
+    Weapon_Grenade_Speed = auto()
+    Weapon_Grenade_Bounce = auto()
+    Weapon_Grenade_Homing = auto()
+    Weapon_Grenade_Clusterbomb = auto()
+    Weapon_TerrainEdit = auto()
+    Weapon_SunLaser = auto()
+    Weapon_SoulLaser = auto()
+    Weapon_MineGrenade = auto()
+    Weapon_FrontShield = auto()
+    Weapon_Scope = auto()
+    Weapon_Spawner = auto()
+    Weapon_SpawnerAlt = auto()
+    Weapon_Melee = auto()
+    Weapon_StunGrenade = auto()
+    Weapon_Stealth = auto()
+    Weapon_Scan = auto()
+    Weapon_Scan_Radius = auto()
+    Weapon_Scan_Recharge_Time = auto()
+    Weapon_Scan_Types = auto()
+    Weapon_Scan_Binoculars = auto()
+    Weapon_Scan_Discovery_Creature = auto()
+    Weapon_Scan_Discovery_Flora = auto()
+    Weapon_Scan_Discovery_Mineral = auto()
+    Weapon_Scan_Secondary = auto()
+    Weapon_Scan_Terrain_Resource = auto()
+    Weapon_Scan_Surveying = auto()
+    Weapon_Scan_BuilderReveal = auto()
+    Weapon_Fish = auto()
+    Weapon_Stun = auto()
+    Weapon_Stun_Duration = auto()
+    Weapon_Stun_Damage_Multiplier = auto()
+    Weapon_FireDOT = auto()
+    Weapon_FireDOT_Duration = auto()
+    Weapon_FireDOT_DPS = auto()
+    Weapon_FireDOT_Damage_Multiplier = auto()
+    Suit_Armour_Health = auto()
+    Suit_Armour_Shield = auto()
+    Suit_Armour_Shield_Strength = auto()
+    Suit_Energy = auto()
+    Suit_Energy_Regen = auto()
+    Suit_Protection = auto()
+    Suit_Protection_Cold = auto()
+    Suit_Protection_Heat = auto()
+    Suit_Protection_Toxic = auto()
+    Suit_Protection_Radiation = auto()
+    Suit_Protection_Spook = auto()
+    Suit_Protection_Pressure = auto()
+    Suit_Underwater = auto()
+    Suit_UnderwaterLifeSupport = auto()
+    Suit_DamageReduce_Cold = auto()
+    Suit_DamageReduce_Heat = auto()
+    Suit_DamageReduce_Toxic = auto()
+    Suit_DamageReduce_Radiation = auto()
+    Suit_Protection_HeatDrain = auto()
+    Suit_Protection_ColdDrain = auto()
+    Suit_Protection_ToxDrain = auto()
+    Suit_Protection_RadDrain = auto()
+    Suit_Protection_WaterDrain = auto()
+    Suit_Protection_SpookDrain = auto()
+    Suit_Stamina_Strength = auto()
+    Suit_Stamina_Speed = auto()
+    Suit_Stamina_Recovery = auto()
+    Suit_Jetpack = auto()
+    Suit_Jetpack_Tank = auto()
+    Suit_Jetpack_Drain = auto()
+    Suit_Jetpack_Refill = auto()
+    Suit_Jetpack_Ignition = auto()
+    Suit_Jetpack_DoubleJump = auto()
+    Suit_Jetpack_WaterEfficiency = auto()
+    Suit_Jetpack_MidairRefill = auto()
+    Suit_Refiner = auto()
+    Suit_AutoTranslator = auto()
+    Suit_Utility = auto()
+    Suit_RocketLocker = auto()
+    Suit_FishPlatform = auto()
+    Suit_FoodUnit = auto()
+    Suit_Denier = auto()
+    Suit_Vehicle_Summon = auto()
+    Ship_Weapons_Guns = auto()
+    Ship_Weapons_Guns_Damage = auto()
+    Ship_Weapons_Guns_Rate = auto()
+    Ship_Weapons_Guns_HeatTime = auto()
+    Ship_Weapons_Guns_CoolTime = auto()
+    Ship_Weapons_Guns_Scale = auto()
+    Ship_Weapons_Guns_BulletsPerShot = auto()
+    Ship_Weapons_Guns_Dispersion = auto()
+    Ship_Weapons_Guns_Range = auto()
+    Ship_Weapons_Guns_Damage_Radius = auto()
+    Ship_Weapons_Lasers = auto()
+    Ship_Weapons_Lasers_Damage = auto()
+    Ship_Weapons_Lasers_HeatTime = auto()
+    Ship_Weapons_Missiles = auto()
+    Ship_Weapons_Missiles_NumPerShot = auto()
+    Ship_Weapons_Missiles_Speed = auto()
+    Ship_Weapons_Missiles_Damage = auto()
+    Ship_Weapons_Missiles_Size = auto()
+    Ship_Weapons_Shotgun = auto()
+    Ship_Weapons_MiniGun = auto()
+    Ship_Weapons_Plasma = auto()
+    Ship_Weapons_Rockets = auto()
+    Ship_Weapons_ShieldLeech = auto()
+    Ship_Armour_Shield = auto()
+    Ship_Armour_Shield_Strength = auto()
+    Ship_Armour_Health = auto()
+    Ship_Scan = auto()
+    Ship_Scan_EconomyFilter = auto()
+    Ship_Scan_ConflictFilter = auto()
+    Ship_Hyperdrive = auto()
+    Ship_Hyperdrive_JumpDistance = auto()
+    Ship_Hyperdrive_JumpsPerCell = auto()
+    Ship_Hyperdrive_QuickWarp = auto()
+    Ship_Launcher = auto()
+    Ship_Launcher_TakeOffCost = auto()
+    Ship_Launcher_AutoCharge = auto()
+    Ship_PulseDrive = auto()
+    Ship_PulseDrive_MiniJumpFuelSpending = auto()
+    Ship_PulseDrive_MiniJumpSpeed = auto()
+    Ship_Boost = auto()
+    Ship_Maneuverability = auto()
+    Ship_BoostManeuverability = auto()
+    Ship_LifeSupport = auto()
+    Ship_Drift = auto()
+    Ship_Teleport = auto()
+    Ship_CargoShield = auto()
+    Ship_WaterLandingJet = auto()
+    Freighter_Hyperdrive = auto()
+    Freighter_Hyperdrive_JumpDistance = auto()
+    Freighter_Hyperdrive_JumpsPerCell = auto()
+    Freighter_MegaWarp = auto()
+    Freighter_Teleport = auto()
+    Freighter_Fleet_Boost = auto()
+    Freighter_Fleet_Speed = auto()
+    Freighter_Fleet_Fuel = auto()
+    Freighter_Fleet_Combat = auto()
+    Freighter_Fleet_Trade = auto()
+    Freighter_Fleet_Explore = auto()
+    Freighter_Fleet_Mine = auto()
+    Vehicle_Boost = auto()
+    Vehicle_Engine = auto()
+    Vehicle_Scan = auto()
+    Vehicle_EngineFuelUse = auto()
+    Vehicle_EngineTopSpeed = auto()
+    Vehicle_BoostSpeed = auto()
+    Vehicle_BoostTanks = auto()
+    Vehicle_Grip = auto()
+    Vehicle_SkidGrip = auto()
+    Vehicle_SubBoostSpeed = auto()
+    Vehicle_Laser = auto()
+    Vehicle_LaserDamage = auto()
+    Vehicle_LaserHeatTime = auto()
+    Vehicle_LaserStrongLaser = auto()
+    Vehicle_Gun = auto()
+    Vehicle_GunDamage = auto()
+    Vehicle_GunHeatTime = auto()
+    Vehicle_GunRate = auto()
+    Vehicle_StunGun = auto()
+    Vehicle_TerrainEdit = auto()
+    Vehicle_FuelRegen = auto()
+    Vehicle_AutoPilot = auto()
+    Vehicle_Flame = auto()
+    Vehicle_FlameDamage = auto()
+    Vehicle_FlameHeatTime = auto()
+    Vehicle_Refiner = auto()
+
+
 class GcAudioWwiseEvents(IntEnum):
     INVALID_EVENT = 0x0
     ABANDONED_DOOR_UNLOCK = 0x264BED2D

nmspy/data/nanovg.py

@@ -0,0 +1,60 @@
+# Hello games uses nanovg (https://github.com/memononen/nanovg) for a lot of their UI rendering under the
+# hood.
+
+# This file exposes a number of functions as hooks so that they can be used directly if needed.
+
+import ctypes
+
+from pymhf.core.hooking import static_function_hook
+
+
+class NVGcontext(ctypes.Structure):
+    pass
+
+
+@static_function_hook("48 8B C4 48 89 58 ? 48 89 68 ? F3 0F 11 50")
+def nvgArc(
+    ctx: ctypes._Pointer[NVGcontext],
+    cx: ctypes.c_float,
+    cy: ctypes.c_float,
+    r: ctypes.c_float,
+    a0: ctypes.c_float,
+    a1: ctypes.c_float,
+    dir: ctypes.c_int32,
+):
+    """Adds an arc segment at the corner defined by the last path point, and two specified points."""
+    pass
+
+
+@static_function_hook(
+    "48 8B C4 48 89 58 ? 48 89 70 ? 55 57 41 54 41 56 41 57 48 8D A8 ? ? ? ? 48 81 EC ? ? ? ? 0F 29 70 ? 48 8B F9"
+)
+def nvgText(
+    ctx: ctypes._Pointer[NVGcontext],
+    x: ctypes.c_float,
+    y: ctypes.c_float,
+    string: ctypes.c_char_p,
+    end: ctypes.c_char_p,
+):
+    """Draws text string at specified location.
+    If end is specified only the sub-string up to the end is drawn."""
+    pass
+
+
+@static_function_hook("4C 8B DC 53 56 57 41 54 48 81 EC")
+def nvgTextBox(
+    ctx: ctypes._Pointer[NVGcontext],
+    x: ctypes.c_float,
+    y: ctypes.c_float,
+    breakRowWidth: ctypes.c_float,
+    string: ctypes.c_char_p,
+    end: ctypes.c_char_p,
+):
+    """
+    Draws multi-line text string at specified location wrapped at the specified width.
+    If end is specified only the sub-string up to the end is drawn.
+    White space is stripped at the beginning of the rows, the text is split at word boundaries or when
+    new-line characters are encountered.
+    Words longer than the max width are slit at nearest character (i.e. no hyphenation).
+    """
+    pass