Links

Download, Install and Setup

Downloading the WolvenKit application

Summary

Published: October 22 20 Created by @JJTurtle Last documented update: @manavortex, February 25 2023
This section will walk you through the process of downloading and installing Wolvenkit.
There is a Full Install Walkthrough (ELI5), which you can follow if you are not very computer-savy or feel insecure about modding. If you've been sent here by the same guide, ignore this box and start with the prerequisites. :)

TL;DR

  1. 1.
    Install REDMod and .NET from the Prerequisites section below
  2. 2.
    Download Wolvenkit-X.X.X.zip from github (stable | nightly)
  3. 3.
    Extract it to a folder of your choice
  4. 4.
    Run it and do the initial configuration
  5. 5.
    Optional: Proceed to the guide how to set up the modding tools

Prerequisites

For detailed instructions on installing other software that you might need for mod development, see the section
  • Windows 10/11 (64-bit) or a Linux build of your choice
  • REDMod (Cyberpunk's modding framework)
  • For older WKit versions: Microsoft .NET 6 (versions <= 8.7.1)
  • For current WKit: The most recent Microsoft .NET (confirmed working with .NET 8 and Wolvenkit 8.13)
Wolvenkit is mostly developed and used on Windows — if you're on Linux, you probably know what you're doing.
Downloading .NET
Open either of these pages:
Download and install the runtime. (The SDK is for .NET developers…. unless you are a NET developer, and in which case do whatever you want
😄
)

Downloading Wolvenkit

You can download Wolvenkit from any of the following links (click on the cards). If you are uncertain, go to Nexus.
If you don't care about the differences, go to the next section: Which version do I want?
GitHub (the links with the Wolvenkit icon) is the best way to stay up-to-date with WolvenKit, as this is where development happens. You can download the latest stable release or Nightly tester and developer builds fresh from the pipeline.
One of the Wolvenkit developers will download the stable version from github to put it on Nexus, so you can get it from there as well.

What's a "Nightly" and do I want it?

The Nightly is a build of the latest development stand, created automatically every night via pipeline (hence the name). It contains new features that are being worked on, but introduces the risk of bugs.
You will usually want to use the stable version, unless you want to try out new features, help with development and testing, or generally like to live dangerously.
Here are links to the most recent build for each repository:
Package
Latest Release
Checks
WolvenKit
GitHub release (latest by date)
GitHub branch checks state
GitHub release (latest by date)
GitHub Workflow Status

Which version do I want?

If you're on Nexus, then you can only download the portable (default) version. In this case, head to the next section.
Github offers you more options:
If you don't know which one to use, use the default (portable) one, it's usually the first entry in the list.
You don't need to download Wolvenkti Console, unless a (not-outdated) guide tells you so.
Download option
What is it?
Wolvenkit-X.X.X.zip You want this
Default — the portable version: download and extract this, then start it via Wolvenkit.exe
Wolvenkit.Console-X.X.X.zip
Command Line Interface (CLI): Not the same as regular Wolvenkit. Formerly known as CP2077tools, and becoming increasingly obsolete.
Used by other applications to "talk" to Wolvenkit, for example MLSetupBuilder.
Wolvenkit.ConsoleLinux-X.X.X.zip
As above, but on Linux. You usually don't need this.
WolvenkitSetup-X.X.X.zip
The Wolvenkit installer. This will run a setup and let you pick a folder. If you're running into problems with your install, download the portable version and extract it into the directory.
Source code (zip) Source code (tar.gz)
A snapshot of the source code that was compiled into this specific release. If you're not a programmer, then you don't want this.
Detailed download instructions (with screenshots!)
Download either Stable or Nightly release.

Installing

WolvenKit is not technically installed, you extract the downloaded file into a folder and it runs as a portable application. When you update the application, you'll overwrite the existing files with those that you've newly downloaded — you don't need to delete the old files, unless you run into weird problems.
Your settings are saved in C:\Users\yourUserName\AppData\Roaming\REDModding\WolvenKit.
This guide assumes that you install Wolvenkit and Wolvenkit Console to the following folders:
  • Wolvenkit: C:\Cyberpunk2077Mod\Wolvenkit
  • Wolvenkit Console (optional): C:\Cyberpunk2077Mod\Wolvenkit.CLI
If you use other paths, please change them accordingly.

TLDR;

  1. 1.
    Download the new release, extract the files (over your old install if you have one) and run it.
  2. 2.
    Optional: Proceed to the full configuration instructions.
  3. 3.
    Troubleshooting: Delete everything in the install folder, then re-extract the downloaded files again.
  4. 4.
    More troubleshooting: Find us on Discord in the #wolvenkit-help-me channel.

Optional: Removing old versions

If you don't have any old versions installed, you can proceed to the next section.
  1. 1.
    Delete all the files in C:\Cyberpunk2077Mod\WolvenKit from the previous release so that any cached and orphaned files do not corrupt the updated release.
  2. 2.
    Delete all the files in C:\Cyberpunk2077Mod\WolvenKit.CLI from the previous release so that any cached and orphaned files do not corrupt the updated release.

Extracting the downloaded files

Regular Wolvenkit

Extract the zip file Wolvenkit-X.X.X.zip to C:\Cyberpunk2077Mod\WolvenKit.

Optional: Wolvenkit Console

Unpack the zip file Wolvenkit.Console-X.X.X.zip toC:\Cyberpunk2077Mod\WolvenKit.CLI.

Optional: Creating a shortcut

If you want to launch Wolvenkit without browsing to the folder every time, you can create a custom shortcut and pin it to the start menu.
  1. 1.
    Go to C:\Cyberpunk2077Mod\WolvenKit
  2. 2.
    Right-click the executable WolvenKit.exe
  3. 3.
    Select "Create Shortcut"
  4. 4.
    You should now see something like this:
  5. 5.
    Click "OK"
  6. 6.
    Right-click on your shortcut again and select "Pin to Start Menu"
  7. 7.
    That's it! You can launch now!

First Launch - TL;DR

For full instructions on how to configure Wolvenkit, please see the detailed guide.
For a more detailed explanation of the options below, please see the corresponding wiki page. You can change them at any time by going to Wolvenkit Home and opening the settings page.
When launching WolvenKit for the first time you will be greeted with a welcome form asking to set your preferences. We recommend setting the path to your game files immediately.
The Game Executable Path (.exe) is the file path or location of the Cyberpunk2077.exe file. This can be set by manually entering a file path, or using the folder icon to open Windows Explorer.
The Depot Path is where WolvenKit will keep extracted Cyberpunk assets and files that are required for regular operation.