bun-memory 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 ObscuritySRL
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,72 @@
+# Memory (Bun + Win32)
+
+High-performance Windows process memory utilities for [Bun](https://bun.sh) using `bun:ffi` and Kernel32 APIs.
+
+## Requirements
+
+- Bun runtime (uses `bun:ffi`).
+- Windows 10/11 (uses `kernel32.dll`).
+
+## Installation
+
+```bash
+bun add bun-memory
+```
+
+## Usage
+
+### Basic example
+
+```ts
+import Memory from './Memory';
+
+const memory = new Memory('strounter-cike.exe');
+
+const clientDLL = memory.modules['client.dll'];
+
+if (clientDLL === undefined) {
+  // …
+}
+
+const { modBaseAddr: clientBaseAddr, modBaseSize: modBaseSize } = clientDLL;
+
+// Write to your ammo…
+const ammoOffset = 0xabcdefn;
+memory.writeUInt32LE(clientBaseAddr + ammoOffset, 0x270f);
+
+// Read your health…
+const healthOffset = 0x123456n;
+const healthValue = memory.readUInt32LE(clientBaseAddr + healthOffset);
+console.log('You have %d health…', healthValue); // Your have 100 health…
+
+// Find an offset by pattern…
+const otherOffset = memory.findPattern('aa??bbccdd??ff', clientBaseAddr, clientBaseSize);
+const otherValue = memory.readBoolean(otherOffset + 0x1234n);
+
+memory.close();
+```
+
+### Reading with scratch buffers
+
+Many read methods accept an optional `scratch` `Buffer` to avoid allocations:
+
+```ts
+const myScratch = Buffer.allocUnsafe(0xf000);
+const myView = new BigUint64Array(myScratch.buffer, myScratch.byteOffset, 0xf000 / 0x08);
+
+// …
+
+while (true) {
+  memory.readInto(myAddress, myScratch); // Updates myView with no new allocations…
+}
+```
+
+```ts
+const myScratch = Buffer.allocUnsafe(0x256);
+const myValue = memory.readString(myAddress, myScratch);
+```
+
+### Notes
+
+- Bun is required; this package relies on `bun:ffi`.
+- Windows is the only supported platform.

package/index.ts

@@ -0,0 +1,3 @@
+import Memory from './structs/Memory';
+
+export default Memory;

package/package.json

@@ -0,0 +1,47 @@
+{
+  "author": "Stev Peifer <stev@bell.net>",
+  "bugs": {
+    "url": "https://github.com/obscuritysrl/bun-memory/issues"
+  },
+  "description": "Fast Windows process memory utilities for Bun using bun:ffi.",
+  "devDependencies": {
+    "@types/bun": "latest"
+  },
+  "exports": {
+    ".": "./index.ts"
+  },
+  "license": "MIT",
+  "module": "index.ts",
+  "name": "bun-memory",
+  "peerDependencies": {
+    "typescript": "^5"
+  },
+  "private": false,
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/obscuritysrl/bun-memory.git"
+  },
+  "type": "module",
+  "version": "1.0.0",
+  "main": "./index.ts",
+  "keywords": [
+    "bun",
+    "ffi",
+    "windows",
+    "win32",
+    "memory",
+    "process",
+    "ReadProcessMemory",
+    "WriteProcessMemory",
+    "typescript"
+  ],
+  "files": [
+    "index.ts",
+    "structs/*.ts",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "bun": ">=1.1.0"
+  }
+}