Rust-Data

A TypeScript program that automatically checks the game Rust to see if its offsets have updated and dumps the game to find them.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

Preview

About The Project

Rust-Data is a tool designed to monitor and extract data from the game Rust. It checks for updates to the game's offsets and dumps the game to find the latest offsets. This can be particularly useful for developing hacks for the game and removing the manual process of updating offsets.

(back to top)

Built With

• TypeScript
• Node.js
• SteamCMD
• IL2CPP
• Yarn

(back to top)

Getting Started

To get a local copy up and running follow these steps.

Installation

1. Install node and yarn
2. Download IL2CPP from github releases
3. Add the contents to a folder, I suggest saving to /programs/il2cpp.
4. Install SteamCMD CLI

   winget install Valve.SteamCMD

5. Clone the repo

   git clone https://github.com/erobin27/Rust-Data.git

6. Install yarn packages

   yarn install

7. Add you .pem for github, I suggest saving to /programs
8. Setup your .env file, this will include all secret variables and paths to things like il2cpp, output, .pem, etc.

   #Example .env File
   DUMP_CS_PATH='./programs/il2cpp/dump.cs'
   HEADER_OUTPUT='output/rust.h'
   
   GITHUB_APP_ID='8897852'
   GITHUB_CLIENT_ID='Iv1.1d37sdf6s485'
   GITHUB_CLIENT_SECRET='abcs310sfse356687546ds7sdda1'
   GITHUB_INSTALLATION_ID='46575654'
   GITHUB_PEM_PATH='./programs/my-pem.private-key.pem'
   
   STEAM_USERNAME='steam-name-here'
   STEAM_PW='steam-pw-here'
   
   # App Settings
   MINUTES_BETWEEN_CHECKS='5'
   TARGET_GH_USERNAME='erobin27'
   TARGET_GH_PROJECT='Rust-DMA'
   OFFSET_FILE_PATH='RustDMA/SDK/rust.h'               # Full path: Rust-DMA/RustDMA/SDK/rust.h
   ITEM_IDS_FILE_PATH='RustDMA/SDK/rust_items.h'       # Full path: Rust-DMA/RustDMA/SDK/rust_items.h

(back to top)

GitHub App Setup

If you need to integrate the app to update your github files you can do the following

1. Navigate to the app page https://github.com/settings/apps/offset-updater
2. Grab the App ID and Client ID

3. Generate your secret and store it

4. Generate your private key (.pem) it will download a file for you

5. Find your installation id, idk where you get that.

6. Save all of the data you've gathered in your .env

(back to top)

Usage

1. setup your .env accordingly
2. run yarn install
3. run yarn start:dev and the offsets will be dumped every 5 minutes
4. you should have files created like this, if so you have setup everything correctly

(back to top)

Roadmap

• Setup a frontend

See the open issues for a full list of proposed features (and known issues).

(back to top)

License

Distributed under the MIT License.

(back to top)

Contact

idgnfs - @idgnfs

Project Link: https://github.com/erobin27/Rust-Data

(back to top)

Acknowledgments

• Based on RustBlazeDumper by Akandesh
• Utilizes Il2CppDumper for dumping unity games

(back to top)