bun-memory 1.1.49 → 2.0.0

package/example/benchmark.ts

@@ -2,7 +2,7 @@
 // ! This benchmark may take 1-2+ minutes. It repeatedly traverses the entire entity list in
 // ! Counter-Strike 2, storing it into `EntityClassInfoNames`…
 
-import Memory from 'bun-memory';
+import Process from 'bun-memory';
 
 // Get the latest client_dll.json and offsets.json from:
 // https://github.com/a2x/cs2-dumper/tree/main/output
@@ -21,27 +21,22 @@ const Client = {
 } & { Other: { [K in keyof (typeof OffsetsJSON)['client.dll']]: bigint } };
 
 // Open a handle to cs2.exe…
-const cs2 = new Memory('cs2.exe');
+const cs2 = new Process('cs2.exe');
 
-// Get the base for client.dll…
-const ClientPtr = cs2.modules['client.dll']?.base;
-
-// Make sure client.dll is loaded…
-if (ClientPtr === undefined) {
-  throw new TypeError('ClientPtr must not be undefined.');
-}
+// Get the client.dll module…
+const client = cs2.module('client.dll');
 
 // Warmup…
 console.log('Warming up…');
 
 for (let i = 0; i < Iterations; i++) {
-  const GlobalVarsPtr = cs2.u64(ClientPtr + Client.Other.dwGlobalVars);
+  const GlobalVarsPtr = client.u64(Client.Other.dwGlobalVars);
   /* */ const CurTime = cs2.f32(GlobalVarsPtr + 0x30n);
 
-  const lPlayerControllerPtr = cs2.u64(ClientPtr + Client.Other.dwLocalPlayerController);
+  const lPlayerControllerPtr = client.u64(Client.Other.dwLocalPlayerController);
   /* */ const lPlayerName = cs2.string(lPlayerControllerPtr + Client.CBasePlayerController.m_iszPlayerName, 32);
 
-  const lPlayerPawnPtr = cs2.u64(ClientPtr + Client.Other.dwLocalPlayerPawn);
+  const lPlayerPawnPtr = client.u64(Client.Other.dwLocalPlayerPawn);
   /* */ const lHealth = cs2.u32(lPlayerPawnPtr + Client.C_BaseEntity.m_iHealth);
   /* */ const lTeamNum = cs2.u8(lPlayerPawnPtr + Client.C_BaseEntity.m_iTeamNum);
 }
@@ -60,7 +55,7 @@ for (let i = 0; i < 5; i++) {
 
   const start = performance.now();
 
-  const EntityListPtr = cs2.u64(ClientPtr + Client.Other.dwEntityList);
+  const EntityListPtr = client.u64(Client.Other.dwEntityList);
 
   for (let j = 0; j < Iterations; j++) {
     try {
@@ -69,7 +64,7 @@ for (let i = 0; i < 5; i++) {
 
       // Traverse each of the potential 64 entity chunks…
       for (let k = 0; k < 0x40; k++) {
-        const EntityChunkPtr = EntityListScratch[k];
+        const EntityChunkPtr = EntityListScratch[k]!;
 
         if (EntityChunkPtr === 0n) {
           continue;
@@ -79,13 +74,13 @@ for (let i = 0; i < 5; i++) {
 
         // Traverse the potential 512 entities in that chunk…
         for (let j = 0x00, l = 0x00; j < 0x200; j++, l += 0x0e) {
-          const BaseEntityPtr = EntityChunkScratch[l];
+          const BaseEntityPtr = EntityChunkScratch[l]!;
 
           if (BaseEntityPtr === 0n) {
             continue;
           }
 
-          const EntityClassInfoPtr = EntityChunkScratch[l + 0x01];
+          const EntityClassInfoPtr = EntityChunkScratch[l + 0x01]!;
 
           let Name = EntityClassInfoNames.get(EntityClassInfoPtr);
 

package/example/trigger-bot.ts

@@ -1,7 +1,7 @@
 import { FFIType, dlopen, ptr } from 'bun:ffi';
 import { sleep } from 'bun';
 
-import Memory from 'bun-memory';
+import Process from 'bun-memory';
 
 // Get the latest client_dll.json and offsets.json from:
 // https://github.com/a2x/cs2-dumper/tree/main/output
@@ -29,34 +29,28 @@ const Client = {
 } & { Other: { [K in keyof (typeof OffsetsJSON)['client.dll']]: bigint } };
 
 // Open a handle to cs2.exe…
-const cs2 = new Memory('cs2.exe');
+const cs2 = new Process('cs2.exe');
 
-// Get the base for client.dll…
-const client = cs2.modules['client.dll'];
-
-if (client === undefined) {
-  throw new TypeError('client must not be undefined.');
-}
-
-const ClientPtr = client.base;
+// Get the client.dll module…
+const client = cs2.module('client.dll');
 
 // Create a cache for class name strings… 🫠…
 const Cache_Names = new Map<bigint, string>();
 
 let ticks = 0;
 
-async function tick(ClientPtr: bigint) {
+async function tick() {
   try {
     ticks++;
 
     // Read relevant info from memory…
-    const GlobalVarsPtr = cs2.u64(ClientPtr + Client.Other.dwGlobalVars);
+    const GlobalVarsPtr = client.u64(Client.Other.dwGlobalVars);
     /* */ const CurTime = cs2.f32(GlobalVarsPtr + 0x30n);
 
-    const Local_PlayerControllerPtr = cs2.u64(ClientPtr + Client.Other.dwLocalPlayerController);
+    const Local_PlayerControllerPtr = client.u64(Client.Other.dwLocalPlayerController);
     /* */ const Local_TickBase = cs2.u32(Local_PlayerControllerPtr + Client.CBasePlayerController.m_nTickBase);
 
-    const Local_PlayerPawnPtr = cs2.u64(ClientPtr + Client.Other.dwLocalPlayerPawn);
+    const Local_PlayerPawnPtr = client.u64(Client.Other.dwLocalPlayerPawn);
     /* */ const Local_FlashOverlayAlpha = cs2.f32(Local_PlayerPawnPtr + Client.C_CSPlayerPawnBase.m_flFlashOverlayAlpha);
     /* */ const Local_IDEntIndex = cs2.i32(Local_PlayerPawnPtr + Client.C_CSPlayerPawn.m_iIDEntIndex);
     /* */ const Local_IsScoped = cs2.i32(Local_PlayerPawnPtr + Client.C_CSPlayerPawn.m_bIsScoped);
@@ -89,7 +83,7 @@ async function tick(ClientPtr: bigint) {
     // Weapon types: https://swiftlys2.net/sdk/cs2/types/csweapontype
 
     // Get the entity that we're aiming at from the entity list…
-    const EntityListPtr = cs2.u64(ClientPtr + Client.Other.dwEntityList);
+    const EntityListPtr = client.u64(Client.Other.dwEntityList);
     /* */ const EntityChunkPtr = cs2.u64(EntityListPtr + (BigInt(Local_IDEntIndex) >> 0x09n) * 0x08n + 0x10n);
     /*       */ const BaseEntityPtr = cs2.u64(EntityChunkPtr + (BigInt(Local_IDEntIndex) & 0x1ffn) * 0x70n);
     /*             */ const EntityClassInfoPtr = cs2.u64(EntityChunkPtr + (BigInt(Local_IDEntIndex) & 0x1ffn) * 0x70n + 0x08n);
@@ -132,12 +126,12 @@ async function tick(ClientPtr: bigint) {
     // console.error(error);
     return;
   } finally {
-    setImmediate(tick, ClientPtr);
+    setImmediate(tick);
   }
 }
 
 // Start the tick loop…
-setImmediate(tick, ClientPtr);
+setImmediate(tick);
 
 // Log ticks per second…
 setInterval(() => {

package/index.ts

@@ -1,4 +1,7 @@
 import './runtime/extensions';
-import Memory from './structs/Memory';
 
-export default Memory;
+import Module from './structs/Module';
+import Process from './structs/Process';
+
+export default Process;
+export { Module, Process };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bun-memory",
-  "version": "1.1.49",
+  "version": "2.0.0",
   "author": "Stev Peifer <stev@bell.net>",
   "repository": {
     "type": "git",

package/structs/Module.ts

@@ -0,0 +1,40 @@
+import type Process from './Process';
+
+/**
+ * Represents a loaded module in a process.
+ *
+ * @example
+ * ```ts
+ * const cs2 = new Process('cs2.exe');
+ * const client = cs2.module('client.dll');
+ * console.log(client.modBaseAddr, client.modBaseSize, client.szExePath);
+ * ```
+ */
+class Module {
+  /**
+   * Creates a new Module instance.
+   * @param process Parent process instance.
+   * @param hModule Module handle.
+   * @param modBaseAddr Base address of the module.
+   * @param modBaseSize Module size in bytes.
+   * @param szExePath Full path to the module.
+   * @param szModule Module filename.
+   */
+  constructor(
+    public readonly process: Process,
+    public readonly hModule: bigint,
+    public readonly modBaseAddr: bigint,
+    public readonly modBaseSize: number,
+    public readonly szExePath: string,
+    public readonly szModule: string,
+  ) {
+    this.modEndAddr = modBaseAddr + BigInt(modBaseSize);
+  }
+
+  /**
+   * End address of the module (modBaseAddr + modBaseSize).
+   */
+  public readonly modEndAddr: bigint;
+}
+
+export default Module;