Skip to content

Latest commit

 

History

History
153 lines (93 loc) · 11.6 KB

README.md

File metadata and controls

153 lines (93 loc) · 11.6 KB
Raw

Download from Releases >>>

Download the latest version from Releases, unless you specifically want the source code.

Cyberpunk Blender Add-on

blender add-on banner panam

The Cyberpunk IO Suite is part of the Cyberpunk 2077 modding toolchain, bridging the gap between WolvenKit and Blender.

You can find detailed documentation (and much else) on the Cyberpunk 2077 modding wiki.

Features

blender add-on yaiba exampe

Import:

  • Meshes: Import Cyberpunk 2077 meshes from Wovlenkit with a fully automated setup of the game's complex shaders — in just a few clicks.

    Hint: The add-on doesn't support all Cyberpunk shaders yet, but we're working on it!

  • Characters and vehicles: Point the plugin at the Wolvenkit export and it will include all meshes and materials from your project, setting them up to match the in-game appearance you specified.

  • Colliders: Import colliders from Wolvenkit exported .phys and entity jsons for easy visualization and editing

  • Cyberpunk 2077 animations: Play animations directly on your exported models — either by importing them from file, or by using the bundled rig resources via the Cyberpunk Animations Panel

  • Level data (streamingsectors): Import the map(.streamingsector) from Cyberpunk 2077 into Blender and change the world — literally.

Export:

  • Mesh to .glb: The plugin's export functions aims for maximum compatibility with Wolvenkit. Our exporter supports shapekeys and GarmentSupport and checks for common things that will cause the Wolvenkit export to fail. Where issues are found, the plugin provides simplified solutions to speed up your workflow.

  • Animations: Export new and edited animations to GLB

  • Collisions: Export generated collision shapes to .phys.json

Tools and Shortcuts:

Hint: You can find more detailed documentation on the Cyberpunk 2077 Modding Wiki

Animation Tools Panel

  • shortcuts for playing, renaming and deleting existing animations
  • add new actions and insert keyframes
  • all from outside Blender's animations tab

Mesh Tools Panel

  • Auto refit clothing meshes to a variety of different modded and vanilla body shapes.
    This functionality is based on research and work by AllKnowingLion
  • Simplified weight transfer shortcut with the best settings - no more hassle for you
  • Mesh clean up panel can automatically assign ungrouped vertices to the nearest bone
  • UV Checker: switch the currently active material for a coloured grid with numbers for easier UV editing - and back!

Collision Tools and Generator

  • Automatic generation of convex colliders matched perfectly to the shape of your mesh, the number of vertices to sample should be set to match the number set in the .phys file in order to ensure successful export.
  • Generate colliders with either user specified sizing or sized automatically to match the selected mesh
  • Export your generated collision bodies to .phys.json for use in game.

Material Exports

  • Hair profiles: export custom hair profiles to .hp.json for easy import with Wolvenkit.
    The .hp.json will be named after the material in blender and will be automatically deposited in the raw folder of the project that the hair mesh was exported from. The material name in blender must end with _cards to match the setup of imported vanilla hair profiles (_cards will not be part of the .hp.json export)
  • .mlsetup (experimental/WIP): After activating this feature in the plugin's preferences, write changes back to .mlsetup files. This feature is currently in development. For in-depth editing of .mlsetup files, you should use Neurolinked's fantastic MlSetup builder software.

Requirements

  1. Blender version 4.0 or higher is highly recommended
    Blender versions below 3.6 will not work and users of these versions should update Blender before installing the plugin
    https://www.blender.org/

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

Usage

Installation

NOTE: You can find step-by-step instructions on the Cyberpunk 2077 Modding Wiki.

  1. Download the .ZIP file from the Releases section

  2. Install the downloaded zip from Blender's preferences (Edit \ Preferences \ Add-ons \ Install...).

  3. Be sure the add-on is enabled (filter the list of installed add-ons and ).

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

Meshes and animations

Mesh Import

  1. Export a mesh with materials from WolvenKit

  2. Import it into Blender from the menu (File \ Import \ Cyberpunk GLTF) by selecting the exported glTF/glb file. Within the import options, choose the same texture format as the WolvenKit export. (PNG is default)

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.

Animation import

  1. Export the animation from Wolvenkit. The default settings are fine.

  2. Import it into Blender from the menu (File \ Import \ Cyberpunk GLTF) and select the exported glTF/glb file. You can ignore materials.

Animation export

  1. Follow the community guides in order to import your anims to Blender and make the necessary edits
  2. Select the armature that you want to export
  3. Export it via menu (**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.

Entity Import

  1. Export your .ent from Wolvenkit by running the correct script from Wolvenkit's script manager

  2. Import the .ent.json from the menu (File \ Import \ Cyberpunk Entity).

Hint: 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. Export your .streamingsector by running the correct script from Wolvenkit's script manager.

  2. Import the .cpmodproj from the menu (File \ Import \ Cyberpunk StreamingSectors). All sector file jsons found in the project raw folders will be imported.

Streaming Sector Export

To export changes in streaming sectors, you have to run a Python script as of version 1.5.1. Detailed documentation can be found on the wiki.

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 add-on was originally created by @HitmanHimself as CP77research as one of multiple projects to study and reverse-engineer elements of Cyberpunk 2077. It was originally based on @Turk645's research and implementation.

As of 2023, it is now maintained by the RED Modding GitHub community to continue support and centralize development.