rl-item-mod 1.0.2 → 1.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +10 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -13,6 +13,16 @@ A powerful, user-friendly Node.js CLI tool for performing visual asset swaps in
13
13
  - **Automated Backups**: Automatically backs up original game assets before patching, with a one-click CLI restore feature.
14
14
  - **Item Database**: Uses a built-in `items.json` database for fuzzy-searching and mapping in-game item names directly to their underlying UPK files.
15
15
 
16
+ ## ⚠️ Warning - Some Swaps Will Crash the Game
17
+
18
+ > **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:
19
+
20
+ > Thumbnails in general cause a lot of crashes, as well as bodies and goal explosions.
21
+
22
+ > 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
23
+
24
+ <img width="571" height="298" alt="image" src="https://github.com/user-attachments/assets/e09d09eb-1e0e-499c-9ddd-74fea68163d0" />
25
+
16
26
  ## Installation
17
27
 
18
28
  ### Prerequisites
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "rl-item-mod",
3
- "version": "1.0.2",
3
+ "version": "1.0.3",
4
4
  "type": "module",
5
5
  "description": "A comprehensive CLI tool for safely applying visual asset swaps to Rocket League UPK files with full encryption and binary offset handling.",
6
6
  "main": "dist/index.js",