Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/WolvenKit/WolvenKit
Community Mod editor/creator for REDengine games.
https://github.com/WolvenKit/WolvenKit
cyberpunk2077 game hacktoberfest modding-tools witcher-3
Last synced: 29 days ago
JSON representation
Community Mod editor/creator for REDengine games.
- Host: GitHub
- URL: https://github.com/WolvenKit/WolvenKit
- Owner: WolvenKit
- License: gpl-3.0
- Created: 2017-01-18T13:42:13.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2024-04-13T20:37:40.000Z (8 months ago)
- Last Synced: 2024-04-13T21:48:01.722Z (8 months ago)
- Topics: cyberpunk2077, game, hacktoberfest, modding-tools, witcher-3
- Language: C#
- Homepage: http://redmodding.org/
- Size: 806 MB
- Stars: 848
- Watchers: 56
- Forks: 158
- Open Issues: 136
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.txt
- Contributing: docs/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: docs/CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-cyberpunk - WolvenKit - Community modding tool for REDengine games. (Modding resources / Tools)
- awesome-modding - WolvenKit - REDEngine 4 file editor designed to simplify and accelerate modding workflow. (REDEngine Games (CD Projekt) / Cyberpunk 2077 / REDEngine 4)
README
> ⚠️ 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 •
Usage •
Contributing •
Screenshots •
Credits •
License
## Installation
Wolvenkit requires the latest .NET 8.0 runtime:
1. Go to [Microsoft's .NET download page](https://dotnet.microsoft.com/en-us/download/dotnet/8.0)
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](https://github.com/WolvenKit/WolvenKit.Installer) and you can install it from there. Click here: [](https://github.com/WolvenKit/WolvenKit.Installer/releases/latest)
### Portable or Installer
Download either the latest stable version or the current nightly (beta) version from here:
| Package | Latest Release | Checks |
| ------- | ------------ | ----------------- |
| [WolvenKit Nightly](https://github.com/WolvenKit/WolvenKit-nightly-releases/releases/latest) | [](https://github.com/WolvenKit/WolvenKit-nightly-releases/releases/latest) |  |
| [WolvenKit](https://github.com/WolvenKit/WolvenKit/releases/latest) | [](https://github.com/WolvenKit/WolvenKit/releases/latest) |  |
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](https://www.visualstudio.com/) or a higher version.
2. Clone this repository.
3. Open the solution (`All.sln`)
4. Build the projects.
## Contributing
- Join the [Cyberpunk 2077 Modding Server](https://discord.gg/Epkq79kd96) for active development
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](/docs/CONTRIBUTING.md).**
For any questions:
Developer | Role | Email
------------ | ------------- | -------------
[Seberoth](https://github.com/seberoth) | Project Lead / Core Development |
[Rfuzzo](https://github.com/rfuzzo) | Project Lead / Core Development | [Email](mailto:[email protected])
[Traderain](https://github.com/Traderain) | Project Lead | [Email](mailto:[email protected])
## Screenshots
## 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](https://www.jetbrains.com) who supplied open source licences for our developers
- [Syncfusion](https://www.syncfusion.com/company/about-us) who supplied an open source licence for the WPF controls we use
- [Ab3d PowerToys](https://www.ab4d.com/PowerToys.aspx)
- [Ab3d DXEngine](https://www.ab4d.com/DXEngine.aspx)
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.
- [Assimp](https://github.com/assimp/assimp-net)
- [Zenhax](https://zenhax.com)
- [Xentax](https://xentax.com)
- [Lua Utils for W3](https://github.com/hhrhhr/Lua-utils-for-Witcher-3)
- [TW3 Booster](https://github.com/gamebooster/witcher3-booster)
- [TW3 Converter](https://bitbucket.org/jlouis/witcherconverter)
- [VgmToolbox](https://sourceforge.net/projects/vgmtoolbox/)
- [TW3 Mod Discussion](http://forums.cdprojektred.com/forum/en/the-witcher-series/the-witcher-3-wild-hunt/mod-discussions)
- [Payday 2 Modding Information](https://bitbucket.org/zabb65/payday-2-modding-information)
- [ModWorkshop](https://modworkshop.net/showthread.php?tid=101)
- [W3 SaveGame Editor](https://github.com/Atvaark/W3SavegameEditor)
- [ffmpeg](https://www.ffmpeg.org/)
- [irrlicht](http://irrlicht.sourceforge.net/)
## 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.