Summary

Published: ??? by Last documented edit: May 20 2024 by

This is the landing page for the Wolvenkit Blender plugin. Here, you can find #usage instructions, as well as an overview of its features:

• #animation-tools

• #mesh-tools

• #akl-autofitter

• #collision-tools

• #hair-profiles-.hp

Wait, this is not what I want!

• If this is your first time using Blender, you can check out Blender: Getting Started

• Under Installing the Wolvenkit Blender Plugin, you can find a detailed install guide

• For detailed usage instructions, check WKit Blender Plugin: Import/Export

• The plug-in's source code and original readme are on github

• If you run into issues using the plugin, you can check WKit Blender Plugin: Troubleshooting

Compatibility

Usage

As soon as you have a mesh or armature selected, the viewport toolbar (keyboard shortcut to hide/unhide: n) will show you the CP77 Modding tab:

Features

Animation Tools

In the animation tools, you can find

• shortcuts for playing, renaming and deleting existing animations

• shortcuts to add new actions and insert keyframes

You can load one of Cyberpunk's default armatures at any time:

If you import an .anims file, selecting any armature will give you the option to play any existing animation:

Mesh Tools

Transfer Vertex Weights

Lets you transfer vertex weights from one collection to the other (please read the info box below):

AKL Autofitter

For documentation of the autofitter, see the corresponding wiki page.

Modifiers

Lets you change the armature target (the skeleton that'll move and deform your mesh)

Material Export: Hair

Lets you export a hair profile. For documentation, see #hair-profiles-.hp

UV Checker

With the press of a button, you can switch out the currently active material to a coloured and numbered grid for easier UV mapping.

If the UV checker is currently assigned, pushing the button again will restore the original material.

Collision Tools

The collision tools and -generator can

• generate of convex colliders with the exact 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 box and capsule colliders with either user specified sizing or sized automatically to match the selected mesh

• export edited collision bodies back to .phys ***currently requires a wolvenkit converted .phys.json file

Summary

Published: 22.09.2024 by Last documented update: 22.09.2024 by

This guide will show you how to download and install the from github source.

Step 1: Download from github

1. Head to the Wolvenkit Blender IO suite's

2. Click the green Code button

3. Click "Download ZIP" at the bottom

1. You should have downloaded a file called Cyberpunk-Blender-add-on-main.zip.

Step 2: Finding the install location

2.1: Find the correct install path

1. Open the Blender Preferences (Toolbar: Edit -> Preferences) and select the AddOns tab

2. Search for cyberpunk

3. See the current install path under File. It should be something like this:

1. Everything before the __init__.py is the path to the current install.

2.2: Delete the old install

1. Navigate your Windows Explorer to the path you found in 2.3 (Shortcut: Windows+R, type %APPDATA%, confirm, then browse from there)

2. Delete the whole i_scene_cp77_gltf folder.

3. Leave the explorer window open, you need it for Step 3!

Step 3: Extract the download

1. Open Cyberpunk-Blender-add-on-main.zip that you downloaded in step 1.

2. Find the folder named i_scene_cp77_gltf. This is the blender add-on:

1. Copy or drag the folder to the addons folder from step 2.2.

Step 3: Restart Blender

After restarting Blender, you now have the very latest version of the plugin. If you want anything more recent, you have to become a developer yourself.

Happy modding!

Summary

Published: ??? by Last documented edit: May 26 2024 by

This page lists step-by-step instructions for the export and import of game files.

The Wolvenkit parts of the workflow will link you to the , where you can find screenshots and (hopefully) up-to-date descriptions.

Wait, this is not what I want!

• (Wolvenkit wiki)

• (Wolvenkit wiki)

• If this is your first time using Blender, check

• (has additional information that might come in handy)

Meshes

Export from Wolvenkit

For where to export a mesh, see

For how to export a mesh, see

Importing into Blender

Select File -> Import -> Cyberpunk GLTF

In the Blender File view, find the glb you exported from Wolvenkit. By default, the textures will be saved to your material depot in PNG format already.

Exporting from Blender

Select File -> Export -> Cyberpunk GLB

For an explanation of the sidebar settings on the right, read on below the picture.

Animations (checkbox)

Limit to Selected Meshes

By default, the Wolvenkit Blender IO Suite will only export selected meshes and their parent armatures. Unchecking this box will display the Export Visible Meshes checkbox, which is unchecked by default.

If you don't check either of these boxes, the plutin will export all meshes and armatures into the same .glb file. You usually do not want this.

Importing into Wolvenkit

Animations

Export from Wolvenkit

Importing into Blender

The process of importing animations into Blender is the same as it is with meshes.

Exporting from Blender

1. Select your armature

Importing into Wolvenkit

Entities

Export from Wolvenkit

You can export an entity by adding it to your project and running the corresponding script from inside Wolvenkit. Here are the relevant guides:

Importing into Blender

After you have exported the entity from Wolvenkit via script, switch to Blender and select File -> Import -> Cyberpunk Entity (.json)

Navigate the file browser to the ent.json in your project's raw folder and import it.

Use Cycles

Will switch the workbench's rendering mode from Eevee to Cycles. This will make sure that the shaders work as intended.

Update Global Illumination

Will fix lighting

With Materials

Will read materials from material.json files, generating shaders in the process.

Include Vehicle Collisions

This option imports a vehicle entities collision bodies for editing. The collision bodies give substance to the mesh and determine how the world responds to the vehicle - without proper collision bodies, your character, NPCs and anything else your vehicle bumps into would pass right through the mesh. Unless you're adding a new vehicle or significantly altering an existing one, you generally want to leave this box unchecked.

Exporting from Blender

Entity export is currently (1.5.0) not supported.

To export edited collision bodies back to .phys.json, simply press the "export collisions" button in the Collision Tools Panel and use the File View to navigate to your original .phys.json.

** Currently only modifying existing .phys files is supported.

Streaming Sectors

Export from Wolvenkit

Importing into Blender

After you have exported the streamingsector from Wolvenkit via script, switch to Blender and select File -> Import -> Cyberpunk StreamingSector

Navigate in the file view to your Wolvenkit project's root file, and select the .cpmodproj file:

Exporting from Blender

Hair profiles (.hp)

Importing to Blender

Editing the hair profile

Select the imported hair and switch to Blender's Shading perspective. Here, you can alter the gradients,

Exporting from Blender

1. Recommended: make sure that your material name in Blender ends with _cards

2. Make sure that your hair mesh is selected

3. In the CP77 Modding panel, select Export Hair Profile

Your new .hp.json file will be generated in the raw folder of Wolvenkit project that you imported the hair mesh from with the name of mod_<material name in Blender>.hp.json:

Summary

Published: ??? by Last documented update: 22.09.2024 by

Step 0: Uninstall the old version

1. Open the Blender Preferences (Toolbar: Edit -> Preferences) and select the AddOns tab

Complete either of the options below:

Click the Remove button

The build-in Blender way. Should work. If it doesn't check the second option

Delete the files on your disk

Check the plugin's file entry. It will usually be something like this:

Navigate there with your Windows Explorer (Hotkey: Windows+R, paste the path above after changing your Blender version), and delete everything — either the entire folder, or all files inside.

Step 1: Install the plugin

Download the latest release of the plugin from github:

2. Scroll past the change notes to the Assets section

3. Download the zip file with the plugin:

1. Start Blender

2. Open the Blender Preferences (Toolbar: Edit -> Preferences) and select the AddOns tab

1. Click the "Install" button and select the zip file you downloaded in step 2

Step 2: Enable the plugin

After you have successfully installed the plugin, you can now use the search bar to find it:

Make sure the box is checked and restart Blender.

Troubleshooting

I can't (un)install the plugin!

You can do both by hand. Find your Blender install's plugin folder, the path will look something like this (replace 3.6 with your Blender version):

Inside the plugins folder, the Wolvenkit Blender IO Suite will be installed to the subfolder i_scene_cp77_gltf.

To uninstall the plugin, delete the entire folder.

To install the plugin, find the folder in your downloaded zip file that contains the file __init__.py, move it here, and rename it.

Now, restart Blender.

Summary

Published: ??? by Last documented edit: Feb 12 2024 by

The auto-refitter is a tool developed by that automates the tedious process of refitting meshes for the various body mods.

If you need a tutorial for manual refitting, check or follow the links from there.

How to auto-refit

With a mesh selected, you can find it in the Mesh Tools section of the CP77 panel. Use the dropdown to select a target body, then click the button to apply the changes:

Modifier cannot be applied to a mesh with shapekeys

Future versions of the plugin will make this process much easier. For now:

1. Duplicate the mesh (Hotkey: Shift+D, Esc)

3. Delete the modifier from the other mesh

4. After the shapekeys are gone, apply the modifier:

1. Select the mesh without shapekeys (the one you changed by applying the modifier)

2. Switch to the Data tab and create a modifyer by hitting the + button

3. Name your new shapekey Basis. This is how it's supposed to look when no shapekeys are active.

4. Select the mesh with shapekeys (the one with the original shape)

5. Switch to the Data tab, select the second shapekey in the list, and transfer it:

1. Repeat the process with all other shapekeys

2. You can now delete the original mesh.

It shrinks too far!

If you want to merge, select the shapekey that you want to change, and set its value as high as you can without clipping. Then, select the "New Shape from Mix" entry in the dropdown menu (see the screenshot above).

You can now delete your original shapekey and rename the newly-created one (which will be called "Key 2" or something like that) to the original's name.

The body I want is not supported!

The lattice modifier has to be created from hand and added to the Wolvenkit Blender IO suite.

TODO: This section will eventually document the steps how you can

• add a body mod to your local version of the plugin

• share that edit with everyone else by having it added officially

Summary

Published: Jan 20 2024 by Last documented update: Apr 19 2024 by

This page contains troubleshooting options for the .

If the plugin gives you error messages on export, please check instead.

If you can't solve your problem with these steps, feel free to reach out on in the #blender-add-on channel.

General Troubleshooting

0. Steam

If you installed Blender via Steam, stay on the stable stream and make sure to keep Blender up-to-date.

1. Make sure that you are on the correct Blender version

As of , the plugin supports 4.1.0 and requires >= 4.0.2. This information might be outdated by the time you read it.

You can see the exact Blender version in the lower right corner of the program:

2. Make sure that you are on the latest plugin version

1. Open the preferences from the menu (Edit -> Preferences)

2. Switch to the AddOns tab in the bar on the left

3. In the filter field at the top right of the list, search for cyberpunk

4. Expand the entry and find the Version field

Check the console output

See if Blender encountered any errors by checking the console output. From the menu, select View -> Toggle System Console.

Failed to import materials

Make sure that your Wolvenkit is up-to-date

Make sure that your Depot is not outdated

The plugin needs your Wolvenkit Depot to a) exist and b) be more or less recent.

If you aren't sure how old your depot is or if you have one at all, it might be time to regenerate:

1. 1. If it's not set, set it now

   2. If it's set: Open the folder in Windows Explorer and delete everything there.

Summary

Published: Apr 19 2024 by Last documented update: Apr 19 2024 by

This page will tell you how to resolve error messages from the .

Assign weights before exporting

This should only happen for meshes with armatures.

• Switch to the Data tab (the green triangle)

• If you don't have vertex groups, add one

• If you already have vertex groups, select the one named to the bone closest to your ungrouped vertices

• If you aren't already, switch to Edit Mode (Hotkey: Tab)

• Click the "Assign" button under the vertex groups panel

Ungrouped vertices found

1. Switch to the Data tab (the green triangle)

2. The plugin should have switched your viewport to Edit Mode (if not, do it yourself - hotkey: Tab)

3. Find out which vertices are the problem by moving them around in the edit view

4. In the list of vertex groups, select the armature bone closest to your ungrouped verts

5. Click the "Assign" button under the vertex groups panel

6. Rinse and repeat the process for all submeshes until the plugin lets you export

No armature objects are selected

You are trying to export a pose, but you didn't select your armature. Click on the armature object in the outliner:

No meshes selected

You're trying to export something, but you haven't selected any meshes. Select everything that you want to export in the outliner (top-right panel) - the armature parent will be auto-selected for you.

Meshes must have UV layers

For Cyberpunk material assignments to work, your mesh must have UV maps.

Switch to the Data tab and add one:

All faces must be triangulated before exporting

Triangulation means that faces must have exactly three corners.

1. The plugin should have switched the viewport to Edit Mode. If not, do it yourself (Hotkey: Tab)

2. Triangulate faces (Hotkey: Ctrl+T). The default settings are fine.

3. You should now be able to export.

Vertex groups not assigned to a bone

Armature missing

The armature (rig, skeleton) is the thing that makes your mesh move in-game.

AMM props: You don't need an armature

It's enough to check the "Export as Static Prop" box during export, and the error will go away.

Equipment: You need an armature

Open the Modifiers tab (the orange wrench) and repeat the following steps for each mesh:

1. Make sure that there is exactly one Armature modifier present. If there is none, click Add Modifier and add one.

2. Click into Object and select the armature that your mesh is parented to.

Each submesh must have less than 65,535 vertices

If your submesh has >= 65,535 vertices

If your submesh has < 65,535 vertices

2. Turn on UV Sync Selection:

1. Once you have found an overlapping vertex, select linked (Hotkey: Ctrl+L)

2. Move the entire UV island by a whole tile in any direction (Hotkey: e.g. G -> X -> 1)

3. Repeat the process until there are no more overlapping islands.