rocketleaguesdk 1.0.0 → 1.0.1

package/examples/basic.ts

@@ -1,47 +1,28 @@
 /**
  * Basic SDK Usage Example
  *
- * This example demonstrates step-by-step how to read game data
- * from Rocket League using the generated SDK types.
- *
- * All memory reading logic is inline so you can see exactly how it works.
+ * This example demonstrates how to read game data from Rocket League
+ * using the generated SDK types and offsets.
  *
  * Run with: bun run examples/basic.ts
  */
 
-import Memory from 'bun-memory';
-
-// Import SDK types for type safety
-import type { Structs } from '..';
-
-// =============================================================================
-// OFFSETS (from SDK generation)
-// =============================================================================
-
-// GNames and GObjects offsets discovered during SDK generation
-// See: types/offsets.ts for the full list
-const GNAMES_OFFSET = 0x23ed570n;
-const GOBJECTS_OFFSET = 0x23ed5b8n;
-
-// UObject layout (UE3 structure)
-// These are the byte offsets to each field within a UObject
-const UObject = {
-  Outer: 0x40,     // Pointer to outer object (package/owner)
-  Name: 0x48,      // FName index - lookup in GNames to get string name
-  Class: 0x50,     // Pointer to the UClass that describes this object
-} as const;
+import Memory from "bun-memory";
 
-// FNameEntry layout - structure in GNames array
-const FNameEntry = {
-  Name: 0x18,      // Offset to the actual name string (wide string)
-} as const;
+// Import SDK types and offsets
+import type { Structs } from "..";
+import {
+  GNAMES_OFFSET,
+  GOBJECTS_OFFSET,
+  UObject,
+  FNameEntry,
+} from "../types/offsets";
 
 // CarComponent_Boost_TA offsets
 // Found in: classes/TAGame.ts - search for "CarComponent_Boost_TA"
-// These offsets define where boost-related data is stored in the component
 const BoostOffsets = {
-  CurrentBoostAmount: 0x0338,  // float - current boost (0.0 to MaxBoostAmount)
-  MaxBoostAmount: 0x032C,      // float - maximum boost capacity
+  CurrentBoostAmount: 0x0338, // float - current boost (0.0 to MaxBoostAmount)
+  MaxBoostAmount: 0x032c, // float - maximum boost capacity
 } as const;
 
 // =============================================================================
@@ -49,11 +30,11 @@ const BoostOffsets = {
 // =============================================================================
 
 // Open the process
-const rl = new Memory('RocketLeague.exe');
-const module = rl.modules['RocketLeague.exe'];
+const rl = new Memory("RocketLeague.exe");
+const module = rl.modules["RocketLeague.exe"];
 
 if (!module) {
-  throw new Error('RocketLeague.exe not found. Is the game running?');
+  throw new Error("RocketLeague.exe not found. Is the game running?");
 }
 
 const base = module.base;
@@ -62,7 +43,7 @@ const base = module.base;
 const gNamesPtr = rl.uPtr(base + GNAMES_OFFSET);
 const gObjectsPtr = rl.uPtr(base + GOBJECTS_OFFSET);
 
-console.log('=== Rocket League SDK Example ===');
+console.log("=== Rocket League SDK Example ===");
 console.log(`Base: 0x${base.toString(16).toUpperCase()}`);
 console.log(`GNames: 0x${gNamesPtr.toString(16).toUpperCase()}`);
 console.log(`GObjects: 0x${gObjectsPtr.toString(16).toUpperCase()}`);
@@ -92,8 +73,8 @@ function getName(index: number): string {
     // Read up to 256 characters (512 bytes for UTF-16)
     const buf = Buffer.allocUnsafe(512);
     rl.read(namePtr, buf);
-    const str = buf.toString('utf16le');
-    const nullIdx = str.indexOf('\0');
+    const str = buf.toString("utf16le");
+    const nullIdx = str.indexOf("\0");
     return nullIdx >= 0 ? str.slice(0, nullIdx) : str;
   } catch {
     return "<error>";
@@ -151,7 +132,7 @@ function getObjectFullName(objPtr: bigint): string {
       outer = rl.uPtr(outer + BigInt(UObject.Outer));
     }
 
-    const path = outers.length > 0 ? outers.join('.') + '.' + name : name;
+    const path = outers.length > 0 ? outers.join(".") + "." + name : name;
     return `${className} ${path}`;
   } catch {
     return "<error>";
@@ -166,7 +147,9 @@ function getObjectFullName(objPtr: bigint): string {
  * @param className - The class name to search for
  * @yields Object pointer and full name
  */
-function* findByClass(className: string): Generator<{ ptr: bigint; fullName: string }> {
+function* findByClass(
+  className: string
+): Generator<{ ptr: bigint; fullName: string }> {
   const MAX_OBJECTS = 500_000;
 
   for (let i = 0; i < MAX_OBJECTS; i++) {
@@ -207,27 +190,32 @@ function readFVector(address: bigint): Structs.Core.FVector {
 // MAIN: FIND AND DISPLAY BOOST AMOUNTS
 // =============================================================================
 
-console.log('Searching for CarComponent_Boost_TA objects...');
-console.log('(Make sure you are in a match to see results)');
+console.log("Searching for CarComponent_Boost_TA objects...");
+console.log("(Make sure you are in a match to see results)");
 console.log();
 
 let found = 0;
-for (const { ptr, fullName } of findByClass('CarComponent_Boost_TA')) {
+for (const { ptr, fullName } of findByClass("CarComponent_Boost_TA")) {
   // Read boost values using the offsets from classes/TAGame.ts
   const currentBoost = rl.f32(ptr + BigInt(BoostOffsets.CurrentBoostAmount));
   const maxBoost = rl.f32(ptr + BigInt(BoostOffsets.MaxBoostAmount));
-  const percentage = maxBoost > 0 ? (currentBoost / maxBoost * 100).toFixed(1) : "0";
+  const percentage =
+    maxBoost > 0 ? ((currentBoost / maxBoost) * 100).toFixed(1) : "0";
 
   console.log(`Found: ${fullName}`);
   console.log(`  Address: 0x${ptr.toString(16).toUpperCase()}`);
-  console.log(`  Boost: ${currentBoost.toFixed(2)} / ${maxBoost.toFixed(2)} (${percentage}%)`);
+  console.log(
+    `  Boost: ${currentBoost.toFixed(2)} / ${maxBoost.toFixed(
+      2
+    )} (${percentage}%)`
+  );
   console.log();
   found++;
 }
 
 if (found === 0) {
-  console.log('No boost components found.');
-  console.log('Make sure you are in a match (not main menu or replay).');
+  console.log("No boost components found.");
+  console.log("Make sure you are in a match (not main menu or replay).");
 } else {
   console.log(`Total: ${found} boost component(s) found`);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rocketleaguesdk",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "TypeScript SDK for Rocket League - Auto-generated type definitions",
   "type": "module",
   "main": "index.ts",
@@ -97,4 +97,4 @@
     "bun-memory": "^1",
     "typescript": "^5"
   }
-}
+}