/WolvenKit

Mod editor/creator for RED Engine games. The point is to have an all in one tool for creating mods for the games made with the engine.

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



This repository was created to demonstrate how CDPR's proprietary REDEngine reads and writes file formats. And to experiment with the working of games running on this engine i.e. The Witcher 3: The Wild Hunt and Cyberpunk 2077. 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. Its completely open source, licensed under the GPL v3.0, and in no way is it made to generate revenue. 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.

Currently, WolvenKit allows reading and writing nearly every REDEngine file format to some extent. It can also be used to create file modifications to the assets of the game, though this is currently beign actively worked upon, so do make sure to check it regularly. Our primary focus at the moment is progressing with support for the new game, Cyberpunk 2077.

Installation • Usage • Contributing • Screenshots • Credits • License

Become-a-patron-button Pngtree-file-download-icon-4719240

Installation

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 branch checks state

Installer

  1. Install the NET 6 Runtime: https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/runtime-6.0.1-windows-x64-installer
  2. Double click on the .exe to start the installation procedure and the program will take care of the rest.

Portable

  1. Install the NET 6 Runtime: https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/runtime-6.0.1-windows-x64-installer
  2. Download Wolvenkit.zip
  3. Run WolvenKit.exe

Usage

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

Build instructions

  1. Download and install Visual Studio 2022 Community Edition or a higher version.
  2. Clone this repository.
  3. Clone the dependencies (git submodule update --init --recursive).
  4. Open the solution (All.sln)
  5. 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
Traderain Project Lead / Core Development Email
Rfuzzo Project Lead / Core Development Email

Screenshots

screenshot

screenshot

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...

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.