Skip to content

The Cyberpunk add-on for Blender bridges complex game assets with Blender.

Notifications You must be signed in to change notification settings

thedigitaloctopus/Cyberpunk-Blender-add-on

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 

Repository files navigation

Cyberpunk Blender Add-on

blender add-on banner panam

The Cyberpunk Blender add-on is designed to fully automate the shader setup for Cyberpunk 2077 mesh files. The add-on integrates with files created by WolvenKit. To learn more about WolvenKit visit the dedicated WolvenKit wiki.

Features

blender add-on yaiba exampe

  • Import Cyberpunk 2077 models and their complex shaders with just a few clicks

  • Import Cyberpunk 2077 entity files such as vehicles with mesh files correctly distributed to match their in game appearance

  • Import Cyberpunk 2077 level data (streaming sectors)

  • Export glTF models with optimized export options for use with WolvenKit for Cyberpunk 2077


Requirements

  1. Blender version 3.6 or higher is highly recommended
    Blender version 3.1 or higher is required
    https://www.blender.org/

  2. WolvenKit version 8.9.0 or higher
    https://github.com/WolvenKit/WolvenKit


Usage

Not all Cyberpunk shaders are currently supported by the add-on.

Installation

  1. Download the .ZIP file from the Releases section

  2. Install the Cyberpunk add-on for Blender by navigating within Blender to Edit \ Preferences \ Add-ons \ Install... and locating the downloaded .ZIP file. Be sure the add-on is enabled by marking the checkbox within the installed add-on list.

  3. When installed Cyberpunk options should be available under File \ Import and File \ Export

Mesh Import

  1. Export a mesh with materials using WolvenKit Learn more

  2. Navigate within Blender to File \ Import \ Cyberpunk GLTF and select the exported glTF/glb file. Within the import options choose the same texture format as the WolvenKit export. (PNG is default)

Entity Import

  1. Convert the ent file to json and export all the meshes used using WolvenKit, a wscript to automate this is available on Discord in the #wolvenkit-scripts channel.

  2. Navigate within Blender to File \ Import \ Cyberpunk Entity and select the exported json file. You can enter the appearance you want in the import options, this requires the appearanceName from the entity appearances info. Enter ALL for all appearances.

Streaming Sector Import

  1. Convert the streaming sectors you want to import from WolvenKit as json, and export all the meshes used using WolvenKit, a wscript to automate this is available on Discord in the wolvenkit-scripts channel.

  2. Navigate within Blender to File \ Import \ Cyberpunk StreamingSectors and select the wkit project file for the project they were added to. All sector file jsons found in the project raw folders will be imported.

Mesh Export as GLB

  1. Follow the steps above to import and edit your meshes.
  2. Select the mesh you want to export
  3. Navigate within Blender to **File \ Export \ Export Selection to GLB for Cyberpunk
  4. Select the desired file path and name
  5. Export

The plugin will automatically apply the correct settings to ensure your mesh imports back into WolvenKit for use with your mod.

Export Animations For Photomode

**Should work for all types of animation

  1. Follow the community guides in order to import your anims to Blender and make the necessary edits
  2. Select the armature which contains the animations you'd like to export
  3. Navigate within Blender to **File \ Export \ Export Selection to GLB for Cyberpunk
  4. Check the "Export as Photomode Pose" box
  5. Select the desired file path and name
  6. Export

The plugin will apply the correct settings to ensure your animation imports back into WolvenKit and is correct in game.


Contributing

Anybody is welcome contribute to the Cyberpunk Blender Add-on by opening a Pull Request with this repository. If you're interested in chatting or getting involved with the project please consider reaching out to us on our Discord, Cyberpunk 2077 Modding Community.


About the add-on

This repository was originally created by @HitmanHimself as CP77research to help study and reverse engineer elements of Cyberpunk 2077. HitmanHimself's cp77research contained various modding-related projects and documentation, including the Cyberpunk add-on for Blender. The add-on HitmanHimself created was based on research and initial python implementation by @Turk645. The add-on is now maintained here by the RED Modding GitHub organization to continue support and centralize development.

About

The Cyberpunk add-on for Blender bridges complex game assets with Blender.

Topics

Resources

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%