rocketleaguesdk 1.0.0

package/enums/index.ts

@@ -0,0 +1,17 @@
+/**
+ * Enums Index
+ * Auto-generated by Stev Peifer
+ *
+ * Enums are exported as namespaces for consistency.
+ * Usage: import { TAGame } from "rocketleaguesdk/enums";
+ *        TAGame.EBoostType
+ */
+
+export * as Engine from './Engine';
+export * as Core from './Core';
+export * as IpDrv from './IpDrv';
+export * as GFxUI from './GFxUI';
+export * as AkAudio from './AkAudio';
+export * as OnlineSubsystemEOS from './OnlineSubsystemEOS';
+export * as ProjectX from './ProjectX';
+export * as TAGame from './TAGame';

package/examples/basic.ts

@@ -0,0 +1,236 @@
+/**
+ * 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.
+ *
+ * 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;
+
+// FNameEntry layout - structure in GNames array
+const FNameEntry = {
+  Name: 0x18,      // Offset to the actual name string (wide string)
+} as const;
+
+// 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
+} as const;
+
+// =============================================================================
+// MEMORY ACCESS
+// =============================================================================
+
+// Open the process
+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?');
+}
+
+const base = module.base;
+
+// Calculate absolute addresses from base + offset
+const gNamesPtr = rl.uPtr(base + GNAMES_OFFSET);
+const gObjectsPtr = rl.uPtr(base + GOBJECTS_OFFSET);
+
+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()}`);
+console.log();
+
+// =============================================================================
+// NAME RESOLUTION
+// =============================================================================
+
+/**
+ * Get a name string from GNames by index.
+ * GNames is a global array of all unique name strings in the engine.
+ *
+ * @param index - Index into the GNames array
+ * @returns The name string
+ */
+function getName(index: number): string {
+  try {
+    // GNames is an array of pointers, 8 bytes each (64-bit)
+    const entryPtr = rl.uPtr(gNamesPtr + BigInt(index) * 8n);
+    if (entryPtr === 0n) return "";
+
+    // Read the wide string at FNameEntry.Name offset
+    // FNameEntry structure: [0x00-0x0F: metadata] [0x10+: name string]
+    const namePtr = entryPtr + BigInt(FNameEntry.Name);
+
+    // 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');
+    return nullIdx >= 0 ? str.slice(0, nullIdx) : str;
+  } catch {
+    return "<error>";
+  }
+}
+
+// =============================================================================
+// OBJECT ITERATION
+// =============================================================================
+
+/**
+ * Get the class name of a UObject.
+ *
+ * Every UObject has a Class pointer that points to its UClass.
+ * The UClass itself is a UObject, so we can get its name.
+ *
+ * @param objPtr - Pointer to the UObject
+ * @returns Class name string
+ */
+function getClassName(objPtr: bigint): string {
+  try {
+    // Read the Class pointer from the UObject
+    const classPtr = rl.uPtr(objPtr + BigInt(UObject.Class));
+    if (classPtr === 0n) return "";
+
+    // Get the name index from the class UObject
+    const nameIndex = rl.i32(classPtr + BigInt(UObject.Name));
+    return getName(nameIndex);
+  } catch {
+    return "<error>";
+  }
+}
+
+/**
+ * Get the full name of a UObject (including outer chain).
+ *
+ * Format: "ClassName OuterChain.ObjectName"
+ * Example: "CarComponent_Boost_TA TAGame.Default__Car_TA.BoostComponent"
+ *
+ * @param objPtr - Pointer to the UObject
+ * @returns Full name string
+ */
+function getObjectFullName(objPtr: bigint): string {
+  try {
+    const className = getClassName(objPtr);
+    const nameIndex = rl.i32(objPtr + BigInt(UObject.Name));
+    const name = getName(nameIndex);
+
+    // Build outer chain (package path)
+    const outers: string[] = [];
+    let outer = rl.uPtr(objPtr + BigInt(UObject.Outer));
+    while (outer !== 0n) {
+      const outerNameIdx = rl.i32(outer + BigInt(UObject.Name));
+      outers.unshift(getName(outerNameIdx));
+      outer = rl.uPtr(outer + BigInt(UObject.Outer));
+    }
+
+    const path = outers.length > 0 ? outers.join('.') + '.' + name : name;
+    return `${className} ${path}`;
+  } catch {
+    return "<error>";
+  }
+}
+
+/**
+ * Find all objects of a specific class.
+ *
+ * This iterates through GObjects (up to MAX_OBJECTS) and filters by class name.
+ *
+ * @param className - The class name to search for
+ * @yields Object pointer and full name
+ */
+function* findByClass(className: string): Generator<{ ptr: bigint; fullName: string }> {
+  const MAX_OBJECTS = 500_000;
+
+  for (let i = 0; i < MAX_OBJECTS; i++) {
+    try {
+      // GObjects is an array of pointers, 8 bytes each
+      const ptr = rl.uPtr(gObjectsPtr + BigInt(i) * 8n);
+      if (ptr === 0n) continue;
+
+      // Check if this object is the class we want
+      if (getClassName(ptr) === className) {
+        yield { ptr, fullName: getObjectFullName(ptr) };
+      }
+    } catch {
+      // Skip unreadable objects
+    }
+  }
+}
+
+// =============================================================================
+// SDK TYPE USAGE EXAMPLE
+// =============================================================================
+
+/**
+ * Read an FVector struct from memory.
+ *
+ * FVector is a Core struct - see: structs/Core.ts
+ * Layout: { X: f32, Y: f32, Z: f32 } at offsets 0x00, 0x04, 0x08
+ *
+ * @param address - Memory address of the FVector
+ * @returns FVector object with X, Y, Z components
+ */
+function readFVector(address: bigint): Structs.Core.FVector {
+  const v = rl.vector3(address);
+  return { X: v.x, Y: v.y, Z: v.z };
+}
+
+// =============================================================================
+// 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();
+
+let found = 0;
+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";
+
+  console.log(`Found: ${fullName}`);
+  console.log(`  Address: 0x${ptr.toString(16).toUpperCase()}`);
+  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).');
+} else {
+  console.log(`Total: ${found} boost component(s) found`);
+}
+
+// Clean up
+rl.close();

package/index.ts

@@ -0,0 +1,33 @@
+/**
+ * Rocket League SDK
+ * Auto-generated by Stev Peifer
+ *
+ * Usage:
+ *   import { Structs, Classes, Enums } from "rocketleaguesdk";
+ *   Structs.TAGame.FCarStateData
+ *   Classes.TAGame.UCar_TA
+ *   Enums.TAGame.EBoostType
+ *
+ * Or import directly from subdirectories:
+ *   import { TAGame } from "rocketleaguesdk/classes";
+ *   TAGame.UCar_TA
+ */
+
+// Core types (FName, FScriptDelegate)
+export * from './types';
+
+// Structs namespace
+export * as Structs from './structs';
+
+// Classes namespace
+export * as Classes from './classes';
+
+// Enums namespace
+export * as Enums from './enums';
+
+// Parameters namespace
+export * as Parameters from './parameters';
+
+// Note: Constants are available via separate imports:
+// import { ... } from 'rocketleaguesdk/constants'
+// import { ... } from 'rocketleaguesdk/constants/TAGame'

package/package.json

@@ -0,0 +1,100 @@
+{
+  "name": "rocketleaguesdk",
+  "version": "1.0.0",
+  "description": "TypeScript SDK for Rocket League - Auto-generated type definitions",
+  "type": "module",
+  "main": "index.ts",
+  "module": "index.ts",
+  "types": "index.ts",
+  "exports": {
+    ".": {
+      "bun": "./index.ts",
+      "import": "./index.ts",
+      "types": "./index.ts"
+    },
+    "./types": {
+      "bun": "./types/index.ts",
+      "import": "./types/index.ts",
+      "types": "./types/index.ts"
+    },
+    "./types/*": {
+      "bun": "./types/*.ts",
+      "import": "./types/*.ts",
+      "types": "./types/*.ts"
+    },
+    "./structs": {
+      "bun": "./structs/index.ts",
+      "import": "./structs/index.ts",
+      "types": "./structs/index.ts"
+    },
+    "./structs/*": {
+      "bun": "./structs/*.ts",
+      "import": "./structs/*.ts",
+      "types": "./structs/*.ts"
+    },
+    "./classes": {
+      "bun": "./classes/index.ts",
+      "import": "./classes/index.ts",
+      "types": "./classes/index.ts"
+    },
+    "./classes/*": {
+      "bun": "./classes/*.ts",
+      "import": "./classes/*.ts",
+      "types": "./classes/*.ts"
+    },
+    "./enums": {
+      "bun": "./enums/index.ts",
+      "import": "./enums/index.ts",
+      "types": "./enums/index.ts"
+    },
+    "./enums/*": {
+      "bun": "./enums/*.ts",
+      "import": "./enums/*.ts",
+      "types": "./enums/*.ts"
+    },
+    "./parameters": {
+      "bun": "./parameters/index.ts",
+      "import": "./parameters/index.ts",
+      "types": "./parameters/index.ts"
+    },
+    "./parameters/*": {
+      "bun": "./parameters/*.ts",
+      "import": "./parameters/*.ts",
+      "types": "./parameters/*.ts"
+    },
+    "./constants": {
+      "bun": "./constants/index.ts",
+      "import": "./constants/index.ts",
+      "types": "./constants/index.ts"
+    },
+    "./constants/*": {
+      "bun": "./constants/*.ts",
+      "import": "./constants/*.ts",
+      "types": "./constants/*.ts"
+    }
+  },
+  "keywords": [
+    "rocket-league",
+    "unreal-engine",
+    "sdk",
+    "types",
+    "typescript",
+    "bun"
+  ],
+  "author": "Stev Peifer",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ObscuritySRL/RocketLeagueSDK"
+  },
+  "engines": {
+    "bun": ">=1.0.0"
+  },
+  "devDependencies": {
+    "@types/bun": "latest"
+  },
+  "peerDependencies": {
+    "bun-memory": "^1",
+    "typescript": "^5"
+  }
+}