To dowload the tool and know more about it, go to the WolvenKit Wiki:

WolvenKit is an open-source modding tool for Cyberpunk 2077 and The Witcher 3: Wild Hunt. Our vision is to develop a standalone software which can read and write all REDengine file formats, simplify and accelerate modding workflows, and help you create great mods for great games.

Summary

Published: ??? by Last documented update: Nov 29 2024 by

This page will show you how to install the Wolvenkit Blender Plugin from a github release or tag. If you want to install the bleeding edge, please check Installing from github source instead.

Compatibility

Step 0: Uninstall the old version

1. Open the Blender Preferences (Toolbar: Edit -> Preferences) and select the AddOns tab

Complete either of the options below:

Click the Remove button

The build-in Blender way. Should work. If it doesn't check the second option

Delete the files on your disk

Check the plugin's file entry. It will usually be something like this:

%APPDATA%\Blender Foundation\Blender\4.0\scripts\addons\i_scene_cp77_gltf

Navigate there with your Windows Explorer (Hotkey: Windows+R, paste the path above after changing your Blender version), and delete everything — either the entire folder, or all files inside.

Step 1: Install the plugin

Download the latest release of the plugin from github:

1. On the releases page, find the most recent release

2. Scroll past the change notes to the Assets section

3. Download the zip file with the plugin:

1. Start Blender

2. Open the Blender Preferences (Toolbar: Edit -> Preferences) and select the AddOns tab

1. Click the "Install" button and select the zip file you downloaded in step 2

Step 2: Enable the plugin

After you have successfully installed the plugin, you can now use the search bar to find it:

Make sure the box is checked and restart Blender.

Troubleshooting

I can't (un)install the plugin!

You can do both by hand. Find your Blender install's plugin folder, the path will look something like this (replace 3.6 with your Blender version):

%APPDATA%\Blender Foundation\Blender\3.6\scripts\addons

Inside the plugins folder, the Wolvenkit Blender IO Suite will be installed to the subfolder i_scene_cp77_gltf.

To uninstall the plugin, delete the entire folder.

To install the plugin, find the folder in your downloaded zip file that contains the file __init__.py, move it here, and rename it.

Now, restart Blender.

Summary

Published: 22.09.2024 by Last documented update: 22.09.2024 by

This guide will show you how to download and install the Wolvenkit Blender IO Suite from github source.

Step 1: Download from github

1. Head to the Wolvenkit Blender IO suite's github repository

2. Click the green Code button

3. Click "Download ZIP" at the bottom

1. You should have downloaded a file called Cyberpunk-Blender-add-on-main.zip.

Step 2: Finding the install location

2.1: Find the correct install path

1. Open the Blender Preferences (Toolbar: Edit -> Preferences) and select the AddOns tab

2. Search for cyberpunk

3. See the current install path under File. It should be something like this:

C:\Users\USERNAME\AppData\Roaming\Blender Foundation\Blender\VERSION\scripts\addons\i_scene_cp77_gltf\__init__.py

1. Everything before the __init__.py is the path to the current install.

2.2: Delete the old install

1. Navigate your Windows Explorer to the path you found in 2.3 (Shortcut: Windows+R, type %APPDATA%, confirm, then browse from there)

2. Delete the whole i_scene_cp77_gltf folder.

3. Leave the explorer window open, you need it for Step 3!

Step 3: Extract the download

1. Open Cyberpunk-Blender-add-on-main.zip that you downloaded in step 1.

2. Find the folder named i_scene_cp77_gltf. This is the blender add-on:

1. Copy or drag the folder to the addons folder from step 2.2.

Step 3: Restart Blender

After restarting Blender, you now have the very latest version of the plugin. If you want anything more recent, you have to become a developer yourself.

Happy modding!

Summary

Published: Apr 19 2024 by Last documented update: Apr 19 2024 by

This page will tell you how to resolve error messages from the Wolvenkit Blender IO Suite.

Assign weights before exporting

This should only happen for meshes with armatures.

• Switch to the Data tab (the green triangle)

• If you don't have vertex groups, add one

• If you already have vertex groups, select the one named to the bone closest to your ungrouped vertices

• If you aren't already, switch to Edit Mode (Hotkey: Tab)

• Click the "Assign" button under the vertex groups panel

Ungrouped vertices found

This should only happen for meshes with armatures. You can check the screenshot under #assign-weights-before-exporting for references.

1. Switch to the Data tab (the green triangle)

2. The plugin should have switched your viewport to Edit Mode (if not, do it yourself - hotkey: Tab)

3. Find out which vertices are the problem by moving them around in the edit view

4. In the list of vertex groups, select the armature bone closest to your ungrouped verts

5. Click the "Assign" button under the vertex groups panel

6. Rinse and repeat the process for all submeshes until the plugin lets you export

No armature objects are selected

You are trying to export a pose, but you didn't select your armature. Click on the armature object in the outliner:

No meshes selected

You're trying to export something, but you haven't selected any meshes. Select everything that you want to export in the outliner (top-right panel) - the armature parent will be auto-selected for you.

Meshes must have UV layers

For Cyberpunk material assignments to work, your mesh must have UV maps.

Switch to the Data tab and add one:

You should now be able to export, but your material will most likely look funky. To remedy this, refer to Adding decals -> #step-5-uv-projection

All faces must be triangulated before exporting

Triangulation means that faces must have exactly three corners.

1. The plugin should have switched the viewport to Edit Mode. If not, do it yourself (Hotkey: Tab)

2. Triangulate faces (Hotkey: Ctrl+T). The default settings are fine.

3. You should now be able to export.

Vertex groups not assigned to a bone

You have vertex groups in your mesh that don't have a corresponding bone in the armature. Run the following Python script to delete them:

Armature missing

The armature (rig, skeleton) is the thing that makes your mesh move in-game.

If your mesh isn't supposed to move, check #amm-props-you-dont-need-an-armature

If your mesh is supposed to move with the body, check #equipment-you-need-an-armature

AMM props: You don't need an armature

It's enough to check the "Export as Static Prop" box during export, and the error will go away.

Equipment: You need an armature

You should have an armature in your .blend file because you're importing over an original Cyberpunk mesh. If you don't, you might want to refer to a guide such as Replace a player item with an NPC item and follow the steps.

Open the Modifiers tab (the orange wrench) and repeat the following steps for each mesh:

1. Make sure that there is exactly one Armature modifier present. If there is none, click Add Modifier and add one.

2. Click into Object and select the armature that your mesh is parented to.

Each submesh must have less than 65,535 vertices

If your submesh has >= 65,535 vertices

If your submesh has < 65,535 vertices

That's due to how the Blender .gltf export works. The only thing you can do to avoid the issue is to make sure that no two vertices share the same UV coordinate.

1. switch to the UV editing perspective ( -> UV Mapping: texturing a 3d object)

2. Turn on UV Sync Selection:

1. Once you have found an overlapping vertex, select linked (Hotkey: Ctrl+L)

2. Move the entire UV island by a whole tile in any direction (Hotkey: e.g. G -> X -> 1)

3. Repeat the process until there are no more overlapping islands.

Summary

Published: ??? by Last documented edit: May 26 2024 by

This page lists step-by-step instructions for the export and import of game files.

The Wolvenkit parts of the workflow will link you to the , where you can find screenshots and (hopefully) up-to-date descriptions.

Wait, this is not what I want!

• (Wolvenkit wiki)

• (Wolvenkit wiki)

• If this is your first time using Blender, check Blender: Getting Started

• Archived: Exporting and importing meshes (has additional information that might come in handy)

Meshes

Export from Wolvenkit

For where to export a mesh, see

For how to export a mesh, see

Importing into Blender

Select File -> Import -> Cyberpunk GLTF

In the Blender File view, find the glb you exported from Wolvenkit. By default, the textures will be saved to your material depot in PNG format already.

Exporting from Blender

Select File -> Export -> Cyberpunk GLB

For an explanation of the sidebar settings on the right, read on below the picture.

Animations (checkbox)

Do not check this box if you are exporting a .glb file without animation data (it is for exporting animations)

Limit to Selected Meshes

By default, the Wolvenkit Blender IO Suite will only export selected meshes and their parent armatures. Unchecking this box will display the Export Visible Meshes checkbox, which is unchecked by default.

If you don't check either of these boxes, the plutin will export all meshes and armatures into the same .glb file. You usually do not want this.

Importing into Wolvenkit

Animations

Export from Wolvenkit

Importing into Blender

The process of importing animations into Blender is the same as it is with meshes.

Exporting from Blender

1. Select your armature

2. Follow the process for #meshes, but check the #animations checkbox in the side panel.

Importing into Wolvenkit

Entities

Export from Wolvenkit

You can export an entity by adding it to your project and running the corresponding script from inside Wolvenkit. Here are the relevant guides:

Importing into Blender

After you have exported the entity from Wolvenkit via script, switch to Blender and select File -> Import -> Cyberpunk Entity (.json)

Navigate the file browser to the ent.json in your project's raw folder and import it.

Use Cycles

Will switch the workbench's rendering mode from Eevee to Cycles. This will make sure that the shaders work as intended.

Update Global Illumination

Will fix lighting

With Materials

Will read materials from material.json files, generating shaders in the process.

Include Vehicle Collisions

This option imports a vehicle entities collision bodies for editing. The collision bodies give substance to the mesh and determine how the world responds to the vehicle - without proper collision bodies, your character, NPCs and anything else your vehicle bumps into would pass right through the mesh. Unless you're adding a new vehicle or significantly altering an existing one, you generally want to leave this box unchecked.

Exporting from Blender

Entity export is currently (1.5.0) not supported.

To export edited collision bodies back to .phys.json, simply press the "export collisions" button in the Collision Tools Panel and use the File View to navigate to your original .phys.json.

** Currently only modifying existing .phys files is supported.

Streaming Sectors

Export from Wolvenkit

To export streamingsectors, you have to use the corresponding Wolvenscript. The workflow is documented here.

Importing into Blender

After you have exported the streamingsector from Wolvenkit via script, switch to Blender and select File -> Import -> Cyberpunk StreamingSector

Navigate in the file view to your Wolvenkit project's root file, and select the .cpmodproj file:

Exporting from Blender

The export process is not part of the plugin yet (1.5.0); it is documented here.

Hair profiles (.hp)

Importing to Blender

Editing the hair profile

Select the imported hair and switch to Blender's Shading perspective. Here, you can alter the gradients,

Exporting from Blender

1. Recommended: make sure that your material name in Blender ends with _cards

2. Make sure that your hair mesh is selected

3. In the CP77 Modding panel, select Export Hair Profile

Your new .hp.json file will be generated in the raw folder of Wolvenkit project that you imported the hair mesh from with the name of mod_<material name in Blender>.hp.json:

Summary

Published: ??? by Last documented edit: Feb 12 2024 by

The auto-refitter is a tool developed by that automates the tedious process of refitting meshes for the various body mods.

If you need a tutorial for manual refitting, check R&R: Refitting (step by step) or follow the links from there.

How to auto-refit

With a mesh selected, you can find it in the Mesh Tools section of the CP77 panel. Use the dropdown to select a target body, then click the button to apply the changes:

Modifier cannot be applied to a mesh with shapekeys

Future versions of the plugin will make this process much easier. For now:

1. Duplicate the mesh (Hotkey: Shift+D, Esc)

2. Delete the shapekeys from one of the meshes

3. Delete the modifier from the other mesh

4. After the shapekeys are gone, apply the modifier:

1. Select the mesh without shapekeys (the one you changed by applying the modifier)

2. Switch to the Data tab and create a modifyer by hitting the + button

3. Name your new shapekey Basis. This is how it's supposed to look when no shapekeys are active.

4. Select the mesh with shapekeys (the one with the original shape)

5. Switch to the Data tab, select the second shapekey in the list, and transfer it:

1. Repeat the process with all other shapekeys

2. You can now delete the original mesh.

It shrinks too far!

OK, that's a bit nasty, because it means you'll have to either merge the shapekeys, or create Garment support from scratch (which is easier than it sounds like).

If you want to merge, select the shapekey that you want to change, and set its value as high as you can without clipping. Then, select the "New Shape from Mix" entry in the dropdown menu (see the screenshot above).

You can now delete your original shapekey and rename the newly-created one (which will be called "Key 2" or something like that) to the original's name.

The body I want is not supported!

The lattice modifier has to be created from hand and added to the Wolvenkit Blender IO suite.

TODO: This section will eventually document the steps how you can

• add a body mod to your local version of the plugin

• share that edit with everyone else by having it added officially

Editors

WolvenKit

The open source tool we all know and love, which is getting better with every bug you file.

Notepad++

010 Editor

Assets

Blender

3ds Max

Maya

Substance

Gimp

Krita

Paint.NET

Photoshop

Archived (legacy)

These tools are no longer maintained/supported

Summary

Published: Jan 20 2024 by Last documented update: Apr 19 2024 by

This page contains troubleshooting options for the Wolvenkit Blender IO Suite.

If the plugin gives you error messages on export, please check WKit Blender Plugin: Error messages instead.

If you can't solve your problem with these steps, feel free to reach out on Discord in the #blender-add-on channel.

General Troubleshooting

0. Steam

If you installed Blender via Steam, stay on the stable stream and make sure to keep Blender up-to-date.

1. Make sure that you are on the correct Blender version

As of 1.5.5.1, the plugin supports 4.1.0 and requires >= 4.0.2. This information might be outdated by the time you read it.

You can see the exact Blender version in the lower right corner of the program:

2. Make sure that you are on the latest plugin version

1. Open the preferences from the menu (Edit -> Preferences)

2. Switch to the AddOns tab in the bar on the left

3. In the filter field at the top right of the list, search for cyberpunk

4. Expand the entry and find the Version field

1. Check on github that this is the last available version of the plugin.

2. If it's not, you need to update. Uninstall the old version, then install the most recent plugin

Check the console output

See if Blender encountered any errors by checking the console output. From the menu, select View -> Toggle System Console.

Failed to import materials

Make sure that your Wolvenkit is up-to-date

If that doesn't help, you can also give the Nightly version a try.

Make sure that your Depot is not outdated

The plugin needs your Wolvenkit Depot to a) exist and b) be more or less recent.

If you aren't sure how old your depot is or if you have one at all, it might be time to regenerate:

1. 1. If it's not set, set it now

   2. If it's set: Open the folder in Windows Explorer and delete everything there.

Summary

Published: ??? by Last documented edit: Nov 29 2024 by

This is the landing page for the Wolvenkit Blender plugin. Here, you can find #usage instructions, as well as an overview of its features:

• #animation-tools

• #mesh-tools

• #akl-autofitter

• #collision-tools

• #hair-profiles-.hp

Wait, this is not what I want!

• If this is your first time using Blender, you can check out Blender: Getting Started

• Under Installing the Wolvenkit Blender Plugin, you can find a detailed install guide

• For detailed usage instructions, check WKit Blender Plugin: Import/Export

• The plug-in's source code and original readme are on github

• If you run into issues using the plugin, you can check WKit Blender Plugin: Troubleshooting

Compatibility

Usage

As soon as you have a mesh or armature selected, the viewport toolbar (keyboard shortcut to hide/unhide: n) will show you the CP77 Modding tab:

Features

Animation Tools

In the animation tools, you can find

• shortcuts for playing, renaming and deleting existing animations

• shortcuts to add new actions and insert keyframes

You can load one of Cyberpunk's default armatures at any time:

If you import an .anims file, selecting any armature will give you the option to play any existing animation:

Mesh Tools

Transfer Vertex Weights

Lets you transfer vertex weights from one collection to the other (please read the info box below):

AKL Autofitter

For documentation of the autofitter, see the corresponding wiki page.

Modifiers

Lets you change the armature target (the skeleton that'll move and deform your mesh)

Material Export: Hair

Lets you export a hair profile. For documentation, see #hair-profiles-.hp

UV Checker

With the press of a button, you can switch out the currently active material to a coloured and numbered grid for easier UV mapping.

If the UV checker is currently assigned, pushing the button again will restore the original material.

Collision Tools

The collision tools and -generator can

• generate of convex colliders with the exact shape of your mesh The number of vertices to sample should be set to match the number set in the .phys file in order to ensure successful export

• generate box and capsule colliders with either user specified sizing or sized automatically to match the selected mesh

• export edited collision bodies back to .phys ***currently requires a wolvenkit converted .phys.json file

Summary

Created: Aug 18 2024 by Last documented edit: Aug 18 2024 by

This page describes RHT's Ink Inspector and tells you how to analyze Cyberpunk's UI

Ink Inspector: Inspect

This tab lets you see the UI's entire hierarchy.

If you highlight a row, an overlay will appear on the corresponding parts of the screen.

Ink Inspector: Pick

By binding a custom hotkey, you can analyze any widget on the game's default interface:

Summary

Published: ??? by Last documented update: Jan 20 2024 by

This page will teach you how to download and configure MLSetupBuilder, the tool of choice to edit multilayered materials in Cyberpunk.

At the bottom of the page, you will find . Keep in mind that they are outdated.

Wait, that's not what I want!

• To learn more about , check the link

• To create your own mlmask, check

• To create your own normal map, check

Introduction: What is MLSB?

MLSetupBuilder (commonly referred to as "MLSB") is a Cyberpunk 2077 modding tool to comfortably edit MLSetup files, developed and maintained by Neurolinked.

Installation

For integration with Wolvenkit, install MLSB as a plugin:

1. Click on "Home" in Wolvenkit's title bar

2. Select "Plugins" in the left sidebar

3. If MLSB is installed, you'll see an "Update" button, otherwise, it will say "Install". Do that.

We will now launch MLSB and do the initial setup.

1. In Wolvenkit's Plugin view, click "Open", this will open a Windows Explorer with the install folder (Cyberpunk 2077\tools\neurolinked\mlsetupbuilder)

2. Navigate to the folder with the higest version (at the time of this guide, that is MlsetupBuilder-1.6.7)

3. Start MlsetupBuilder.exe

4. Optional: You can pin that file to your start menu or create a shortcut if you want to launch MLSB directly.

Usage

Here's how (or scroll down for the screenshot):

4. Right-click on the newly created mlsetup.json file

5. Select "Open in MLSetupBuilder"

Using MLSB

As of Version 1.6.7, this is what you will see now:

Start by importing the file from the preview. That will populate the Layer Config box with the MLSetup that you just loaded.

Once you're done:

• select File -> Export

• overwrite the original mlsetup.json

• switch back to Wolvenkit

• in the "raw" folder, right-click on your file

• select "Import/Convert from JSON"

Congratulations — you now have an .mlsetup! If you pack your mod and launch the game, you should now see your changes.

Functions

There are 3 important functions to note:

1. Materials: this manages the tiles, opacity, offset, and roughness of the texture.

1. Color: this manages color and luminosity of the texture.

1. µblend: this manages the pattern and acts as a secondary, tiled normal map. Additionally, the contrast value can be used to block out parts of the layer to create patterns.

Note

Layers

Each and every layer is attached to its own Multilayer layer when converted from .json to .mlsetup. When adding new layers, ensure designating intended functions for each layer as part of the larger Multilayer inside WolvenKit.

About That 3d Viewport

This is where you can load models from the game for a direct preview which layer will affect which parts: simply click on the "Library" button.

MLSB Library

Here, you can either browse to your model directly, or use text search:

After selecting a model, you can close the library browser again. Now selecting a layer will show you directly which parts of the mesh it corresponds to.

That's it! Happy recoloring!

Other Tools inside MLSB

Inside MLSB there are some other tools, the most important one is the Material Composer.

From this window you can import and export .Material.json files ( these files are exported by Wolvenkit with the WithMaterial option). You can edit the materials parameters, adding material or removing them from the material file. Material templates found in the .Material.json file can be put in the Library and then used later for another edit of materials of a completely different mesh. You can duplicate entries just changing the name of the material and putting them in the buffer again (that's what i did to have 10 different material colors that comes for the glass material of the Kendachi Monokatana mod). Material Composer will also display all the material parameters that comes with the material template (materials baked by the CDPR system have their parameters hidden if they were left as default before the baking of the release).

Configuration

Connecting to Wolvenkit

Requirements: Getting the CLI

In MLSetupBuilder 1.6.7, select the menu Help -> download Wolvenkit.CLI and extract the linked version:

1. Now, switch to MLSetupBuilder.

2. Select "File -> Preferences"

3. Apply the following settings:

1. Press Ctrl+R to reload MLSB and make sure that the settings are applied.

Building the depot

1. Open the menu "Build" and select "Repository" to uncook the archives:

1. Select the following settings (if you want to uncook everything, this step can take several hours, so we'll only do the essentials for now)

1. Click "Uncook".

2. Wait. Do not interact with the program in any way until the process has finished - especially interacting with the console might just freeze up the entire windows cmd process. This is not MLSB's fault, but due to a Windows standard implementation.

1. When the process is complete, close the Depot Generator window.

2. Optional: if you can't see any changes, press Ctrl+R to relaod MLSB.

Building the Microblend Depot

2. In the bottom left corner, hit "Start"

3. Wait.

4. When the process is complete, close the Depot Generator window.

5. Optional: if you can't see any changes, press Ctrl+R to relaod MLSB.

Troubleshooting

Generic troubleshooting

Close MLSB, then open %APPDATA%\Mlsetupbuilder\config.json in a text editor and decrement the version by one (e.g. 1.6.8 => 1.6.7). This will force MLSB to re-check its settings.

Alternatively, you can also delete the file and reconfigure.

Generating microblends: [ 0: Error ] - Please fill in an output path

For MLSB <= 1.6.7, you have to use the exact CLI version you find under Help -> Download Wolvenkit.CLI

Help, my Layer Config List says object Object

If you have installed it as a Wolvenkit plugin, that directory will be Cyberpunk 2077\tools\neurolinked\mlsetupbuilder.

There's an exception when generating my depot!

Does the progress bar still move? If yes, then you're good - ignore this.

If not, you haven't left your fingers off MLSB and need to start over. Click "Uncook", then go afk until it's done.

Video Guides

Summary

Last documented edit: Sep 07 2024 by

This page tells you how to use REDmod for mod creation.

Wait, that's not what I want!

• If you want to know what REDmod does, check

• If you're a mod user, check the page in the Mod Users section

What is REDmod? (Developer version)

REDmod is a command line tool developed by CDPR and Yigsoft, which allows us to interact with game files in a variety of ways.

Modules for mod creators:

Folder Structure

An example REDmod might look something like this:

When sharing you mod, you would package the folder that is the name of the mod. You could also package the mods folder with the "mod folder", but it is not necessary and it is assumed one might have other mods in their mods folder anyways.

info.json

For a REDmod to be recognized and loaded by the game engine, you must include an info.json file. This file sits in the root folder of the mod's folder at the same level as the subfolders containing your modded files. There are two required entries and a few optional entries that can be in this json file. At minimum a name field and a version field are needed:

In the above:

• The name field is the mod's name and should generally be the same as the folder the info.json file sits in.

• The version field is the mod's version. The version should generally use "Semantic Versioning"

• The description field is optional for all mods, but it is generally suggested one should include it so other tools have something to display for a given mod.

INFO - Semantic Versioning is a method of versioning where each number gives meaning for a release based on their position. It uses the format MAJOR.MINOR.PATCH where a MAJOR release change is one which will break workflows, MINOR could break a workflow but is generally safe and might introduce deprecations, and a PATCH is a small non breaking change that all users on the same MAJOR and MINOR can update to without any issues.

Summary

Created: Jun 13 2024 by Last documented edit: Aug 18 2024 by

This page will give you an overview about psiberx's mod RedHotTools, give you an , and link you to more detailed documentation on the sub-pages.

What does it do?

Integrated with Cyber Engine Tweaks, Wolvenkit and VisualStudio Code, RHT offers an invaluable toolikit for mod developers:

World Inspector

Inspect the player

Ink inspector

Hot Reload

This feature allows reloading mod files without restarting the game. You can use the CET widget to trigger it at any time, or rely on the integration with WolvenKit.

Script checking

This feature is enabled automatically

• See scripts validation and binding errors

• Prevent game from starting if scripts compilation fails

Installation guide

Summary

Published: Aug 18 2024 by Last documented edit: Aug 18 2024 by

This page describes Red Hot Tools's Hot Reload mechanism.

How it works

Although there is a CET overlay, Hot Reload is fully integrated with Wolvenkit and Visual Studio Code — you don't have to do anything except pushing the right button.

The theory

As you know, Cyberpunk 2077 loads its mods from archive/pc/mod. While you run around in Night City, it will keep them open and use the files inside as it needs them.

By placing .archives inside the hot folder, you put them under the control of RHT, which will add them to the game's internal pool of never-changing content:

But the folder is always empty!

That's because RHT moves the file into mods and splices them into the game's resource pool.

But my changes don't show up!

Red Hot Tools invalidates the game's resources and loads your changes, but things that are already spawned won't be affected. Here is how you can trigger change detection:

• Loading a save (always works)

• Spawning a new copy of your item via CET and equipping that (usually works)

• Despawning and respawning the NPC or world entity you're modifying (usually works)

• Respawn the UI widget (usually works)

• Unequipping and re-equipping your item (sometimes works)

Integrations

Wolvenkit

Simply push the "Hot Reload" button in your toolbar:

Visual Studio Code

Install the extension via Extension Manager's ... menu (Install from VSIX...) and restart VScode. Now you can see the following actions:

The CET overlay

Archives

Here, you can manually trigger a reload of archive extensions (read: .xl files). You only have to do this if you edit an .xl file in archive/pc/mods.

Scripts

Here, you can manually trigger a reload.

You can do this via by running "Hot Reload Scripts" from Visual Studio Code

Tweaks

Here, you can manually trigger a reload.

You can do this via by running "Hot Reload Scripts" from Visual Studio Code

Optional Parameters for meshes

Example Command:

redmod resource-export -depot=<depot> -input=<resource-path> -output=<file> -<optional parameters>

PARAMETERS

Synopsis

Arguments:
  -gameRoot=<depot>
  -inputPath=<file>
  -animset=<resource-path>

Options:
  -outputPath=<resource-path>
  -animationRename=<name>
  -h, --help 

Description

The import command imports an .re animation file into an existing .anims animation set file.

Optional parameters include specifying an existing animation name to rename inside the animset file (otherwise the filename of the .re animation file is used) or specifying a different output path (default is overwrite).

INFO - It is best to name .re animation correctly even if you replace an existing animation, because the imported animation will always have the filename of the .re file.

Arguments

• -gameRoot=<path>

  directory-path to the depot for animset and output (e.g. C:\modding\depot)

INFO - this is the base depot from which relative <resource-paths> are loaded

INFO - You need to have the .rig file used by the .anims animationset present in your depot path.

• -inputPath=<file>

  absolute path to the animation .re file

• -animset=<resource-path>

  resource .animset file to use

INFO - resource path must start with base\ (e.g. base\animations\npc\generic_characters\male_average\open_world\generic_male_average__stand__rh_cane_lh_cigar__01.anims)

Options

• -outputPath=<resource-path>

  resource .anims file name to write, default is to overwrite the input animset (resource path must start with base\)

• -animationRename=<name>

  parameter representing the old name of animation to be replaced by the new animation (default is the filename of the .re animation file)

INFO - the imported animation will always have the filename of the .re file even if you specify the animationRename parameter.

• -?|-h|--help

  Prints out a description of how to use the command.

Examples

• redmod import -gameRoot="E:\modding\depot" -input="E:\raw files\animtest1\macarena_long (1).re" -animset=base\animations\npc\generic_characters\male_average\open_world\generic_male_average__stand__rh_cane_lh_cigar__01.anims -output=base\out\new_test.anims -animationRename=stand__rh_cane_lh_cigar__01__smoke__02"

  Imports the animation file E:\raw files\animtest1\macarena_long (1).re into the animset file E:\modding\depot\base\animations\npc\generic_characters\male_average\open_world\generic_male_average__stand__rh_cane_lh_cigar__01.anims and replaces the animation with the name stand__rh_cane_lh_cigar__01__smoke__02 with the name macarena_long (1). The result is saved to to E:\modding\depot\base\out\new_test.anims.

REDmod can export REDengine .xbm files to several raw formats for editing.

dds: DirectDraw Surface bmp: Windows Bitmap jpg: Joint Photographics Experts Group tga: Truevision Targa png: Portable Network Graphics

XBM PARAMETERS

    -bitmap-mipmap=<uint>           - mipmap selection

    -bitmap-source=<bool>           - export uncooked file (default = false)

    -bitmap-flip=<bool>             - flip texture (default = false)

    -bitmap-gamma=<bool>            - forced gamma setting (default = false)

redmod resource-export -depot="M:\" -input="base\test\example.xbm" -output="M:\base\test\example.png" -bitmap-flip=true

To make a script mod in REDmod:

1. make a new mod and create a new folder here: <Cyberpunk 2077>/mods/MODNAME/scripts

2. copy the .script file(s) you want to change from <Cyberpunk 2077>/tools/redmod/scripts preserving the folder structure!

3. add an info.json file to <Cyberpunk 2077>/mods/MODNAME/scripts with some mod info

{
    "name": "MODNAME",
    "description": "Description for the script mod.",
    "version": "1.0.0",
    "customSounds":    [ ]
}

Done. To test, launch the game with REDmod.

redmod resource-import -depot=<depot> -input=<relative path to file to be imported> -output=<absolute path to the new redengine file>

Redmod can be used to import a large variety of files into REDengine formats for use in your mods.

Summary

Created: Aug 18 2024 by manavortex Last documented edit: Aug 18 2024 by manavortex

This page describes RHT's World Inspector, telliung you what you can do with it.

World Inspector: Inspect

Here, you can inspect world nodes and their properties:

World Inspector: Scan

Here, you can scan for any nodes around you:

If you expand the node properties, you can simply hide them at run-time, or use the integration with Removal Editor to create permanent presets:

World Inspector: Lookup

Reverse search of world nodes and spawned entities by their node IDs (e.g. if you're browsing a sector in Wolvenkit)

World Inspector: Watch (the player)

The world inspector's Watch tab lets you inspect the player puppet and all of their components at runtime.

To make a tweak mod in REDmod:

1. make a new mod and create a new folder here: <Cyberpunk 2077>/mods/MODNAME/tweaks

2. copy the .tweak file(s) you want to change from <Cyberpunk 2077>/tools/redmod/tweaks preserving the folder structure!

3. add a info.json file to <Cyberpunk 2077>/mods/MODNAME/tweaks with some mod info

{
    "name": "MODNAME",
    "description": "Description for the tweak mod.",
    "version": "1.0.0",
    "customSounds":    [ ]
}

Done. To test, launch the game with REDmod.

Audio Modding - WolvenKit Integration

The REDmod sound import tool can be used in a WolvenKit project.

• Add the .wav sound files you wish to import to your /customSounds folder in your mod project

• Click Tools > Sound Modding Tool

• In the Sound Modding Tool, choose which event to mod from the list of game sound events

• Adjust the parameters in the bottom right

• Click Save

Audio Modding - Manually

Place raw .wav audio files inside <Cyberpunk 2077>/mods/<name>/customSounds. Include a info.json file with your mod (<Cyberpunk 2077>/mods/<name>/customSounds/info.json) where you sepcify how to use your custom sounds.

Example

{
  "name": "newmodtest",
  "version": "1.0.0",
  "customSounds": [
    {
      "name": "amb_bl_eq_medical_electronics_small",
      "type": "mod_skip"
    },
    {
      "name": "w_gun_revol_power_overture_fire_suppressor",
      "type": "mod_skip"
    },
    {
      "name": "w_gun_npc_dian_reload",
      "type": "mod_sfx_2d",
      "file": "are_you_sure_about_that.wav",
      "gain": 1.0,
      "pitch": 0.1
    }
  ]
}

Parameters

• name - the game audio event to override

• type - the sound type. Options are:

  • mod_skip: do not play this sound event

  • mod_sfx_2d: will be played without any positions / attenuation

  • mod_sfx_city: has a longer attenuation that is suitable for city sounds

  • mod_sfx_low_occlusion: has a long attenuation that isn't occluded much e.g. a VO or quest sound that you don't want to be muffled

  • mod_sfx_occlusion: medium attenuation with normal occlusion

  • mod_sfx_radio: needs to be tuned to a broadcast channel (e.g. radio)

  • mod_sfx_room: has a shorter attenuation suitable for something that can be heard across a room

  • mod_sfx_street: has a medium attenuation, good for something to be heard down a street

  • mod_sfx_ui: for menu and ui sound replacement

• file - the .wav file to use (inside /customSounds)

• gain and pitch

Animation Modding - WolvenKit Integration

The REDmod animation import tool can be used as a Plugin in WolvenKit.

• Add the .re animation file you wish to import to your /Raw folder in your mod project

• Add the .anims animation set file from the game with the Asset Browser

• Click View > Import/Export tool

• In the Import/Export tool, navigate to Import: a list of all .re animation file in your /Raw folder will appear

• Double click the entry to change the import options:

  • Select the .anims animation set file to import from the dropdown

  • Select the animation name you wish to override from the dropdown

• Click process

INFO - It is best to name .re animation correctly even if you replace an existing animation, because the imported animation will always have the filename of the .re file.

INFO - You need to have the .rig file used by the .anims animationset present in your WolvenKit project.

Animation Modding - Manually

See also: Import Command

The import command imports an .re animation file into an existing .anims animation set file.

Optional parameters include specifying an existing animation name to rename inside the animset file (otherwise the filename of the .re animation file is used) or specifying a different output path (default is overwrite).

INFO - It is best to name .re animation correctly even if you replace an existing animation, because the imported animation will always have the filename of the .re file.

INFO - You need to have the .rig file used by the .anims animationset present in your depot path.

010 Editor is a generic hex editing software which is capable of reading and writing REDengine W2RC files. A custom template for the 010 Editor created by @alphaZomega must be used to parse game files as human-readable.

Download

The 010 Editor can be downloaded from Sweetscape's website

010 Editor Template for Cyberpunk 2077

Setup

1. Install 010 Editor and run it.

2. install alphaZomega's template by navigating to Templates > View Installed Templates, then click Add and add CP77_CR2W.bt.

3. Navigate to your Cybeprunk 2077 installation, locate the oo2ext_7_win64.dll file, then copy and paste the DLL to the same location as the BT template file.

Scripts

Unkarkify and Rebuild

Unpack and pack the compressed "KARK'd" data within a CP77_CR2W file

Erase

Deletes an entire name and value's worth of a section inside the aforementioned formatted file

changeMatHdrs

Changes all the Material headers' numbers inside a file to be a universal one with zero offsets

insertMatHdrs

Creates a new material header inside a file

This is the documentation for the .

Version Compatibility

CyberCAT is version dependent. If you want a savegame to load with a certain version of the game, you must use the compatible version of CyberCAT.

Usage Instructions

On Windows, save games are stored in

1. Import your savegame

2. Make the necessary changes

3. Export your savegame again. Save it in the same folder.

Appearance Presets

After loading a save, you can export V's appearance as a preset from the Appearance tab. This will create a v2preset file, which you can import via Load Preset.

Adding items

You can add items from the Inventory tab or edit existing items by double-clicking on them.

• Switch inventories in the upper right corner

• Edit items by double-clicking them

• Add new items by using the corresponding button

Quest Facts

CyberCAT lets you edit quest facts:

Quest editing: Risks and side effects

While you progress through the main story, Cyberpunk will log your progress by setting quest facts. These are not standardized and will only be checked under specific circumstances, usually when the game is about to trigger the next stage of a quest or event.

Once that moment has passed, there is no way to re-trigger it other than loading an earlier save. This is not an issue of tooling, it's simply due to how Cyberpunk's quest system works.

Can I Change the Outcomes of Quests?

Unfortunately, no. Quest state data is currently not editable with the save editor and there are currently no plans on implementing it.

Can Quest Facts Affect Past and/or Future Quests?

Past: no. Future: Maybe. Almost all quest facts will at best do nothing by setting or changing them and more commonly will break your quest system. There are very few that will work and most are dependent on when they're set.

What Can I Do to Change the Outcome of a Quest?

Your only option is to reload from a previous save and make better choices. If only life worked the same way.

I Really, Really, Really Want to Set a Quest Fact. What Can I Do?

Known Issues

• Appearance editor is disabled until its fully fixed.

  • Only gender and voice tone can be changed.

  • Loading / Saving of presets still works

• Item additions might not fully work yet

Troubleshooting

Folder structure

Make sure that you export to a savegame folder. They contain the following files:

• metadata.9.json

• sav.dat

• screenshot.png

CyberCAT needs those files to correctly export the savegame.

Asking for support

• The original save (before you edited it)

• The altered (damaged) save

• A description of what you did, as concise as possible

• The error.txt (if you have one)

Tools

red4-conflicts

Check a folder with .archive files for conflicts (which files modify the same resource)

1. Download from

2. Extract somewhere

3. call via command line: red4-conflicts.exe "c:\Path\to\Cyberpunk 2077\archive\pc\mods"

4. Profit

SoundDB

Web tool allowing you to search for voice-overs, music and sound effects of the game. Available on .

See the Finding audio page for a usage guide:

Blender Plugins

Blender Scripts

In 1.6.8, the MLSetupBuilder library has been completely overhauled. This page will tell you how to find things there.

The model browser of 1.6.7 has been transformed from a tree with sub-branches into a table with many capability. One of those capability is tags filtering.

How does this work?

Filtering will only consider an item's name, but not its visual appearance:

Tags are displayed to the right, but are written text-like in the Database. Every keyword is divided from the other with a space. As the caption says, the selected line tags is written like : base man massive head

Why is this important ?

It is important because there are some rules to this syntax that will help you atomize the search of one model into the 40K+ models paths stored in the Database. The most important rule is that every model starts with :

• base - for Vanilla Cyberpunk 2077 models

• PL - for Phantom Liberty ONLY models

How do i start using tags filters ?

In the Models Library panel, click on the tags filter button in the header of the table

Example

Let's say we wanna search only in the models of the Phantom Liberty expansion for man models. We will add a first condition specifying in the options that our tags Starts with the word PL

Then we can click on Add Condition and specify that the tags need to Contains the word man with a space before the word man The space is NEEDED since the also the keyword woman contain the word man

You will see that for every condition you add, the datas will be filtered in realtime. You can remove and add tags filtering condition as you like. Clicking to the little x in the right upper corner of the tags filtering panel you can toggle the panel and access the list you got.

You can combine the tags filtering with the basic search field in the table interface to find what you need.

List of the actual TAGS used with Tags System

• base

• PL

• player

• man

• woman

• child

• big

• fat

• massive

• animals

• gloves

• arms

• head

• item

• legs

• shoes

• torso

• vehicle

• mechanical

• weapons

• firearms

• melee

• explosives

• environment

Details about the keyworks:

• player identify all those materials that by model name are for sure assigned to the game player

• animal identify the models related to the Animals Gang member body size

A more complex example

Tag filtering ca be combined with the default path search to display only legs models related in this case to jeans

Introduction

From the website: Noesis is a tool for previewing and converting between hundreds of model, image, and animation formats. It utilizes a robust plugin system, with support for native extension modules and Python scripts.

Noesis is considered one of Cyberpunk 2077 Modding's cornerstones for its ability to open .mesh files and convert it into a wide variety of other 3d file extensions (like GLB and FBX) thanks to alphaZomega's CP77 Python script that makes that possible.

Download

Noesis

Download Noesis from Rich Whitehouse's website https://richwhitehouse.com/index.php?content=inc_projects.php

alphaZomega's CP77 Python plugin

Download the plugin from here https://www.mediafire.com/file/uhc9d68mvj7oqj6/fmt_CP77mesh_1.6.zip\

Setup

After installing Noesis, put the fmt_CP77mesh.py file in the python folder located inside the plugins folder, and make sure that oo2ext_7_win64.dll is placed next to the plugin in folder.

Basic export/import process

Exporting

Open your .mesh file in Noesis64.exe, then right click on it inside the app and press Export, from there you will be given file extensions to export into, .FBX is the go-to for any usual process and for easier importing into 3D Apps like Blender and 3DS Max.

Same goes for .xbm files.

Importing

Open your 3d file (like .fbx or .glb) in Noesis64.exe, export and select .mesh - CyberPunk 2077 mesh [PC], when a dialogue box shows up browse and select the .mesh file that is appropriate for your import(for example if it was a shirt you'd probably export over .mesh files that has shirts in them), then click OK.