bun-memory 1.1.6 → 1.1.8

package/README.md

@@ -0,0 +1,81 @@
+# bun-memory
+
+High-performance Windows process memory utilities for [Bun](https://bun.sh) using `bun:ffi` and Win32 APIs.
+
+## Features
+
+- Built for Bun runtime and Windows 10/11
+- Efficient buffer management for high-speed operations
+- Pattern scanning for offsets \*
+- Read and write memory of Windows processes
+
+\* — Feature temporarily disabled
+
+## Requirements
+
+- **Bun** (uses `bun:ffi`)
+- **Windows 10/11** (uses `kernel32.dll`)
+
+## Installation
+
+```bash
+bun add bun-memory
+```
+
+## Usage
+
+See [example/trigger-bot.ts](example/trigger-bot.ts) for a real-world example.
+
+### Basic Example
+
+```ts
+import Memory from 'bun-memory';
+
+// Attach to process by name…
+const memory = new Memory('notepad.exe');
+// …or PID
+const memory = new Memory(1234);
+
+// Access loaded modules
+const modules = memory.modules;
+const mainModule = modules['notepad.exe'];
+console.log(`Base address: 0x${mainModule.modBaseAddr.toString(16)}`);
+console.log(`Size: ${mainModule.modBaseSize} bytes`);
+
+// Read a 32-bit integer
+const value = memory.i32(0x12345678n);
+
+// Write a float
+memory.f32(0x12345678n, 3.14159);
+
+// Clean up
+memory.close();
+```
+
+### Pattern Scanning
+
+```ts
+const offset = memory.findPattern('aa??bbccdd??ff', mainModule.modBaseAddr, mainModule.modBaseSize);
+const value = memory.bool(offset + 0x1234n);
+memory.close();
+```
+
+### Efficient Buffer Reads
+
+```ts
+const scratch = Buffer.allocUnsafe(0xf000);
+const view = new BigUint64Array(scratch.buffer, scratch.byteOffset, 0xf000 / 8);
+
+while (true) {
+  memory.read(myAddress, scratch); // Updates scratch and view, no allocations
+}
+```
+
+```ts
+const scratch = Buffer.allocUnsafe(0x100);
+memory.read(myAddress, scratch);
+```
+
+## Notes
+
+- Only works with Bun and Windows.

package/example/trigger-bot.ts

@@ -1,7 +1,7 @@
-import { FFIType, dlopen } from 'bun:ffi';
+import { CString, FFIType, dlopen, ptr } from 'bun:ffi';
 import { sleep } from 'bun';
 
-import Memory from 'bun-memory';
+import Memory from '../index.ts';
 
 // Get the latest client_dll.json and offsets.json from:
 // https://github.com/a2x/cs2-dumper/tree/main/output
@@ -9,6 +9,10 @@ import Memory from 'bun-memory';
 import ClientDLLJSON from './offsets/client_dll.json';
 import OffsetsJSON from './offsets/offsets.json';
 
+// !
+
+// !
+
 const Delay = 2.5;
 
 const { random } = Math;

package/package.json

@@ -22,7 +22,7 @@
     "url": "git://github.com/obscuritysrl/bun-memory.git"
   },
   "type": "module",
-  "version": "1.1.6",
+  "version": "1.1.8",
   "main": "./index.ts",
   "keywords": [
     "bun",

package/runtime/extensions.ts

@@ -74,7 +74,7 @@
  * ```
  */
 
-import { ptr, type Pointer } from 'bun:ffi';
+import { type Pointer, ptr } from 'bun:ffi';
 
 /**
  * List of binary view constructor functions whose prototypes will be extended
@@ -236,3 +236,5 @@ constructors.forEach(({ prototype }) => {
     });
   }
 });
+
+export {};

package/structs/Memory.ts

@@ -439,6 +439,7 @@ class Memory {
    * @param lengthOrValue - Number of bytes to read (when reading), or `CString` to write (when writing)
    * @returns `CString` when reading, or this `Memory` instance when writing
    *
+   * @todo Investigate odd behavior when reading strings longer than `lengthOrValue`.
    * @todo Research and consider alternatives that do not require so many new allocations.
    *
    * @example