/source2sdk-lookup

Primary LanguageRustGNU General Public License v3.0GPL-3.0

Source2Gen SDK Offset Lookup Tool

This project is a Rust-based tool designed to parse SDK files generated by the source2gen project. It provides a convenient interface for looking up fields of game structures using their memory offsets.

Features

  • Look up fields by offset in a user-friendly manner
  • Platform-independent, unlike source2gen
  • Lightweight and efficient (60ms startup time, negligible lookup time)
  • Convenient .env configuration
  • Easy to read color-coded output

Getting Started

Before using this SDK offset parser, ensure you have the required Rust environment to compile and run Rust applications. If you're new to Rust, you can get started here.

Prerequisites

  • Rustc and Cargo
  • SDK files generated by source2gen

Setup Environment

  1. Clone this repository to your local machine.
  2. Copy .env.example to .env.
cp .env.example .env
  1. Open the .env file in a text editor and specify the path to your client.hpp file.
CLIENT_HPP_PATH="/path/to/your/client.hpp"
  1. Save .env with the updated path.

Compilation

After setting up your environment, you can compile the project using Cargo:

cargo build --release

The compiled binary will be located in the target/release directory.

Usage

Run the compiled binary from to start the application. The interface will prompt you to enter an offset value and find corresponding fields in the parsed SDK files.

./target/release/sdk_offset_parser

To exit, simply type exit and press enter, or send a SIGINT signal (Ctrl+C).

Credits

License

This project is licensed under the GPL 3.0 License - see the LICENSE file for details.