/WolvenKit

Community Mod editor/creator for REDengine games.

Primary LanguageC#GNU General Public License v3.0GPL-3.0



GitHub Release Date GitHub Workflow Status GitHub milestone GitHub all releases GitHub issues GitHub commit activity

⚠️ This repository focuses on REDengine 4 for Cyberpunk 2077. For WolvenKit for The Witcher 3: Wild Hunt please see: https://github.com/WolvenKit/WolvenKit-7

WolvenKit is an open-source modding tool for Cyberpunk 2077. Our vision is to develop a standalone software which is capable of reading and writing all REDengine file formats. Additionally the WolvenKit application is designed to simplify and accelerate modding workflows. This repository was created to demonstrate how CDPR's proprietary REDengine reads and writes file formats.

This toolkit is being made solely for research and educational purposes, and the dev team is in no way responsible for any malfunctions that occur from its use. It's completely open source, licensed under the GPL-3.0, and in no way is it made to generate revenue.


Installation

Wolvenkit requires the latest .NET 8.0 runtime:

  1. Go to Microsoft's .NET download page
  2. Find the ".NET Desktop Runtime 8.0.x" section and download the installer for your architecture (x64)
  3. Run the downloaded installer

There are multiple ways to install Wolvenkit:

The WolvenKit.Installer app

The WolvenKit.Installer app is a simple program for managing (installing, updating, removing) different WolvenKit versions similar to the Visual Studio Installer app.

It is hosted on github and you can install it from there. Click here: GitHub release (latest by date)

Portable or Installer

Download either the latest stable version or the current nightly (beta) version from here:

Package Latest Release Checks
WolvenKit Nightly GitHub release (latest by date) GitHub Workflow Status
WolvenKit GitHub release (latest by date) GitHub Workflow Status

To install the app quickly download WolvenKitSetup-x.x.x.exe and double click to run the installer.

You can also simply download WolvenKit-x.x.x.x.zip and extract it to a location of your choice

Usage

📑 Check out the wiki: https://wiki.redmodding.org/wolvenkit

Build instructions

If you want to build the app from source yourself:

  1. Download and install Visual Studio 2022 Community Edition or a higher version.
  2. Clone this repository.
  3. Open the solution (All.sln)
  4. Build the projects.

Contributing

Do you want to contribute? Community feedback and contributions are highly appreciated! 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.

For general rules and guidelines see CONTRIBUTING.md.

For any questions:

Developer Role Email
Seberoth Project Lead / Core Development
Rfuzzo Project Lead / Core Development Email
Traderain Project Lead Email

Screenshots

WK 8 6 Home Page Example

WK 8 6 Editor Example

Credits

WolvenKit is a direct result of the hard work and continuous support, financial and otherwise, of the many researchers, programmers, artists, contributors, and companies that have helped with this project. Without their outstanding work and generous support, we never would have been able to create WolvenKit for Cyberpunk 2077. A very special thank you goes out to...

JetBrains Logo (Main) logo.

An ancestor to this tool was W3Edit, initially developed by Sarcen in 2015, around the time The Witcher 3 first came out. After Sarcen stopped working on it, a few of us picked it up and continued from there.

License

Copyright Disclaimer: Under Section 107 of the Copyright Act 1976, allowance is made for "fair use" for purposes such as criticism, comment, news reporting, teaching, scholarship, and research. Fair use is permitted by copyright statute that might otherwise be infringing. Non-profit, educational or personal use tips the balance in favor of fair use.. This project is solely made for research and in no way made to generate any revenue.