# Download, Install and Setup
## Summary
**Published: October 22 2020**\
**Created by @JJTurtle**\
\
**Last documented update: @reihera, April 20 2025**
This section will walk you through the process of downloading and installing Wolvenkit.
{% hint style="info" %}
There is a [Full Install Walkthrough (ELI5)](https://wiki.redmodding.org/wolvenkit/getting-started/eli5-getting-started), 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](#prerequisites). :)
{% endhint %}
### TL;DR
1. Install REDMod and .NET from the [Prerequisites](#prerequisites) section below
2. Download Wolvenkit-X.X.X.zip from github ([stable](https://github.com/WolvenKit/Wolvenkit/releases) | [nightly](https://github.com/WolvenKit/WolvenKit-nightly-releases/releases/))
3. Extract it to a folder of your choice
4. Run it and do the [initial configuration](#first-launch-tl-dr)
5. Optional: Proceed to the guide how to [set up the modding tools](https://wiki.redmodding.org/wolvenkit/getting-started/eli5-getting-started/configure-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](https://app.gitbook.com/s/4gzcGtLrr90pVjAWVdTc/for-mod-users/users-modding-cyberpunk-2077/redmod#installation) (Cyberpunk's modding framework)
* For older WKit versions: [Microsoft .NET 6](https://dotnet.microsoft.com/en-us/download/dotnet/6.0) (versions <= 8.7.1)
* For current WKit: The most recent [Microsoft .NET](https://dotnet.microsoft.com/en-us/download) (confirmed working with [.NET 8](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) and Wolvenkit 8.13)
{% hint style="success" %}
Wolvenkit is mostly developed and used on Windows — if you're on Linux, you should know what we're doing, and this guide isn't for you.
**Unrelated:** The Wolvenkit developer team is looking for a Linux nerd who'd like to keep things compatible!
{% endhint %}
Downloading .NET
Open either of these pages:
* [6.0](https://dotnet.microsoft.com/en-us/download)
* [7.0](https://dotnet.microsoft.com/en-us/download/dotnet/7.0)
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 :smile:)
## Downloading Wolvenkit
{% hint style="info" %}
If you don't care about the differences, go to the next section: [Which version do I want?](#which-version-do-i-want)
{% endhint %}
You can download Wolvenkit from any of the following links (click on the cards). If you are uncertain, go to [Nexus](https://www.nexusmods.com/cyberpunk2077/mods/2201).
{% hint style="info" %}
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](https://github.com/WolvenKit/Wolvenkit/releases) or Nightly [tester and developer builds](https://github.com/WolvenKit/WolvenKit-nightly-releases/releases/tag/8.9.1-nightly.2023-07-28) fresh from the pipeline.
One of the Wolvenkit developers will download the stable version from github to put it on [Nexus](https://www.nexusmods.com/cyberpunk2077/mods/2201), so you can get it from there as well.
{% endhint %}
### 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](https://github.com/WolvenKit/WolvenKit/releases) | [](https://github.com/WolvenKit/WolvenKit/releases/latest) |  |
| [WolvenKit Nightly](https://github.com/WolvenKit/WolvenKit-nightly-releases/releases) | [](https://github.com/WolvenKit/WolvenKit-nightly-releases/releases/latest) |  |
## 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:
{% hint style="info" %}
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.
{% endhint %}
| 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. Currently (December 2024), the installer has issues.
|
|
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.
* [Stable Release](https://github.com/WolvenKit/WolvenKit/releases/latest)
* [Nightly Release](https://github.com/WolvenKit/WolvenKit-nightly-releases/releases/latest)
## Installing
WolvenKit is not technically installed, you extract the downloaded file into a folder and it runs as a [portable application](https://en.wikipedia.org/wiki/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.`
{% hint style="info" %}
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`
You can use other paths, the guide just assumes that you don't.
{% endhint %}
Making your Cyberpunk2077Mod folder & Extracting your WolvenKit.zip file
You can manually make your `Cyberpunk2077Mod` folder in the root of your C: drive by:
1. Right-clicking your C: drive, Click 'New Folder'\
\- On Windows 11 you'll have to click 'Show More Options' at the bottom of the list 🙄\\
2. Type or Paste in Cyberpunk2077Mod & press Enter\
\- You may see the Folder populate within another Directory Folder, this should self-resolve after pressing Enter
3. From, presumably, your Downloads Folder, drag & drop your wolvenkit.zip file into C:\Cyberpunk2077Mod\\
4. With WolvenKit.zip selected, either right click to Extract All or Click the Extract All Button in File Explorer to begin Extracting\\
All Done!
### For Linux Users
{% hint style="warning" %}
Linux compatability works off of a combination of throwing things at the wall and dark magic. As such, we cannot guarantee stability when using Linux.
{% endhint %}
#### Installation
1. Download the `WolvenKit-x.x.x.zip` or `WolvenKit-x.x.x-nightly.yyyy.mm.dd.zip` files (NOT THE LINUX VERSION) from [Stable](https://github.com/WolvenKit/WolvenKit/releases/latest) or [Nightly](https://github.com/WolvenKit/WolvenKit-nightly-releases/releases/latest) releases, depending on how much you want to gamble.
2. Extract them literally wherever you want it doesn't really matter, just remember where you put it.
3. Find the `WolvenKit.exe` file in the extracted zip file, copy the path.
4. Now here's where it gets weird, open Steam and go to your libary. Find the "Games" tab on the menu bar, and click on "Add a Non-Steam Game to My Library"
5. In the window that just opened, press "browse", and paste the link, then select `WolvenKit.exe` if it's not selected already, and press "Add Selected Program".
6. Find WolvenKit in your library, right click on it in the sidebar, press properties. Go into the compatability tab, select "Force the use of a specific Steam Play compatability tool" and then select "Proton Hotfix".
7. When you first launch, it will ask for path to Cyberpunk2077.exe. It will be located in `~/.steam/steam/steamapps/common/Cyberpunk 2077/bin/x64/Cyberpunk2077.exe`
8. All done!
{% hint style="info" %}
The steps above are to setup running WolvenKit with Proton by adding it to Steam, which is easiest for most users. You can skip this hint if you're fine with that.
Experienced Linux users can alternatively run with Proton directly by installing Proton-GE system-wide and registering it as the default program to open Windows executables with (instead of Wine). This is done with `binfmt`, which is a modular system to tell Linux how to execute binary files.
Note that is a system-wide change and will affect how all Windows programs are opened, effectively replacing Wine with Proton. Steps may vary between distros, make sure to check your distro's binfmt manual page (`man binfm.d` or find it online, for example [the Arch Linux one](https://man.archlinux.org/man/binfmt.d.5.en)), but the general idea is:
* Install Proton-GE system-wide (for example on Arch Linux use `yay -S proton-ge-custom-bin`), you should end up with `proton-ge` as a runnable terminal command
* If Wine is installed, disable the default Wine binfmt handlers
* They are usually located at `/usr/lib/binfmt.d/`, usually both `wine.conf` and `mono.conf`
* Disable them by making a symbolic link to `/dev/null` in `/etc/binfmt.d` with the same name, for example `sudo ln -s /dev/null /etc/binfmt.d/wine.conf` and `sudo ln -s /dev/null /etc/binfmt.d/mono.conf`
* Make a new custom binfmt handler at `/etc/binfmt.d/proton-ge.conf` based on `/usr/lib/binfmt.d/wine.conf`, for example with this content:
* `:DOSWin:M::MZ::/usr/bin/proton-ge:`
* Reload the binfmt configuration with `sudo systemctl restart systemd-binfmt`
After this, double-clicking any Windows program should open it with Proton, including WolvenKit. This means you can just download the latest `WolvenKit-x.x.x.zip`, extract it, and double-click `WolvenKit.exe`. In some cases you might also need to `chmod +x WolvenKit.exe`.
{% endhint %}
#### Known Linux Issues (see [bug reports](https://wiki.redmodding.org/wolvenkit/help/bug-reports) for reporting):
* Mesh Preview does not work.
* Font is not loaded correctly.
* The launch splash is not transparent on Stable.
### TLDR;
1. Download the new release, extract the files (over your old install if you have one) and run it.
2. Optional: Proceed to the [full configuration instructions](https://wiki.redmodding.org/wolvenkit/getting-started/eli5-getting-started/configure-modding-tools).
3. Troubleshooting: Delete everything in the install folder, then re-extract the downloaded files again.
4. More troubleshooting: Find us on [Discord](https://discord.com/channels/717692382849663036/808086068023918603) in the [#wolvenkit-help-me](https://discord.com/channels/717692382849663036/808086068023918603) channel.
### Optional: Removing old versions
If you don't have any old versions installed, you can proceed to the next section.
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. 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](#detailed-download-instructions-with-screenshots) to `C:\Cyberpunk2077Mod\WolvenKit.`
#### Optional: Wolvenkit Console
Unpack the zip file [Wolvenkit.Console-X.X.X.zip ](#detailed-download-instructions-with-screenshots)to`C:\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. Go to `C:\Cyberpunk2077Mod\WolvenKit`
2. Right-click the executable `WolvenKit.exe`
3. Select "Create Shortcut"
4. You should now see something like this:
5. Click "OK"
6. Right-click on your shortcut again and select "Pin to Start Menu"
7. That's it! You can launch now!
## First Launch - TL;DR
{% hint style="info" %}
For full instructions on how to configure Wolvenkit, please see the [detailed guide](https://wiki.redmodding.org/wolvenkit/getting-started/eli5-getting-started/configure-modding-tools).
For a more detailed explanation of the options below, please see the [corresponding wiki page](https://wiki.redmodding.org/wolvenkit/wolvenkit-app/settings#settings-explained). You can change them at any time by going to [Wolvenkit Home](https://wiki.redmodding.org/wolvenkit/wolvenkit-app/home) and opening the [settings page](https://wiki.redmodding.org/wolvenkit/wolvenkit-app/settings).
{% endhint %}
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.
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://wiki.redmodding.org/wolvenkit/getting-started/download.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
