WolvenKit / Wolvenkit

REDEngine Community Toolkit

About • How To Use • Team • Credits • Contribute • License

About

This repository was created to demonstrate how the proprietary game engine of CDPR, REDEngine, reads and writes file formats, and experiment with how their games running on this engine (The Witcher 3: The Wild Hunt and Cyberpunk 2077 currently) work. This tool suite is being made fully for research and educational purposes, and the dev team is in no way responsible of a hypothetical malfunction regarding the game or PC of the end user. It's completely open source, licensed under GPL v3.0, and in no way is it made to generate revenue. The precursor to this tool, W3EDit, was 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, it allows reading and writing nearly every REDEngine file format to some extent. It can be used to create file modifications to the assets of the game. This is heavy WIP, so do make sure to check on it regularly. Our primary focus at the moment is progressing with support for the new game, Cyberpunk 2077.

How to Use

WolvenKit can either be built from source or acquired pre-built via the installer.

Build • Install

Install WolvenKit

1. Download WolvenKit

   1. Get the latest release here: https://github.com/WolvenKit/Wolvenkit/releases/latest.

2. Launch the installer.

   1. Double click on the .exe to start the installation procedure. The program will take care of the rest.

Build WolvenKit

1. Install .NET 5

   1. https://dotnet.microsoft.com/download/dotnet/5.0

2. Install the latest Visual Studio release.

   1. https://visualstudio.microsoft.com/downloads/

3. Required files

   1. All the required files are either nuget packages, which will automatically be downloaded once Build is pressed, or readily included in the package in the Libs directory.
   2. If, for some reason, the LFS quota is depleted, the renderer prerequisite libs can be acquired here: https://outwa.it/lib.zip

Contribute

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 stupid mistakes that may lead to the denial of the pull request. It's a good idea create an issue when implementing a feature so people don't work on the same feature/issue in an asynchronous manner.

For any questions

• PM Traderain#3279 on Discord,
• Mail [email protected],
• Join the Cyberpunk 2077 Modding Server for active development, or the old server for general chatting.

The WolvenKit Team

Core Development Team

Traderain	rfuzzo	kote2ster	Murzinio	Offline-R503B	Maxzor	vonLeebpl	TheBloke	ja-to	michaelpolakatwork	DerinHalil	HitmanHimself	Lim3zer0	phrisk	ali-alidoust	Anras573	carlosproiete	Jicksaw	TheFusion21	mattstates	robymontyz	Strahlemann83	sw3dg1n	dingdio	dnandha	hrkrx	philippTheCat

Credits

• Zenhax
• Xentax
• Lua Utils for W3
• TW3 Booster
• TW3 Converter
• VgmToolbox
• TW3 Mod Discussion
• Payday 2 Modding Information
• ModWorkshop
• W3 SaveGame Editor
• ffmpeg
• irrlicht
• Sarcenzzz for W3Edit

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.