Skip to content

christerjohansson/rockstar-mods-cleaner

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 

Repository files navigation

Rockstar Games Cleaner Header

Rockstar Games Cleaner

A simple utility to temporarily disable or restore mods in your Red Dead Redemption 2 or Grand Theft Auto V game folders by moving mod files to and from a mods_disabled folder.

This tool helps you quickly switch between a "clean" (Vanilla) game state for Online play and a "modded" state for Single Player, without deleting your mods.

Versions & Branches

This repository hosts two distinct versions of the cleaner, maintained on separate branches:

Game Branch Tool Name
Red Dead Redemption 2 main rdr2cleaner.py / RDR2ModsCleaner.exe
Grand Theft Auto V gtav-online gtavcleaner.py / GTAVModsCleaner.exe

Switching Versions

To access the specific cleaner for your game, check out the corresponding branch:

# For GTA V
git checkout gtav-online

# For RDR2
git checkout main

Usage

  1. Get the Tool:
    • Download the executable (.exe) from the repository (if available).
    • Or run the Python script directly.
  2. Place in Game Folder:
    • Put RDR2ModsCleaner.exe (or script) in your Red Dead Redemption 2 root folder.
    • Put GTAVModsCleaner.exe (or script) in your Grand Theft Auto V root folder.
    • Put index.md in the same folder as the executable.
  3. Run the Tool: Double-click the executable or run the script via terminal.
  4. Select Option:
    • (1) Disable mods: Moves all files not part of the base game (mods, logs, etc.) to a mods_disabled folder.
    • (2) Enable mods: Restores files from mods_disabled back to the game folder.

How It Works

The tool uses a predefined list of "Vanilla" (original) game files.

  • Base Game Files: Kept in the game folder.
  • Unknown Files: Assumed to be mods and moved to mods_disabled.
  • Safety: The tool never moves itself, its config (if applicable), or the mods_disabled folder.

Note: The GTAV version includes an embedded list of all vanilla files and requires no extra configuration. The RDR2 version works similarly but may support an optional index.md for custom exclusions.

Building from Source

If you have Python installed, you can build the executable yourself using PyInstaller.

  1. Install PyInstaller:
    pip install pyinstaller
  2. Navigate to the tool's folder (switch to the correct branch first!).
  3. Build:
    # For RDR2
    pyinstaller --onefile --console --clean --icon=cowboy.ico --name "RDR2ModsCleaner" rdr2cleaner.py
    
    # For GTA V
    pyinstaller --onefile --console --clean --icon=gta.ico --name "GTAVModsCleaner" gtavcleaner.py
  4. The new .exe will be in the dist folder.

License

Licensed under the MIT License.

About

A simple utility to temporarily disable or restore mods in your Red Dead Redemption 2 or Grand Theft Auto V game folders by moving mod files.

Topics

Resources

Stars

Watchers

Forks

Contributors