rl-item-mod
v1.0.6
Published
A comprehensive CLI tool for safely applying visual asset swaps to Rocket League UPK files with full encryption and binary offset handling.
Maintainers
Readme
RLItemMod
A powerful, user-friendly Typescript CLI tool for performing visual asset swaps in Rocket League.
Overview
RLItemMod provides an interactive terminal wizard that allows you to swap in-game items (e.g., swapping a standard boost for Alpha Reward). Under the hood, it seamlessly invokes the advanced RLUPKTools Python engine to accurately parse .upk encryption, perfectly expand Name Table string offsets, and rebuild the package architecture without causing game crashes.
Features
- Interactive Wizard: A beautiful command-line interface to search for and select your source and target items.
- Python Interop: Leverages a robust Python backend to handle complex LZO decompression, AES decryption, and binary offset shifting.
- Automated Backups: Automatically backs up original game assets before patching, with a one-click CLI restore feature.
- Item Database: Uses a built-in
items.jsondatabase for fuzzy-searching and mapping in-game item names directly to their underlying UPK files.
⚠️ Warning - Some Swaps Will Crash the Game
Swapping certain asset types is not yet fully supported and will cause Rocket League to crash on load. This is a known limitation of the current version and is being worked on. Until a fix is released, avoid swapping the following:
Thumbnails in general cause a lot of crashes, as well as bodies and goal explosions.
If a swap you attempt causes a crash, you should validate game files, and when a crash occurs on an item use the Restore backups as shown in this screenshot
Installation
Prerequisites
- Node.js (v18+)
- Python 3.8+ (must be available in your system PATH)
Global Install (Recommended)
npm install -g rl-item-modpip install cryptography<<<<<<< HEAD
=======
ee91cfbd1e75da9690dd800c55fa7d876cdd1261
Local Development
git clone https://github.com/bitsfdb/RLItemMod.git
cd RLItemMod
npm install
npm run build
npm linkUsage
Simply launch the interactive wizard from your terminal:
rl-item-modOr run directly via npx:
npx rl-item-mod@latestCredits
Massive credits to CrunchyRL/RLUPKTools for making this repository possible. The advanced Python engineering for parsing and shifting Unreal Engine 3 UPK binaries was instrumental in making this project work safely.
<<<<<<< HEAD
Support
Contact me on discord: @sfdb Or on the support server https://discord.gg/2HhBNbrGMj
Support
Contact me on discord: @sfdb Or on the support server https://discord.gg/nP4GJKmnWE
ee91cfbd1e75da9690dd800c55fa7d876cdd1261
License
MIT
