> For the complete documentation index, see [llms.txt](https://solaartw.gitbook.io/developer/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://solaartw.gitbook.io/developer/documentation/utilities/redmod/reference-sheets/usage.md).

# Usage

## Usage

REDmod is a tool to stage installed mods to work with a modded game.There are also various commands for modders to work with the game's assets.

### Using Mods <a href="#using-mods" id="using-mods"></a>

The game loads mods from this path: `<Cyberpunk 2077>/mods/<name>`.

> EXAMPLE: A simple archive mod `C:\Gog\Cyberpunk 2077\mods\modA\archives\mod_a.archive`.

You need to **deploy** your installed mods before playing a modded game.You can handle deployment and load order with

* the **REDlauncher** that comes with the game
* **Vortex** Mod Manager from NexusMods
* or use the REDmod WolvenKit integration and manage your mods easily from within the **WolvenKit Mod Manager**.

You need to **start a modded game** in order to load the deployed mods in game.

> Legacy archive mods in `<Cyberpunk 2077>/archive/pc/mod` are still supported but their load order cannot be managed with REDmod.

### Deploying Mods and Starting the Game <a href="#deploying-mods-and-starting-the-game" id="deploying-mods-and-starting-the-game"></a>

REDmod can stage installed mods to work when the game starts with the `modded` flag:

* scripts in `<Cyberpunk 2077>/mods/<name>/scripts` are compiled into a modded script blob
* tweak files in `<Cyberpunk 2077>/mods/<name>/tweaks` are compiled into a modded tweakDB blob
* sound files in `<Cyberpunk 2077>/mods/<name>/customSounds` are staged to load

In order to utilize deployed mods with REDmod, you need to run the game in a specific *modded* mode. You can do this by launching the game through WolvenKit or manually by specifying a command parameter.

#### **GOG Galaxy** <a href="#gog-galaxy" id="gog-galaxy"></a>

* Open GOG - *Cyberpunk 2077*
* Click **Manage Installation** -> **Configure ...**
* Open the **Features** Tab
* Select **Enable mods**
* Click **OK**
* Play the game
* A window will open showing progress on mod deployment.

![](https://820263885-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4gzcGtLrr90pVjAWVdTc%2Fuploads%2Fgit-blob-c13d81874f2974523580539a5ec46dd8aefdc5ed%2Fredmod_gog.png?alt=media)

#### **Steam** and **Epic** <a href="#steam-and-epic" id="steam-and-epic"></a>

* Navigate to *Cyberpunk 2077*
* Click **Play**
* Click the **Settings** button and **Enable mods**
* Click **Play** (Do not skip this)
* A window will open showing progress on mod deployment.

![](https://820263885-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4gzcGtLrr90pVjAWVdTc%2Fuploads%2Fgit-blob-8c755ebc06c02f75bbc1be09fb7a3366edefdfcc%2Fgog_prelauncher.png?alt=media)

### Conflicts and Load Order <a href="#conflicts-and-load-order" id="conflicts-and-load-order"></a>

Conflicts are handled on a per-file basis, but can be handled by specifying a specific *load order*.**Example:** **modA** contains a script file `C:\Gog\Cyberpunk 2077\mods\modA\scripts\cyberpunk\player\player.script`. **modB** contains a script file with the same name `C:\Gog\Cyberpunk 2077\mods\modB\scripts\cyberpunk\player\player.script`.This will discard all changes **modB** made, since by default, REDmod and the game loads mods alphabetically (modA overrides changes in modB).However, you can specify a load order with REDmod, which the game will respect.

### Advanced Topics <a href="#advanced-topics" id="advanced-topics"></a>

#### Deploying Mods - Manually <a href="#deploying-mods-manually" id="deploying-mods-manually"></a>

The REDmod `deploy` command stages installed mods to work when the game starts with the `modded` flag.

#### Deploying Mods - WolvenKit Integration <a href="#deploying-mods-wolvenkit-integration" id="deploying-mods-wolvenkit-integration"></a>

* Open the WolvenKit Mod Manager.
* Click the *Deploy Mods* button in the toolbar.

You will see all installed mods in your game. Enable the mods you would like to play with.

#### Handling Conflicts - Manually <a href="#handling-conflicts-manually" id="handling-conflicts-manually"></a>

You can specify a specific load order with the **-mod** parameter:redmod deploy -root="C:\Gog\Cyberpunk 2077" -mod=modB,modA,modCThis will override changes to `\cyberpunk\player\player.script` that **modA** makes in favor of **modB**. It will also tell the game to load **modB** before **modA** and **modC**.

#### Handling Conflicts - WolvenKit integration <a href="#handling-conflicts-wolvenkit-integration" id="handling-conflicts-wolvenkit-integration"></a>

* Open the WolvenKit Mod Manager.
* Adjust the load order by dragging and dropping rows.
* Click the *Deploy Mods* button.

You can adjust the load order by dragging and dropping the installed mods inside the mod manager.When you click the *Deploy Mods* button, the current load order will be forwarded to redmod.exe and mods will be deployed and loaded in this order.

#### Starting a Modded Game - Manually <a href="#starting-a-modded-game-manually" id="starting-a-modded-game-manually"></a>

To start a modded game that loads mods deployed by REDmod use the `-modded` flag on **Cyberpunk2077.exeExample:**&#x43;yberpunk2077.exe -moddedThis however will skip the initialization process that should be done after any new REDmod mod install.

> INFO The executable is located at `<Cyberpunk 2077>\bin\x64\Cyberpunk2077.exe`