Asset I/O

WolvenKit includes an all-purpose import and export tool for converting assets to game files and vice versa. Our tooling is bespoke allowing for native conversions with extensive options to suit your needs (check Import/Export or find the list of I/O formats for export/import).

Base game and user-generated archives can be browsed on the fly, making game dumps obsolete. Our Asset Browser also features instant preview for assets such as meshes and textures.

Development

File Editor

WolvenKit is built around our RTTI-based file editor. Any REDengine file can be inspected, edited, and saved with the File Editor. The File Editor is also capable of reading and writing in-place buffer data. Game files can also be converted to human-readable json and back for ease-of-use.

Projects

WolvenKit can host virtually all of your required project files inside the Project Explorer. Each project is neatly separated into distinct folders which can be accessed through the application. No more whiplash from constantly navigating your file explorer to switch between projects! Feel free to host all of your assets within a mod project. Source files such as blends, psd, xcf, and more can be placed inside your project tree and opened directly with a double click! WolvenKit works with you by organizing your project files automatically.

UI/UX

WolvenKit is created with the intention of being an all-purpose mod editor. The application interface is designed to help modders keep their sanity by having every tool at their disposal from the main editor. The application is built with a configurable interface to suit your preferences.

Workflows

WolvenKit features a robust build pipeline for handling REDengine assets. Game files can be browsed, extracted, modified, and packed into an archive once again for use in game. WolvenKit can help guide modders along with this process by using our efficient pipelines.

Other

Blender Integration

WolvenKit supports Blender for one-click imports of fully shaded Cyberpunk meshes using the Multilayered.mt supershader. Find the workflows here:

Exporting Rigs & Anims

Exporting Vehicles

What is WolvenKit?

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.

Our current development focus is REDengine 4 with Cyberpunk 2077.

Quick Links

Websites & Community

Now why would you want to do that? 💔

To completely delete WolvenKit portable delete your chosen installation folder, and the REDmodding folder in your users/appdata/roaming/ directory.

To delete the Installer version you can use Windows default Remove Programs or Features tool. You may then manually delete the users/appdata/roaming/REDmodding folder to remove your preferences as well.

Published Apr 06 2021

After a long and hectic development process, we are very excited to finally announce the public Beta release of Wolvenkit for Cyberpunk 2077. That's right everyone, Wolvenkit is no longer a myth! Though there have been many delays, we greatly appreciate the community and our patrons and contributors for sticking by us throughout the development process, and for the hard work by the many programmers, artists, and researchers that have made this whole project possible. So many incredible breakthroughs and discoveries have been made in Cyberpunk 2077 modding thus far, and we are excited to see what the community can do with the new capabilities that will be made available with the release of WolvenKit. Modders will now be able to browse game assets, browse, read, and edit most if not all file formats used by the game, manage projects, and more. As this is only the initial release, some features you may expect are still to come in future releases. By choosing to support us, you will be not only be enabling us to continue to develop Wolvenkit and add further functionality and tools for use by the community, but also gain access to exclusive posts and updates on the development process, as well as private community channels, voting power, behind-the-scenes content, and more. Even the smallest amount can help us to continue / spend more time on developing more tools.

WolvenKit has been completely refactored to migrate to a WPF solution from the Legacy WinForms build. Version 0.8.0.1 brings initial support for CDPR's latest video game Cyberpunk 2077. While we are planning to bring feature parity for Legacy WolvenKit versions, for now support for Witcher 3 projects is extremely limited. The initial feature set for the 0.8.x series focuses on the Asset Browser and Project Packing tool which enables us to efficiently rip assets and repack REDengine files into the archive format.

Mod Projects

• Initial implementation of the Project Explorer enables basic asset management for REDengine files added from Asset Browser.

• Initial implementation of the build pipeline. Files inside the Mod directory are packed into Cyberpunk format archive files. Optionally the user can choose to auto-install the packed archive file into their game folder.

UI/UX

• The WolvenKit UI has been completely rewritten from scratch to transfer the code base from WinForms to WPF.

Entity Preview

To be done

Mesh Preview

UI documentation

Appearance dropdown

Lets you select an appearance from the list of defined appearances

Level of Detail

Generate Materials for Appearance

Will create a rough approximation of the surface material. As of March 2024, this feature needs a lot of work.

What is the LocKey Browser?

Based on Wkit v. 8.11.0

LocKey is a localization key designed to identify localized text strings. These keys, such as 'vehicle_enter' (which is not only user-friendly but also has a unique ID used typically), are employed throughout the game. Prior to display, these keys undergo localization to match the language setting of your game.

The LocKey browser allows to search for a specific localized text and reveals the corresponding LocKey (numbers) that, when localized, contains the desired text (string).

What is the Log?

If something is not working as expected, take a peak into the Log to check for useful information.

Where can I submit feedback or bugs?

Exporting

1. Extract the textures with uncook -p into a folder of your choice. TGA is recommended for CLI version 1.5.1 (latest).

2. Edit the TGA file with software such as Photoshop or Krita.

3. Choose the textures you wish to repack and copy them to another folder (e.g. MODDED), keeping the subfolder structure (the \base folder needs to be the first folder inside the MODDED folder)

Importing

1. Import

   Run import -p "MODDED FOLDER PATH" -k this will apply the new TGA texture to the XBM.

2. Pack

   Run pack -p "MODDED FOLDER PATH", this will create a new .archive file.

3. Install

   Copy the packed .archive file into the mod folder of your game: Cyberpunk 2077\archive\pc\mod (create this folder if necessary)

What is the Nightly?

Naturally, the Nightly will have more bugs than the stable version — but you should use it regardless, because we need help catching those bugs.

For more information on this, check How do I report bugs?

How do I install it?

Download the portable version:

Then, extract the downloaded .zip file into a folder on your hard drive (for example, C:\Cyberpunk2077Mod\Wolvenkit_Nightly) and start it. Done!

How do I report bugs?

Is it a regression?

Double-check the bug in your stable install. If if works there, but doesn't work in the Nightly, then it's a regression (something that used to work but got broken).

If it's broken in both places: congratulations, you've found a new bug!

Reporting a bug

2. Click the "New issue" button

3. Select the type of issue you are reporting (probably "bug report")

4. Give a description of the bug, including the following information:

   1. Your Nightly version (date is okay)

   2. Is the bug a regression? (Does it also happen in the latest stable?)

   3. The files necessary to make this happen, or their paths if they are vanilla files

   4. An itemized list on how to make the bug happen

WolvenKit 8.7

Published October 22 2022

WolvenKit 8.6

Published May 24 2022

WolvenKit 8.5

Published March 07 2022

WolvenKit 8.4

Published October 03 2021

Patches

WolvenKit 8.3

Published September 05 2021

Patches

WolvenKit 8.2

Published June 28 2021

Patches

WolvenKit 0.8.0.1

Published April 06 2021

What's a Home good for?

Welcome

When WolvenKit is launched the Home functions as bulletin board to help you pick up where you left off. Recent mod projects are displayed as a scrolling list of cards which can be directly clicked to get started. Other crucial functions for creating or opening projects are displayed in the right-hand column.

Mod Manager

Manage REDmod installations and deployment

Plugins

Download and update various Home: Plugins and extensions for Cyberpunk 2077 modding

Settings

Web Content

WolvenKit is capable of displaying web-based content natively. The Home page features several built-in web pages!

Wiki

This Wiki can be viewed from within WolvenKit. Hi WolvenKit users!

GitHub

GitHub can be used to directly track progress with WolvenKit development

Website

Summary

Created by @JJTurtle Published October 22 2022

This guide is intended for the beginning modder, who is still learning, and wants step-by-step instructions on how to fully install and configure their modding tools and asset depot.

To keep things simple, the recommendations in this guide will centralize many of the modding applications, assets, and related resources.

Requirements

Prerequisites

1. Hard disk space for the Depot:

   • For regular operations, <5GB storage will be enough

   • If you want to extract materials and meshes, you should have at least 15GB storage

   • Optional: If you want to create a full asset depot, then you want at least 75GB storage. If you are reading this guide, then you won't need that.

2. Optional, but recommended: a basic level of computer knowledge. The guide contains detailed instructions, but you'll have an easier time if you already know things like like:

   • Open a command prompt and run a command,

   • Locate your download folder and extract a zipped file,

   • Install an application,

   • Find and move files

We goin' in?

First, install Wolvenkit:

Let's configure and set up Wolvenkit and all its plugins:

Then, we unbundle those game assets that we need…

Now we're goin' in.

We do that by creating a tiny mod to make sure everything worked OK.

As of version 8.11.1, Wolvenkit offers the following plugins:

Cyber Engine Tweaks

Redscript

MLSetup Builder

Wolvenkit Resources

This plugin is necessary to use the Asset Browser's context menu functionality of "find used files" and "find files using this". It provides the information that Wolvenkit needs to connect those files.

RedMod

CDPR's official interface for modding.

Red4Ext

It is necessary as a requirement for e.g. ArchiveXL and TweakXL.

TweakXL

RedHotTools

What is the Tweak Browser?

Based on Wkit v. 8.11.0

Basic Troubleshooting steps

.NET

Clean reinstall

Remove everything inside your Wolvenkit install folder, then download the latest release from github and extract the files into your empty directory.

If that doesn't solve the problem:

%Appdata%

You can find Wolvenkit's settings (including your project layout) in the following folder:

%appdata%\REDModding\WolvenKit

Maybe something here will help you resolve that error.

Get in touch

Summary

Launch Profiles

You can set up different profiles to launch Cyberpunk 2077 from inside Wolvenkit. Via Launch Profiles, you can select what should happen when you press the button.

Configuration

Where to configure

With a long click on the Install button, you can open a dropdown menu that lets you pick a launch profile:

Available options

Create Backup of previous build

Create zip file

Install to Game directory

Installs your mod to your Cyberpunk 2077 directory

Clean before build to prevent errors

Clears the packed directory before building. Not doing this may lead to leftover files in the resource directories or have other side effects, so you'll want to keep this checked.

Clean after build to save disk space

Clears the packed directory after building/installing/creating a zip file. Check this to save diskspace, but note that it will disable Create Backup of previous build.

Pack as REDmod

Check this to pack your mod as REDMod rather than as a legacy mod. You don't generally want this, as it can lead to load order issues and increase your users' demands for support.

Deploy as REDmod

Launch Game

Launch the game after installing the mod. Without this, the next three options will do nothing.

Load last savegame

When you start the game, it will load your last savegame (by timestamp).

Load specific savegame

Loads a specific savegame by name (or tries to).

Game Commandline Arguments

Default profiles

WolvenKit will create the following profiles if it can't find them:

• Install

• Install as REDMod

• Install, Launch, and Load Save

• Install and Launch

• Launch Game Without Install

Summary

This page describes Wolvenkit's Editor Difficulty Mode.

Where to change it

To switch it in-editor, use the dropdown in the upper left corner of the .app

Easy

Recommended for beginners. Many properties that you won't want to edit are hidden, other properties that you shouldn't edit are write-protected.

Default

Should show all properties that you realistically want to edit for regular use cases. Autogenerated properties are write-protected, irrelevant properties (e.g. platform) is hidden.

Advanced

The authentic editing experience from <= 8.14. Rawdogging CR2W without protection. Use at own risk.

What is the WolvenKit Console?

WolvenKit Console is the core "Modkit" that drives the WolvenKit application. The Console supersedes the original CP77 Tools application created by rfuzzo. The same core functionalities of WolvenKit are available from command line for simplicity and extendibility for power users.

• For a documentation of the individual commands, see Wolvenkit.CLI: Command List

• For further instructions on using it, see Wolvenkit.CLI: Usage

Installing Wolvenkit Console

As a dotnet tool

For a global install, you can install it as a dotnet tool. Open up the windows command line (Windows+R, type cmd, hit return) or Powershell, then enter the following:

dotnet tool install -g wolvenkit.cli 

Verify if the installation was successful:

wolvenkit.cli -help

By downloading it from the repository

Extract it to a directory of your choice (for example C:\Cyberpunk_Modding\Wolvenkit.Console).

You can run Wolvenkit console from that directory, for example:

C:\Cyberpunk_Modding\Wolvenkit.Console\Wolvenkit.CLI.exe -help

You can toggle the script manager via Tools -> Script Manager.

It looks like this:

Adding scripts

Enter a name in the box at the bottom of the panel and click the "Add" button. That will create a new script file in your Script file path.

Tabs

General

Contains a selection of runnable scripts for various workflows, e.g.

• Export_Vehicle_Ent when Exporting Vehicles

• Export_Ent for characters (see Exporting Characters to Blender)

Hook

This section contains the settings for File Validation

UI

This section lets you add your own UI items.

Audio

Voice-overs & music

When you select an audio file in your Project Explorer or the Asset Browser, the File Information widget will turn into an audio player:

Sound effects

You can import and export sound effects stored in .opuspak files using the Import and Export tools respectively. See this page for a walk-through:

Video

In the past, Wolvenkit used to be able to view videos. However, due to license issues, we had since to remove the plugin.

However, it was only a wrapper around RADTools, which you can also install as external tool.

The following formats are supported by WolvenKit for imports and exports

• wem ↔ wav, mp3 Audio files can be converted to and from REDengine. Use the Sound Modding Tool to import new audio.\

• morphtarget ↔ glb/glTF (experimental) REDengine morphtargets can be exported to glTF format. The morphs can be viewed as shapekeys/blendshapes with a 3d package. glTF files can be used to recreate morphtarget files, however only one morph is preserved.\

Published May 24 2022

<summary paragraph>

Miscellaneous

• Launch Game from WolvenKit Wolvenkit is now able to run Cyberpunk 2077 from the app itself using the 'Launch Game' button, with support for launching either through platforms (like Steam:// gameid links) or from the executable executable, with support for launching with specific commands (e.g. -qualityLevel=Cinematic_RTX).

  • Pack, Install and Launch game is now included as well to quickly pack mod projects and launch the game.

How do I use the Blender integration features?

If the Export Materials checkbox in the mesh export settings is enabled, WolvenKit will create a Material.json file under raw. You can find it in the same directory as the mesh.

… or our knowledge base, where you can find documentation like

What is the depot?

The depot is the folder where Wolvenkit stores anything it needs to export your project files. As of version 8.13, it can handle everything by itself, and you don't need a depot unless you want to browse game data outside of Wolvenkit.

How to generate a depot?

Use the Depot Generator from Wolvenkit's Tools tab:

Generating a depot

You can export materials, or unbundle the whole game:

Generate Materials

Exports the game's materials (textures, gradients, mlmasks...). This used to be required by MLSetupBuilder, but is no longer necessary.

Unbundle Game

This will extract every file in the game files to your depot folder. You only need this to browse Cyberpunk's files outside of Wolvenkit (but why would you want that anyway?)

What can I do with WolvenKit?

How do I download WolvenKit?

Where can I get help with WolvenKit?

How can I open or browse archive files?

How can I import or export textures with WolvenKit?

How can I import or export models with WolvenKit?

What are long filepaths, and why do I need them?

In the year of our lord 2025, Windows does not (by default) support file paths longer than 256 characters — and if you're somebody who likes to use subfolders, this will break Wolvenkit's mod packing.

We decided to show you a warning at every startup, because

• the fix is super easy

• we can't solve the problem in Wolvenkit

• if you run into this, you'll be unable to create mods

How to enable long filepath support?

Windows

2. Paste the following command:

New-ItemProperty -Path "HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem" `
-Name "LongPathsEnabled" -Value 1 -PropertyType DWORD -Force

1. Press Enter

That's it! You now have long path support enabled.

Linux

This feature is supported out-of-the-box. Just try to stay under 4000 characters.

Converting files to JSON will serialize their content to a .json file in your project's raw folder.

Importing them back will re-create the corresponding file under archive.

Export as JSON

This option is in the right-click menu:

Import as JSON

This option is in the right-click menu:

The majority of communication about WolvenKit happens on our Discord server. Use the following link to join our modding community.

If you want to follow development, look for help with our tools, or contribute, Discord is the place to be. For help with WolvenKit directly, look for the #wolvenkit-support channel.

What is the Properties viewer?

The Properties Viewer is used to provide extra information about selected files from within the Asset Browser or the Project Explorer. The Properties Viewer can also generate instant previews for REDengine texture and mesh files.

Using the Properties viewer

Mesh Preview

Mesh files can be previewed by selecting them within the Asset Browser or Project Explorer.

Controls

• Hold and drag Left Mouse Button to rotate the mesh

• Hold and drag Right Mouse Button or use Mouse Scroll to zoom

• Hold and drag Middle Mouse Button to pan

Image Preview

Image files can be previewed by selecting them within the Asset Browser or Project Explorer. The image previewer is capable cropping, flipping, and markup. While the markups will not get saved to original file, they can be exported by using the save button.

Audio Preview

Audio files can be previewed by selecting them within the Asset Browser or Project Explorer.

Video Preview

Double click BK2 files in the Project Explorer or right-click them in the Asset Browser

Space to play / pause Esc = End video Use the bottom bar to scrub through the video.

What is the Editor?

Editor panels

For an explanation to the editor panels, please see the corresponding sub-pages:

Docking

The docking in WolvenKit is similar to other IDE's such as Visual Studio. All panels can be rearranged by docking to specific areas, or used as a standalone floating window.

Status Bar

The Status Bar along the bottom of the application window contains useful information such as your WolvenKit version number and the current mod project, and provide the ability to install new updates if available.

Wolvenkit is scriptable using javascript and its internal API. With it you can automate tasks such as exporting, as well as make changes to files programmatically.

Adding Scripts

Script file path

Any .wscript files you have created or edited will be stored in the following location:

Editing Scripts

The editor shows your source code with code formatting and includes code suggestion for the Wolvenkit api.

API Commands

This documentation is generated by Doxygen from the codebase so will update as the API evolves.

Utility Functions

There is also a utility library called Logger.wscript shipped with wolvenkit that assists with writing messages to the wolvenkit Log. It can be included with the following statement:

it provides the following functions:

Logger.Info(obj)

Prints the supplied object or text in yellow in the log window.

Logger.Warning(obj)

Prints the supplied object or text in purple in the log window.

Logger.Error(obj)

Prints the supplied object or text in red in the log window.

Logger.Success(obj)

Prints the supplied object or text in light blue in the log window.

Logger.Debug(obj)

Prints the supplied object or text only to the log file.

This page will tell you about keyboard shortcuts and nifty tricks that make working with Wolvenkit easier.

Project Browser

The context menu in the project browser reacts to Shift and Ctrl, making other operations available. Check it out!

Drag and drop

You can drag and drop files and folders to move them. Hold the Ctrl key to copy them instead.

Rename and refactor

You can call up the rename dialogue by pressing f2, as long as you have a node in the project browser selected.

If you check the Update in project files? box, Wolvenkit will automatically try to update all references in your project to the new file path.

Copy relative path

The context menu's Copy Relative Path action will show you other options if you hold Shift and/or Ctrl:

Collapse/expand a folder and its children

By holding the Ctrl key when you click on a folder, you can collapse or expand the whole folder and its children.

File Editor

The file editor's context menu and menu bar react to Shift and Ctrl, making other operations available. Check it out!

Difficulty mode

Delete all but selection

Holding the Shift key while an array element is selected will offer you Delete all but selection instead of Delete selection.

Overwrite with selection

Holding the Shift key while pasting into an array will let you overwrite the current selection with your clipboard.

Holding down the Ctrl key as well will let you overwrite the entire array with your clipboard.

Shift: Recursively fold/unfold

By holding Shift while expanding a node, you can fold/unfold all of its children (and their children) according to specified rules for the most common node types:

Double-Click: Fold/unfold all siblings

Double-clicking a node in an array will toggle the expansion state of all siblings to the expansion state of the node.

f2: Search and replace in selection

You can search and replace in selection by using the context menu or pressing the f2 key.

Clean up

Especially in mesh files, the Clean Up menu is your friend.

Clean up empty submeshes will delete extra chunks from old templates.

Delete unused materials will drop any material entries that aren't used by any of your appearances.

Summary

This page contains information on the general use of Wolvenkit's command line interface. For more specific information, please see the corresponding sub-pages:

Help

• Display general help/list all commands: --help

• Display help for a specific command: archive -h

Using WolvenKit Console globally

You can now install and update the Wolvenkit Command Line Tools (wolvenkit.cli) as a dotnet global tool. The console can be used anywhere directly from the command line, with no custom installation, and easy update.

Open command prompt/powershell and type in:

dotnet tool install -g wolvenkit.cli

WolvenKit Console can now be run from anywhere using CMD/Powershell:

wolvenkit.cli uncook -p "D:\SteamLibrary\steamapps\common\Cyberpunk 2077\archive\pc\content\basegame_1_engine.archive"

For updates to WolvenKit console, open CMD/Powershell and type:

dotnet tool update --global wolvenkit.cli

Video Guide for launching CLI

Processing files in bulk

To process multiple .archive files (for e.g. extracting duplicate textures), write yourself a batch file:

Interested in contributing code?

Please do! Fork the project and please commit your changes in small incremental steps with descriptive messages. Code quality is not the biggest concern but refrain from simple mistakes. It's a good idea to create an issue when implementing a feature so people don't work on the same feature/issue in an asynchronous manner.

I'm not a programmer, how can I help?

Building WolvenKit with Visual Studio

Install .NET 8

Install the latest Visual Studio release

Check out the source code with Git

Build and Run

1. Open All.sln

2. Build WolvenKit on Debug

You edit the settings for Wolvenkit.CLI by editing appsettings.json in a text editor.

Runnning Wolvenkit.CLI settings will open that for you.

Property Documentation

As a rule of thumb, the settings correspond to their names in the Wolvenkit UI in CamelCase.

Example settings file

An example file (as of PL) can look like this:

A comprehensive list of jargon you might see on this Wiki or around our community. This glossary is not alphabetical, so be sure to use your browser search function to find what you're looking for. (CTRL+F for most applications)

General

REDengine

The proprietary video game engine developed by CD Projekt Red for The Witcher 3 and Cyberpunk 2077. Alternatively referred to as RED3, RED4

GitHub

A website which hosts code and helps programmers collaborate on projects. The source code for WolvenKit is hosted here. You can compile the WolvenKit source code yourself, or for non-developers you can find WolvenKit releases here first.

Modding Tools

WolvenKit

The unofficial community modding toolkit. (Hint: This is the WolvenKit Wiki)

WolvenKit CLI

The command line interface version of WolvenKit. (Formerly CP77 Tools)

CP77 Tools

The original Cyberpunk 2077 modding CLI tool. (Deprecated by WolvenKit CLI)

Official Modkit for The Witcher 3 (WCC)

An official CDPR command-line tool for modding The Witcher 3. Legacy WolvenKit makes extensive use of the Modkit. We aim to deprecate the Modkit with WolvenKit.

WolvenKit

masklist

Material json

Game Files

W2RC/CR2W

Raw

Generic term used to refer to non-REDengine files that have a CR2W counterpart. The raw format of the REDengine XBM texture format can be TGA, PNG, DDS, etc. e.g. "Do you have the raw texture?" - This is an inquiry about the TGA/PNG/DDS counterpart to a game texture file.

Uncooked

A term used to describe a CR2W file in its most basic uncompressed state. e.g. After using the Official Witcher 3 Modkit to import an FBX to W2MESH, this file is uncooked. Rather than calling these files imported, the uncooked terminology is derived from the cooked (compressed) file state.

Cooked

A CR2W file that's imported or encoded as an engine file, then debugged, compressed, and buffered by the REDengine build process. Files extracted with the Asset Browser using WolvenKit (including Legacy) are cooked files.

Packed

The final unified package file used by REDengine games. The Witcher 3 uses bundle files while Cyberpunk 2077 uses the archive file format.

Modding

Vanilla

Original or unmodified i.e. Johnny Silverhand's vanilla appearance can be changed with a DLC

Depot Generator

Sound Modding Tool

<info>

Script Manager

Import Tool

Export Tool

Hash Tool

<to be done>

Settings

Unlike music and voice-overs, sound effects in Cyberpunk 2077 are stored inside .opuspak files, which are described by a single sfx_container.opusinfo file.

Exporting sound effects

With the opusinfo selected in the Export tool (if you don't see the file, press Refresh), you should now see the export options on the right.

The important field for us here is "Selected for Export". Click the three dots on the right to open a selection window where you can choose which hashes to export. Click the hash you want and press the arrow button pointing right to add it to selection.

Once you've selected what you want, press Finish to confirm the selection and back in the Export tool press "Export Selected". The sounds you've chosen should now be in the raw folder of your project. You will find two files for each of the sounds, one is origin .opus and the other is .wav. You can usually ignore the .opus file.

Importing sound effects

To import back a sound effect, all you need is the sound file in .wav format with the exact same filename it had when you exported it. It should also be in the same folder (base).

You can usually leave the default settings as they are. After pressing "Import selected", your project's archive folder should now contain a new modified sfx_container.opusinfo and one or more sfx_container_XXX.opuspak (XXX being a number). The opuspak contains your new sound (and other sounds too).

Published October 22 2022

WolvenKit 8.7 is a major step forward. New features include support for building REDmods, sound modding, and animation modding. The UI has been fully transitioned to a title menu and toolbar setup. Texture I/O is significantly more powerful and robust. Numerous fixes for bugs, issues, and pain-points have been implemented. Check out the full release notes below.

New Features

• Support for Cyberpunk 2077 game version 1.6 Upgrading to WolvenKit 8.7 is mandatory for game version 1.6 and beyond. WolvenKit should handle new game releases more gracefully in the future.

• Support for REDmod

  • Added options for Building and Deploying REDmods

  • Added Mod Manager for REDmods

• Launch Profiles Added support for creating custom launch profiles when building mods. Launch profiles can be added, removed, or modified from the Build menu or the Launch Profiles button in the Toolbar. Modify or create new launch profiles such as automatically starting Cyberpunk 2077 when building mods.

• Depot Generator Tool Added Depot Generator tool to consolidate game-dump operations into a single tool. The Depot Generator is able to generate material files with the users preferred image extension. Additionally the Depot Generator can fully unbundle all archives in one click.

Changes & Improvements

• Texture I/O has been completely refactored Expect improved performance and versatility for users

• Import/Export arguments are now saved When adjusting advanced import options adjustments are saved per-file. For example if the XBM export format for a specific texture is changed from PNG to TGA, the specific XBM will default to TGA for subsequent exports. This behavior is persistent between WolvenKit sessions.

• XBM import arguments are now exposed When importing XBM files, texture setup parameters are now exposed making the texture pipeline much more powerful.

• 16bit color channel textures are now supported WolvenKit is now capable of working with higher bit-depth images due to newly exposed parameters.

• MLMASK I/O improvements MLMASK I/O now supports the same image formats as XBM during export and import. Additionally WolvenKit will now accept masklist files which include a 0 layer.

• Added Title Menu WolvenKit now has a traditional categorized menu within the titlebar itself, hooray!

• Mod Manager and Plugins added to Home

  • The new REDmod Mod Manager has been added as a tab within the Home page.

  • Plugins have been moved from the Menu Bar to a new tab within the Home page.

• Simplified Toolbar Drop-down elements have been moved from the Toolbar to the Menu.

• Added Launch Profiles button to Toolbar A new configurable Launch Profiles button has been added to the Toolbar.

• Added Open Game Folder button Navigate to Menu > Game > Open Game Folder to find the Cyberpunk 2077 directory with the System File Explorer.

• The Ribbon has now been fully deprecated The Ribbon was off by default in version 8.6, but has now been completely removed.

• Help and Feedback dialogues have been removed We saw virtually zero usage of these features, so they have been removed.

• Improved some log errors messages Some log error messages have been improved to help users diagnose issues.

• File Preview is turned on by default On first launch File Preview is turned on by default aiming to improve feature discoverability.

• The Mod Browser button is now a switch Changed the Mod Browser located inside the Asset Browser from a button to a switch aiming to improve feature discoverability.

Fixes

• Fixed crash due to game version 1.6

• Fixed absurd UI layout on first launch by including a default layout

• Fixed raw textures not displaying or showing incorrectly within Preview window

• Fixed exception when generating materials to Depot

• Fixed numerous issues when exporting meshes with materials

• Fixed mesh to json serialization exception

• Fixed freeze with Asset Browser when search bar is empty

• Fixed crash with Asset Browser when game path is not set

• Fixed memory leak issue with certain animated UI elements

• Fixed an issue where the Cyberpunk2077.exe lookup did not work on first run

• Fixed an exception with long file paths during Import/Export operations

• Fixed an issue with Project Explorer losing files that are modified externally

What is the Asset Browser?

Where is it?

In the default view (as of 8.11), you will find it pinned to the right side of the viewport.

If it isn't there, check the View menu and make sure that it's enabled.

Using the Asset Browser

Navigation

The left-side breadcrumb navigator can be used to quickly navigate through game directories. Game files are displayed in the right-side panel, in addition to folders. Folders in the file list can also be navigated by double-clicking.

Mod Browser

Adding files to projects

• Double-click files to add them directly to the Project Explorer

• To select multiple files hold shift and then left click two separate files. These two files and all files between them will be selected. Right-click any of the highlighted files to open the context menu. Then choose Add Selected Item(s) to Project.

Context Menu

As of 8.11.1, the context menu has the following entries:

Add selected items to project

See Adding files to projects above

Open without adding to project

What it says — you can browse a file in the File Editor without adding it to your project. Saving (Hotkey: Ctrl+S) lets you save it to disk, though.

Find used files

Will make the Asset Browser display a list of everything your current file is linking to.

Find files using this

Like Find used files, but the opposite: will make the Asset Browser display a list of everything that links to your current file.

Browse to asset folder

Will navigate the asset browser to the current selection's path in the game files (if it is a game file).

Copy Relative Path

Copies the selection's relative path to clipboard.

WolvenKit is made possible by the community

All aspects of WolvenKit are created by incredible community members. Many members of the RED Modding community donate their time and effort to engineer tools, applications, and support for modding for REDengine. We want to acknowledge the hard work and generosity of our contributors that make WolvenKit what it is today.

Core Developers

These individuals turn our dreams into reality

Outstanding contributions

Community members who've logged countless hours bringing WolvenKit to the next level

PNDR - Art & Graphic Design

• Created dozens upon dozens of vector-based icons for WolvenKit's Asset Browser and Project Explorer

HOMESICK - Art & Graphic Design

• Created WolvenKit brand images, including the Sammy avatar

All code contributors

Check out the 50+ contributors to the WolvenKit source code

Other extraordinary help

Community members or organizations that empower REDengine modding with WolvenKit

AB4D - 3D Graphics for .Net

WolvenKit's real-time mesh preview system was powered by AB4D. (Deprecated in v8.6)

NEUROLINKED

Neurolinked created MLSB (mlsetup-builder), a software for working with and creating complex multilayered Cyberpunk assets.

TURK645

The basis for converting Cyberpunk multilayered materials into Python script for Blender was Turk's incredible Blender add-on for shader automation. Their research and development helped make the Cyberpunk Blender add-on possible.

Archives

Required files are contained within these archives

• audio_1_general.archive

• audio_2_soundbanks.archive

• basegame_5_video.archive

• lang_en_voice.archive

Video files

WolvenKit.Cli.exe unbundle -p "<gamedir>\Cyberpunk 2077\archive\pc\content\<nameofarchive>" -o "<outputfolder>"

Audio files

To execute conversion: .\ww2ogg.exe "<!AudioFilePath!>.wem" --pcb packed_codebooks_aoTuV_603.bin

./wwtools converts all WEMs in the current directory to OGG files ./wwtools wem [input.wem] (--info) will convert the specified WEM to OGG and if the optional info flag is used it will print the information about the file and exit.

MultilayerMask

You can export and import MultilayerMasks via Wolvenkit.

Exporting MLMASK files

Importing MLMASK files

Use the import tool to select any masklist file within the raw directory of the Project Explorer. If you don't have one, export an MLMask first.

MultilayerSetup

You can export and import MLSetup files via JSON and edit them with the MLSetupBuilder.

Export:

Import:

Toolbar options

New File

Save

Save As

Save All

Create Zip

Install Mod

Install

Install and launch

Like Install, but launches the game afterwards.

Hot Reload

Additional toolbar options

Pack as REDMod

Install as REDMod

Summary

This page contains an overview about Wolvenkit's internal error codes and what they mean.

What to do with an error

If you ended up on this page, you ran into a problem that needs to be fixed inside WolvenKit. You now have the following options:

Install the Nightly

Update all tools involved

Find support on Discord

Create a ticket

If your error still happens in the Nightly, you need to tell us about it. It's easy: bugs that don't get reported don't get fixed.

To fix the bug, we need to watch it in action. Please include everything we need to make it happen — at the very least, we need the most recent log file:

Error code list

0x2000: Type not supported (8192)

WolvenKit ran into a problem during internal conversion. Here's what you can do:

2. Re-create whatever file you were trying to work on at that time:

   1. A game file from an earlier patch: Add it to your project again

0x3002: Resources plugin

0x5000: Invalid settings

You have an unspecified issue with your settings. Double-check them and make sure that everything is configured correctly.

If that doesn't help, remove or re-name your settings file and restart WolvenKit:

0x5001: Invalid Game File Executable

0x5002: Failed to launch game executable

Section Brief

UI/Workflow documentation

This section contains general information and workflow documentation about importing and exporting files with Wolvenkit.

• For a detailed explanation of the different settings and their workflow, check the nested pages or use the "next" button at the bottom of the page.

File Structure: the raw folder

When exporting a resource, Wolvenkit puts the exported file into your project's raw folder. In the UI, you can find it in your project explorer:

The relative paths (starting under archive/raw) are the same, as will the file name (without extensions).

These files are connected:

You can import your_file.glb via Import Tool.

These files are not connected:

You can not import your_file_mesh_export.glb via Import Tool, because Wolvenkit won't know where to put it.

Exporting

Exported files will be created in your project's raw folder. The relative path will be the same.

Importing

The easiest way to do that is:

1. export an existing file

2. overwrite the new file in raw with your changes

3. import the file

Import from JSON

This option is in the right-click menu.

Section Brief

Configure the WolvenKit (wkit) application and MlSetupBuilder (mlsb), and make sure the Asset Browser loads the game's assets.

Configuring Wolvenkit

Installing Plugins

4. For every other plugin, click Install or Update.

Testing

Let's make sure that your game path is configured correctly and that Wolvenkit can access the files:

1. Click on Continue to Editor
2. Open the Asset Browser

1. After several seconds, a success notification will appear and the asset folder structure will appear on the left. This means WolvenKit was able to access the Cyberpunk archive and extract the game assets.

Summary

This page will show you how to use the Wolvenkit search to find files inside the Asset Browser/Mod Browser.

Wait, this is not what I want!

Wolvenkit's search bar

You can use the search bar at the top of the asset browser to search the game files:

To search in your currently installed mods instead, switch to Mod Browser:

Operators

You can chain the search operators below with the > character, which will run the results of the first search through the second search.

Examples:

// find all .mesh files in mod archives matching ArchiveXL_Netrunner
archive:ArchiveXL_Netrunner > .mesh

// find all textures with "steel" outside of "Characters"
// (have negative matches last, as they're expensive)
.xbm > steel > !characters

Let's get to the meat of the matter.

By archive

This is mostly useful for the mod browser, as it allows you to e.g. retrieve files from your other mods without switching projects or digging through your mod directory.

Use the archive switch to show only files in a certain archive (name or path):

a:ArchiveXL_Netrunner
archive:ArchiveXL_Netrunner

By full / partial path

Full

This is the default search behaviour, and you don't need to include these operators.

Search will only show you files under this path.

path:base\characters\common\player_base_bodies\player_female_average\t0_000_pwa_base__full.mesh
@base\characters\common\player_base_bodies\player_female_average

Partial

To limit your search to a certain folder, you can put the folder path and the search term:

base\characters\common\player_base_bodies\player_female_average t0_000_pwa_base

You don't need to include slashes. These search terms below will yield the same results:

base\characters\common\player_base_bodies\player_female_average arms
base characters common player_base_bodies player_female_average arms

// or simplify it to
player_base_bodies player_female_average arms

File Extension

You can limit your search to certain file extensions:

player_female_average .mesh
player_female_average .xbm

Hash

If you only know a file's hash, you can still search for it:

hash:9872775577851133397

Or

You can search for multiple terms by using the | operator:

player_base_bodies\player_female_average > .mesh|.xbm

Not

You can exclude terms from the search by prefixing them with !:

player_base_bodies\player_female_average arms > !morphtarget

Regular Expression

Wolvenkit lets you search for regular expressions. The main limitation is that you can't use spaces:

regexp:^.*main_npc.*judy.*\.mesh
r:^.*main_npc.*judy.*\.mesh

.* will work by default.

Published Oct 03 2021

WolvenKit 8.4 brings major quality-of-life improvements in a relatively small package. Additions to file I/O, browsing user-generated mods, and new options for editing W2RC files can dramatically streamline some modding workflows.

Patches

8.4.3 (Nov 11 2021)

Fixes

• Tweak Editor: Array editing

• Curve Editor: Fixes, zoom and editing

• Red Resource Editor: Fixes, array editing

• TweakDB: Fixed arrays and added remaining types

• Fixed a bug where w2rc buffers would not update on selection changed

• Fixed dirty filenames for tweak files

• Fixed theme settings bug which prevented color changes

• Fixed a bug where the Asset Browser would extract vanilla files while browsing mods

• Fixed the Asset Browser breadcrumb navigator folder sorting

Changes

• Added tweak CLI command

• Added check for updates button

• Added async file search within the Asset Browser

• Support for simultaneous reads from a single archive file by multiple WolvenKit instances

• Cleaned up Settings

8.4.2 (Nov 01 2021)

Fixes

• Fixed a bug where parallel unbundling caused a crash

• Fixed a bug where the app crashed on a pre-release version

• Fixed a bug with the file editor child item arrow expander

• Fixed hidden properties in Propertygrids

• Fixed messagebox layout

• Fixed compiled packages reading

• Fixed some TGA texture import issues

• Fixed miscellaneous asset exports

Changes

• The Home and Welcome pages are redesigned for improved efficiency and UX

• The Ribbon has been reorganized and cleaned up

• Some file icons have been updated

• Added support for reading W2RC file buffers (ent/app/mesh)

• Added progress indicator to the Status Bar

• Added unbundle game button to the Ribbon

• Support for group adding within the tweak editor

• Logging has been improved

• Faster archive manager loading

• Support for double faced meshes with the Import/Export tool

8.4.1 (Oct 06 2021)

Fixes

• Critical bugfix for importing mesh files with the Import/Export tool

Asset I/O

• Support for user-generated mod archives

  The Asset Browser is now capable of browsing and extracting user-generated mod archives. A new button called Toggle Mod Asset Browser has been added to the context Ribbon menu. The Asset Browser can swap between vanilla archives and mod archives on the fly. Mods must be installed to game location for browsing.

• Support for converting W2RC to and from json

  RED/W2RC files can now be converted to standard human-readable json files, and vice versa. Right-click any w2rc or json file within the Project Explorer, and navigate the Convert menu to find conversion options. Functionality not available with the File Editor such as adding or removing chunks and properties is possible with json format. Beware not all file formats are completely stable for conversion! Some elements may not be encoded properly. Use at your own risk!

• Support for morphtarget I/O

  The Import/Export tool is now capable of exporting morphtarget files to glTF format. Additionally glTF files can now be imported as meshes or morphtargets.

• Support for TGA format texture imports The Import/Export tool now supports importing TGA format textures directly. When using the TGA format, the compression method is automatically determined by reading the original XBM texture. Additionally TGA supports no-compression storage, meaning any loss in quality can be avoided.

Development

• Updated the RTTI types to 1.31

File Editor

• Added Curve Editor for curvedata within W2RC files Curve data can now be edited directly with a bespoke curve editor window within the File Editor. A new Open Curve Editor button has been added to the value column for any given curveData property.

Fixes

• Fully implemented TGA texture imports TGA texture imports now work as expected (Not fully implemented with WolvenKit 8.3)

UI/UX

• Improved handling handling of json files RED/W2RC json project files inside the Mod directory will continue to open with the File Editor. "Real" json files within the Raw directory will now be opened externally with the system default application. Material json and converted W2RC json files can be edited without leaving the WolvenKit editor.

• Refreshed Log improves readability

Published Jun 28 2021

WolvenKit 0.8.2 brings massive improvements in key areas. Features such as the Asset Browser have been refactored to be more robust and efficient. This build also features the first scalable content pipeline for importing various assets. Be sure to thoroughly read the Release Notes and check the showcase video!

Patches

8.2.2 (Jul 05 2021)

Fixes

• Fix for some meshes that did not import successfully (index out of range error)

• Fix for materials not being written correctly from material json files

• Fix for critical error with pack tool installing archives with a subfolder which prevents auto-installed mods from loading in game

• Fixed a bug with settings view not updating

Changes

• Additional information is displayed within the status bar

• Project creation simplified further

• Bug and feedback reporters implemented within Options ribbon menu

• Installer and auto-installation added

8.2.1 (Jun 29 2021)

• Support for bk2 import/export via the Project Explorer right-click context menu

• Fixed critical bug where some mesh previews crashed the app

• Fixed a bug where items in the mod project had incorrect paths

• Fixed a startup issue with InitializeBK accessing the oodle DLL before the game path has been set

Asset I/O

• Implementation of the universal Import/Export Tool brings support for an asset I/O pipeline The Import/Export Tool can be accessed through the WolvenKit editor ribbon. Exported files will be placed inside a new WolvenKit system directory called Raw. The Raw directory will mirror the existing Mod directory 1:1 which enables us to quickly re-import files without having to target an out-path for each import.

• Support for mesh I/O Native support for mesh to gltf/glb and vice versa

• Support for xbm I/O Native support for xbm to dds and vice versa

• Support for bespoke material json I/O Import/Export tool supports material.json files which can be used to manipulate REDengine materials

Development

• Irrlicht has been eliminated from the Solution.

• The Asset Browser code has been refactored, dramatically improving startup times.

File Editor

• The File Editor has not seen much development. There is a small regression with 8.2, where paths and variables are not displayed correctly. Alternatives such as the 010 editor template or WolvenKit's bespoke I/O for materials are recommended to view CR2W properties.

Mod Projects

• The Raw WolvenKit system directory has been added. This directory hosts all non-REDengine formats such as dds, tga, glb, and other source files such as psd, xcf, or blend files. The Raw directory significantly improves efficiency of the Import/Export Tool. Raw files that can be imported will appear inside the Import/Export Tool. Raw files can also be opened externally with your preferred editor by double clicking them inside the Project Explorer (i.e. opening a .blend file directly with Blender).

• WolvenKit now leverages a material repository. The material repository can be created all-at-once by exporting all game textures from XBM to TGA (other formats not supported at this time). Alternatively, each mesh exported with materials will have all texture dependencies dumped here. It's recommend to use the all-at-once approach if storage is not an issue. The material repository makes dumping redundant texture dependencies for each and every mesh unnecessary.

• Basic-yet-powerful operations have been added to the Project Explorer. Rename, copy, paste, and delete have been added to the context ribbon. Batch operations such as batch delete are supported also by using multi-select. Manage your assets from the Project Explorer!

• The DLC WolvenKit system directory has been removed, to be re-added if/when we have a working DLC pipeline.

• The publish button has been disabled temporarily in favor of the simple pack tool. The pack tool is a one-click solution to packing all Mod directory files and installing them to the game automatically.

UI/UX

• All REDengine files have been assigned a custom icon

• Multi-select has been implemented in areas such as the Asset Browser. Shift-select multiple files, right-click, then use the context menu to add selected files to the project.

• Basic file operations for the Project Explorer have been added to the context ribbon. (rename, copy, paste, delete, etc.)

• Startup time for projects has been dramatically reduced. The asset browser should initialize much faster

• Significant cleanup of unusable features/buttons. Witcher 3 modding support has been temporarily removed since the initial implementation is superficial

• Theming has been completely refactored

• New Import/Export tool has been added

• New Material Repository tool has been added

• Publish has been disabled temporarily

• Home page has been refactored with support for embedded videos. We plan to feature showcase/guide videos, or community guides as well

• Sammy icon has replaced the old desktop icon

Other

• Windows Administrative Mode is no longer required to launch WolvenKit. Note: If Cyberpunk is installed to your Program Files folder WolvenKit should still be launched with administrative mode enabled.

What are the Import Export tools?

To edit a REDengine file, it first needs to be converted to a more accessible format. This is where the Import/Export tools come in.

Before moving files (or in cases of OCD), please note the #file-structuresection.

As of Wolvenkit 8.9.0, you can find both the import and the export tool in the menu "Tools":

UI Preview

You can browse the file structure via Wolvenkit's Project Explorer. Here's how it looks:

Import Tool

Export Tool

The Export Tool lets you export any files in your project's archive directory:

What is the Project Explorer?

The Project Explorer is primarily a tool for organizing and navigating mod project files. The Project Explorer gives a constant tree view of all mod project files which streamlines the modding workflow significantly. There are four main WolvenKit directories inside the Project Explorer.

Project Explorer Tabs

You can switch between different tabs at the top of the project explorer (see the red arrow on the screenshot below). Their function (and content) will be explained in the next sections.

Archive

Only shows you files under your_wolvenkit_project/source/archive.

Raw

Location: your_wolvenkit_project/source/raw.

Resources

Location: your_wolvenkit_project/source/resources

Source

Location: your_wolvenkit_project/source

Will show you everything under your project's source folder. No context sorting.

Using the Project Explorer

Any file within the Project Explorer can be moved by dragging and dropping. Additionally files can be copied by holding Control while dragging and dropping.

Context Menu

Right-click any file within the Project Explorer to explore the Context Menu.

Open in MLSetupBuilder

Export to JSON/Import to JSON

Writes any REDengine file within the archive directory to human readable JSON format, as a mirrored file within the raw directory. JSON files can then be modified and converted back to REDengine format from the context menu by right-clicking the JSON file.

Delete

Moves any project file to the OS/system Recycle Bin.

Rename

Opens a dialogue box which allows any project file to be renamed.

The Update in project files option will make WolvenKit update all references in your source and resources folder.

Copy

Select any project file to be copied.

Paste

Pastes copied project file.

Copy relative path

Copies the selected file path to OS/system clipboard, trimming off all folders outside the game directory. Extremely useful for modifying paths while using the File Editor.

Replace with original

Replaces the selected file with the original unmodified version from the game archives. (archive directory only)

Open in File Explorer

Find the selected file with the OS/system file explorer.

Filtering

The Project Explorer can be filtered by directory.

SOURCE | All project directories (default) archive | Archive directory raw | Raw directory resources | Mirrors the game directory, use it to place additional files PACKED | Internal WolvenKit folder for mod deployment. Will be wiped before packing the project! Additionally the rightmost hamburger-style button can be used to toggle a flat file list without folders.

Summary

Last documented update: Jun 17 2024 by manavortex (Wolvenkit 8.14 Nightly)

This page documents Wolvenkit's settings menu, and what the individual entries mean.

TL;DR

You must make sure that your Game Executable Path is set. Wolvenkit will not work otherwise.

Settings: Overview

Cyberpunk

Game Executable Path

Launch Command

You can also put the path to the REDLauncher here, if you want that (but why would you?)

Launch Options

Depot Path

The Depot Path is a WolvenKit system folder for caching game assets. It serves as a cache for mesh exports with materials. WolvenKit builds a repository of visual assets within the Depot for usage with external applications such as MLSetupBuilder or Blender.

By default, it is set to C:\Users\yourusername\AppData\Roaming\REDModding\WolvenKit\Depot, but you can pick any location. It does not need to be on an SSD, although Wolvenkit might load faster if it is.

Additional Mod Directory

Display

Show CName hashes as hex

Display hashes for CNames as hexadecimal (rather than decimal)

Show ResourcePath hashes as hex

Display hashes for ResourcePaths as hexadecimal (rather than decimal)

Show NodeRef hashes as hex

Display hashes for NodeRefs as hexadecimal (rather than decimal)

Show TweakDBID hashes as hex

Display hashes for TweakDBID entries as hexadecimal (rather than decimal)

Show reference graph

Game language used for LocKeys

Lets you customize the language for the LocKey Browser. Default: en_us

Show Graph Editor Node Properties

Graph Editor: Detailed display?

File Editor

Group Large Collections

Toggles limited collections for improved performance within the File Editor when working when navigating large files.

Group Size

Adjusts the amount of elements of in a limited collection within the File Editor.

Default to Simple Mode

Ignored Extensions

File extensions that you want to open in an external editor

General

Do not check for updates

Will disable Wolvenkit's auto-update

Show Guided Tour

UNKNOWN FUNCTIONALITY This toggle may not work in the latest WolvenKit build.

Update Channel

The update channel determines which type WolvenKit updates are received.

• Stable WolvenKit will only show prompts when new releases are published (recommended)

• Nightly WolvenKit will show the latest development builds which may be unstable

Your name

Will be used when creating new projects.

Your e-Mail

Will be used when creating new projects.

Theme Accent

Changes the accent color of UI elements throughout WolvenKit.

Interface

Lets you customize Wolvenkit's interface.

Import/Export: Show advanced options

Turn this off unless you know what you're doing

Update references on rename

The default state of this box when you open the rename dialogue (shortcut: F2)

Show REDMod in Ribbon

Adds the REDMod buttons back to the ribbon. (Why do you want this?)

Show File Preview