Summary

Published: Oct. 14 2023 by Last documented Update: Mar. 20 2024 by

This page will give you information on how to get a 3d object into Cyberpunk.

Wait, that's not what I want!

You can find other relevant guides scattered across this wiki, for example

Adding new items

AMM: Custom Props

AMM: Textured items and Cyberpunk Materials using Custom Props

Prerequisites

• Wolvenkit: The latest version the latest stable (stable | nightly)

• Wolvenkit Blender IO Suite(>= 1.5.5.2 for Wolvenkit 8.14)

• Blender (>= 4.1 for Wolvenkit 8.14)

• A , so that you can pack your mod

Step 0: Finding the right base mesh

For the purpose of this guide, it doesn't matter if you are trying toReplace a player item with an NPC item, creating AMM: Custom Props or Adding new items. You will overwrite an existing in-game mesh, the file path doesn't matter.

Static items

If you are creating props, you use a mesh from the template project or grab any static mesh from the game.

As this guide will focus on equipment items, you can skip Step 3 and 4 completely.

Equipment items

If you want V to wear the item that you're currently porting, it needs to move with the player. For that, you need an armature. This guide will show you how to acquire one.

The right slot

Begin by picking a game mash from the right slot. If you're porting shoes, pick a shoe mesh, if you're porting glasses, pick a glasses mesh – you get it.

The right shape

For the sake of future you, pick an in-game item that is as close to your new garment as possible. If you're porting boots, take boots and not slippers. If you're using a baggy sweater, pick one of those or a jacket rather than a skin-tight t-shirt.

The right body gender

Make sure to use an item with the correct armature. You can identify them by prefix in the path:

Wolvenkit search query suggestions

Search for something like this:

namespace > slot > gender > .mesh

player: player > torso > pwa > .mesh 
npc:    common > torso > pwa > .mesh 

For torso items, you can add t1 for inner torso items (tight-fitting) or t2 for outer torso items (worn above t1).

Step 1: Exporting your mesh from Wolvenkit

Export from Wolvenkit

For how to export a mesh, see WKit Blender Plugin: Import/Export -> #meshes -> #export-from-wolvenkit

Step 2: Importing your mesh into Blender

For how to import a mesh into Blender see WKit Blender Plugin: Import/Export -> #meshes -> #importing-into-blender

Step 2.5: getting a grip on the submesh count

The mesh count in Blender corresponds to the submesh/chunk count in Wolvenkit. In Cyberpunk, we have one submesh per material that we want to use.

If you don't know what that means, ignore the information for now - but few meshes use more than five. The current maximum is the player base body with a total count of ten submeshes per LOD, so to be on the safe side, we need to stay below that.

If you want to get fancy, check out Step 2 in the guide about ported items and Cyberpunk materials. Otherwise:

1. Select all meshes but one by shift-clicking them in the Outliner at the topright of your viewport

1. Select the last mesh

2. Join the meshes together (Shortcut: Ctrl+J)

Step 3: Parenting the mesh(es)

The end result

This section will show you how to get the following end result:

• one or more mesh(es) with names from submesh_00_LOD_1, consecutively numbered

• parented to the right armature

There are two strategies that you can use. Personally, I use #strategy-1-replacing-the-3d-data, since it will retain most of the original mesh's properties.

Preparation

By the end of this section, you should have something like this:

No matter which strategy you use, we need to get the prerequisites done first. We need an original Cyberpunk armature.

1. Import the result of Step 1 into Blender (see the Wolvenkit Blender IO Suite's documentation about #importing-into-blender)

Clean up any residual modifiers and transforms (we don't want them):

1. If your mesh has an armature modifier with a non-Cyberpunk armature, delete it

   1. (click on the x in the modifier panel)

2. If your mesh is parented to anything that is not a Cyberpunk armature, unparent it:

   1. Select the mesh(es)

   2. Select Unparent (Hotkey: Alt+P)

   3. Select the second option "Clear Parent and Keep Transforms"

Strategy 1: Replacing the 3d data

We start by deleting the original's vertex data.

1. In Object Mode, select all of the original meshes.

2. Switch to Edit Mode (Hotkey: Tab)

3. Make sure that all vertices are selected (Hotkey: A)

4. Delete all vertices (Hotkey: x, option: Vertices)

1. Switch back to Object Mode (Hotkey: Tab)

We'll merge our new meshes into the empty containers now:

1. Click on your new mesh

2. Click on the empty original mesh in the Outliner (yes, order matters)

3. Join them (Hotkey: Ctrl+J)

Repeat the same for all meshes that you want to import to Cyberpunk.

That's it. All your meshes are parented to the armature now.

Strategy 2: Parenting the meshes

We can simply parent the meshes to our existing armature:

1. Click on your mesh

2. Click on the Armature object in the Outliner

3. Select Parent (Hotkey: Ctrl+P)

4. Select "Armature Deform"

1. Make sure to rename your mesh: Wolvenkit doesn't know what to do with meshes that aren't part of the sequence starting at submesh_00_LOD_1. (Blender's .000 suffixes will be ignored) You can delete the original meshes, or you keep them for Step 4.

Step 4: Weight Transfer

Start by deleting all vertex groups from your new mesh, as we will now replace these and don't want anything funky to stick around to destroy our re-import:

You now need to transfer the weights from your original game mesh. If you deleted or overwrote the armature's original meshes during #step-3-parenting-the-mesh-es, you can simply import it again for a second copy.

Step 4.5: Weight Painting

This is what you need to do if your mesh moves unevenly or if parts of it are clipping through the body although things are fitting correctly. Pray that you don't have to do it, because it sucks.

If you're unfortunate, you can find a guide on Weight Painting for Gonks!

Step 5: Exporting from Blender

See the Wolvenkit Blender IO Suite's documentation about #exporting-from-blender

Step 6: Importing into Wolvenkit

Step 7: Success!

… or maybe not. Maybe you should try Troubleshooting your mesh edits now.

If everything worked, here are a few more guides that you might want to look into:

• R&R: Refitting (step by step) will teach you how to refit for a certain body mod

• Adding new items will walk you through the steps of adding your mesh as a new piece of equipment

• AMM: Textured items and Cyberpunk Materials using Custom Props will tell you how materials work, and how you can use them to texture your item

Summary

Published: Oct 20 2024 by @manavortex Last documented edit: Oct 20 2024 by

Summary

Published: May 11 2024 by Last documented update: May 20 2024 by

The open source software is huge and intimidating — it is a tool for professionals, and many people consider it as good or even better than paid alternatives.

While it has a steep learning curve, everyone can dabble in Blender (even you! Even your mom!). This page will give you tips that'll make it easier for you.

Interface

Overview

This is Blender's interface. The main action happens in the Viewport. In the default perspective (Layout), it is on the left — you can switch perspectives (workspace layouts) by using the perspective selector (purple) on the file bar.

Read for how to move around in it.

General tips

1. Use keyboard shortcuts - they will speed things up by at least 70%. Put a post-it on your monitor and only remove it when you know them by heart.
3. The main action happens in your Viewport (the big one on the left).

   • You can use the Perspective Selector (pink) to swap around custom-defined workspaces.
4. • You can switch between Edit Mode and Object Mode with Tab (turquoise dropdown on screenshot 1)

5. You can switch the current selection tool with a long click on the tool's surface (shortcut to cycle: W)

6. You can (de)select multiple things by ctrl-clicking on them.

7. The most recently selected thing is called Active (this shows up in many context menus)

   • The Select Circle tool does not set an Active selection.

8. You can toggle X-Ray mode (Shortcut: Alt+Z) by clicking the purple icon in the screenshot above

9. You can hide things (Shortcut: H), Unhide them (Shortcut: Alt+H), or hide everything else (Shortcut: Shift+H)

10. You can undo your last action (Shortcut: Ctrl+Z), and redo an action (Shortcut: Ctrl+Shift+Z)

Navigating the viewport

• Spin the viewport by pressing the middle mouse button and moving the mouse

• Zoom with the mouse wheel

• With / (Numpad Divide), you activate Local Mode, which will show you only your selection

• Press Numpad 5 to toggle between perspective and orthographic mode. Try around with them

Customizing the interface

You can easily customize the interface — for example, you can set custom keyboard shortcuts by simply right-clicking on something!

Save Startup File

To make your changes persistent, save your current .blend under File -> Defaults -> Save Startup File.

View port modes

You switch the View Mode in the dropdown on the topleft. Depending on your perspective, there are multiple options:

Here's what they do:

Keyboard Shortcuts (global)

The shortcuts below are shared between Object and Edit mode:

The 3d Cursor

This is especially handy in combination with Snap Selection:

Object Mode

Object mode is where you select stuff that you want to edit.

Edit Mode

Edit mode is where you actually edit the mesh.

Editing tricks

With any active selection, you can toggle the following actions by hotkey, and then move the mouse:

• Scale (Hotkey: S): Grow or shrink something

• Rotate (Hotkey: R) What it says

• Move (Hotkey: G) Reposition something

Pivot Point

By pressing ., you can change the current Pivot Point:

This is the origin for your transforms:

Selection tricks

Selection Mode

Select Linked

With the shortcut Ctrl+L, Blender will select everything up to a certain boundary. By default, this boundary is the same piece of 3d geometry, but in the bottom left corner of the viewport, you can pick the delimiter:

Select Loops

Hold Alt and left click to instantly select an entire loop of vertices, edges, or faces.

Select Boundary loops

Select all or part of a mesh then navigate to :

this will instantly select all boundary loops for the given selection, great for marking seams

Select shortest path

Works in Edge, Vertex, or Face Selection Mode. Select at least one element, then Ctrl+click on any other element to select the shortest path of edges, vertices, or faces between them.

Seams and Sharps

In Edge Selection Mode (Hotkey: 2), you can (un)mark edges as seams or sharps via context menu:

A seam (orange line in the viewport) is where the UV map will be split.

A sharp (blue line in the viewport) will cause a sharp crease/fold in the material. This translates to Cyberpunk, so it's neat to highlight your edges!

Proportional Editing

"I'm moving a single vertex, but my entire mesh is affected!"

Sounds familiar? You've run into Proportional Editing.

• Click the button or press O to turn it off and on

• When it's active, moving, scaling or rotating will have an effect on anything close to your selection. This makes refitting super easy! No more jagged edges!

• When you move (G) or scale (S) your selection, you will see a circle for the area of its effect.

  • You can change the circle's size with your mouse wheel

The Scripting perspective

Summary

Published: Dec 14 2023 by Last documented update: Mar 18 2024 by

This guide will teach you how to execute Python scripts under Windows.

Running Python scripts in Blender

This guide is for running files outside of Blender.

If you want to run a Python script in Blender, you need to switch your viewport to the scripting perspective and click "play".

You can find a dedicated guide on in the 3d editing section.

Step 0: Getting Python

We start by checking if you have Python installed already.

1. Open a Windows command prompt (Hotkeys: Windows+R, type cmd, press enter)

2. In the window that now opens, type the following:

Otherwise, please keep reading.

1. Close the command window - after installing Python, you need to open a new one.

Step 1: Downloading the script

1. Download the file by clicking the corresponding button. Save it somewhere where you can find it easily.

3. Check the top of the file for anything that needs to be adjusted:

   1. Ignore the lines starting with import

   2. Read the lines starting with #. They are comments and will tell you what to put.

4. Once you have everything set up, save the script.

Now it is time to run it. Keep reading!

Step 2: Run the script

1. Open a command window again (Hotkey: Windows+R, type cmd, press enter)

2. Type python " (python, space, quotation mark)

3. Drag-and-drop the script you downloaded on the console window

4. Type another quotation mark and hit enter

That's it - the script will now run and do things

Troubleshooting

It complains about errors!

If that isn't it, you made a mistake while editing the script file. Make sure that you don't have single backslashes in strings:

No module named…

If you are running into this error in Blender, it should be enough to run the program as admin.

Otherwise, you are missing a Python module, and need to install it. You can do that by running the following code from your Windows cmd:

If that does not work, google for something like pip install module your_module_name windows.

Check the sub-pages for more detes, or check the section's sub-pages.

Relevant guides

Due to its complexity, we don't have a dedicated guide on Blender. However, if you have no idea how to start, various other guides cover part of the process:

• and

• or

For more hands-on advice, see the guide section, for example

• : Importing/exporting

• or

Relevant files

Mesh

A mesh defines the shape and surface of any in-game object.

Morphtarget

Morphtargets are a special kind of mesh used for alternate and additional shapes beyond the static shape a .mesh can define. If your source is a .morphtarget, you need to primarily work with that rather than the .mesh.

Type Extension

.morphtarget

What is it?

Morphtargets are a special kind of a mesh, or more accurately a .mesh is a more limited version of a mesh without the ability to define targets by itself (with a few exceptions.) A full model can consist of multiple .meshes and .morphtargets.

Morphtargets (or more generally just 'targets') are used for additional deformation beyond what rigging can do, as well as for creating alternative and/or additional shapes for a mesh. Blender calls targets shapekeys.

To be exact, cp2077 has three kinds of targets:

1. .morphtarget is a separate type, and has an associated .mesh (baseMesh) because redengine splits the full data needed for the model into these two separate types. The .morphtarget always defines the shape, overriding the .mesh. The .mesh stores the other information as usual. .morphtargets are used for, for example, body and head customization.

2. GarmentSupport is a property of a .mesh. It is also a target and this is a more common way to define targets than the separate type. GarmentSupports are used, for example, to slightly shrink a t-shirt so that it doesn't clip when you put a jacket over it.

3. Vehicle damage submeshes. This is a static end state of a target, inserted directly as an extra submesh rather than a target.

How do Targets Work?

A simple and perhaps familiar.morphtarget example is chest size for FemV. There are three states: default, small, big. The default corresponds to the base mesh shape, and is the Basis shapekey in Blender.

The two other states are defined as targets. Each target defines a 'delta', a set of offsets for base mesh vertices from their positions in the default shape - including any other active deform, like a pose in photomode. If you fully enable one of these targets, you effectively have a mesh with the chest area reduced or enlarged.

Targets can be also enabled partially, with the states between off and fully on (the 'end state') interpolated by the engine or 3D software. This can be used for animations, but in the cp2077 context generally is not.

Targets can be blended together. If two targets are enabled fully or partially, their combined state is blended into one shape. In cp2077 some targets are mutually exclusive (like the chest size), and others are inclusive (your V's face is a combination of the selected eyes, nose, mouth, jaw, and ear target states all blended together.)

Exclusive/inclusive is not a limitation of the targets themselves, but of how cp2077 activates them..

Target Activation

The game engine activates targets by name (and region) in specific conditions.

Character customization targets are activated when the character is loaded (and dynamically in the CC view.)

GarmentSupports are activated when equipping a garment that goes "on top of" the garment with GarmentSupport.

Morphtargets, What Are They Even Good For?

So, some uses are probably already obvious. But targets enable quite a bit of exciting modding:

• Modding anything with a .morphtarget without breaking the targets like before

• You can for example mod the CC tattoos, or piercings...

• ...Or any aspect of character face customization. Vampire catboy Legolas here we come!

• TBA

Editing Morphtargets

One thing deserves highlighting right up front: whenever you are doing 3D work on a model that has a .morphtarget, you work with the .morphtarget, not the.mesh. The .mesh is only used for things the target doesn't include, like appearance definitions. Fundamentally the 3D workflow goes like this in Blender (use the blender cp2077 plugin import/export):

1. WkitExport the .morphtarget

2. BlenderImport it

3. Make your edits to base shape and/or shapekeys (if you need to - the base shape edits are automatically propagated to shapekeys.) You can edit just like you would a .mesh, because it is a mesh.

4. BlenderExport to a file named after the .mesh

5. BlenderExport to a file named after the .morphtarget

6. WkitImport the .mesh.gltf first. Wkit will treat it just like it would a 'real' .mesh

7. WkitImport the .morphtarget.gltf

8. ...And that's it. You can pack the mod.

Tips for Morphtargets

• Make sure to test your targets work blended with other targets, not just by themselves

• You can create targets from scratch, all that matters is that the name matches the original. This is handy for zeroing out targets you don't need or want, for example.

• I prefer to use either of the .gltf formats over .glb. They're all GLTF but .gltf is slightly more widely supported, plus you can open it up in a json editor. -- Auska

Working with GarmentSupports

See the GarmentSupport section for more info.

Working with Vehicle Damage Deforms

TBA

Summary

Published January 29 2023 by @manavortex | Edited by Na Last documented edit: January 09 2024 by manavortex

This guide will give you a number of mesh sculpting techniques when it comes to editing meshes in Blender.

Wait, this is not what I want!

• If this is your first time in Blender and you are lost, check Blender: Getting Started

• Before doing this by hand, check the WKit Blender Plugin: AKL Autofitter

• For information on weight painting, check Meshes and Armatures: Rigging

Assumed skill level:

This guide is aimed at more intermediate refitting needs. For a step-by-step refitting guide, check here.

Prerequisites: - You have exported a mesh and imported it into Blender - You are able to read and comprehend instructions.

Proportional editing

Sculpting

Prerequisite: Deleting shapekeys

Before you start editing your mesh, you should delete its shapekeys. This is necessary for the Sculpt Mode to show your changes in real time, and you don't need them anymore after editing your mesh.

Sculpting the mesh

The obvious approach is to change your mesh by moving vertices. This process is covered in the r&r refitting guide.

The Sculpt Mode is pretty much What You See Is What You Get.

The easiest tools for beginners are Grab, Elastic Deform, and Smooth

A useful shortcut to keep in mind is F, which will let you change the cursor size.

Affecting only parts of the mesh

Method 1

You can hide those parts that you don't want to sculpt.

Use the Edit Mode (Shortcut: Tab) to make a selection. Then, leave only those parts visible that you want to affect before switching back to Sculpt Mode.

Method 2

You can also use the Lattice Deform Method below to selectively edit only part of the mesh.

Method 3

You can use Blender's mask brush and function in Sculpt Mode to mask the parts that you do not want to sculpt.

Affecting Several Meshes

Material Separation Method

This method is a workaround that you can use when you have only 2-3 meshes. You can fuse all meshes together, then split them apart after you're done.

Pros:

• Relatively simple, and good to make small, simple changes to 2-3 meshes.

• Allows symmetrical sculpting.

Cons:

• Destructive editing

• Can be a little time-consuming because you have to join, separate, and rename meshes every time you want to import it back to WolvenKit.

Let's assume that we're sculpting Rogue's pants. For surface material assignment, the seams are an own submesh — the pants (submesh_00) are coloured via multilayered material, while the seams have a variation of metal_base with coloured stitches.

We don't want to edit those separately, so we'll fuse them into one mesh, sculpt everything in one go, and then split them apart again.

To allow splitting, we need to make sure that every submesh has its own unique material. Select the mesh, switch to the "Material Properties tab on the right", and duplicate the assigned material:

Now, join the meshes together — hold CTRL, select the main mesh, and join the meshes together (shortcut: Ctrl+J)

Once you're done, you can separate the meshes again. Switch to Edit Mode, then select something that belongs to the former submesh. From the menu, pick the following entry: Select -> Select Similar (Hotkey: Shift+G) -> Material

Then, split off the selection into its own submesh again: Right-Click -> Separate (Hotkey: P) -> Selection

Lattice Modifier Method

The Lattice modifier deforms the base object according to the shape of a Lattice object.

Pros:

• Can edit as many meshes at once as you want, no matter what armature they are parented to.

• 100% Non-destructive sculpting.

• No need to separate, rejoin, and rename meshes after sculpting is done.

• Good for making small, local changes to multiple meshes.

• Edits can be stacked on top of each other by stacking modifiers.

• Does not have to go through all the steps like Material Separation Method each time you want to import to WolvenKit.

Cons:

• Trying to select desired vertices of the lattice can be difficult.

• Can be hard to restrict edits to areas not covered by the lattice, thus possibly making unwanted edits.

• Does not allow symmetrical sculpting.

Begins by adding a Lattice to the scene. In Object mode, go to the menu Add > Lattice. Reshape the lattice so that it covers the part of the base meshes that you want to edit or all the meshes that you want to edit.

Go to the Object Data Properties panel, and increase the resolution as you wish. for most edits, 6-10 levels are fine.

Now select your base mesh(es). Add the Lattice modifier to the mesh then choose your Lattice in the Object option.

To apply this modifier to all base meshes, while still selecting this mesh, hold Ctrl then select all the meshes that you want to edit, or hold Shift then drag to select all the meshes that you want to edit. Click the drop-down menu arrow in the modifier, then click Copy to Selected.

Go to edit mode, select vertices and start moving them around to edit your base mesh(es).

When you are done, you do not have to apply this modifier. As long as your export settings are correct, and you remember to delete all Shape keys, the changes will be applied automatically upon export. That's why this method will make all the changes non-destructive and you can revert to vanilla by toggling the modifier.

Mesh Deform Modifier Method

The Mesh Deform modifier allows an arbitrary mesh (of any closed shape) to act as a deformation cage around another mesh. This method resolves many problems of the previous methods.

Pros:

• Can edit as many meshes at once as you want, no matter what armature they are parented to.

• 100% Non-destructive sculpting.

• No need to separate, rejoin, and rename meshes after sculpting is done.

• Easier control than editing vertices of a lattice.

• Allow symmetrical sculpting.

• Edits can be stacked on top of each other by stacking modifiers.

Cons:

• If you have a lot of meshes and the vertex count is relatively high, the waiting time to bind can be just a little long.

In this example, I will work with the head mesh (1 submesh) and the body mesh (10 submeshes).

In Object Mode, duplicate everything by right-clicking on the collections and hit Duplicate Collection .

Still in Object Mode, select all the newly duplicated meshes and join them together by using hotkey Ctrl + J or navigate to the menu > Object > Join .

This mesh will be our cage mesh, we will use it as a proxy to make edits to the main meshes. Now we have to prepare it so that it works well as a cage.

Add a Remesh modifier to this mesh, use Voxel setting. Decrease the Voxel Size until the human shape is fairly recognizable but the mesh is not too high poly. Also, enable the Smooth Shading option. Below is my setting for this model.

Now, apply the modifier by hovering the mouse above it and using the hotkey Ctrl + A, or click on the drop-down menu arrow and hit Apply.

Now we need to "bloat" the cage mesh so that it covers the whole base meshes. We will make use of the Shrink/Fatten function. You should toggle visible the base meshes along with this cage so it's easier to see. Switch to Edit Mode, and select all vertices by using the hotkey Ctrl + A. Hold Alt + S, then drag Left Mouse button to fatten the whole mesh. For finer control, also hold Shift while dragging it. Make sure that it completely engulfs the base meshes.

Switch back to Object Mode, select all the base meshes instead. Add a Mesh Deform modifier, then select the cage mesh in the Object option. Then select the drop-down menu arrow, click Copy to Selected to apply the same modifier to all base meshes. Then go to each meshes and click the button Bind to bind them to the cage. Depending on the complexity and vertices count, it can take anywhere from 1 to 30 seconds to finish binding.

You have finished binding all meshes to the base meshes. Now, all the editing you made to the cage mesh in Sculpting and Editing Mode will be reflected on the base meshes.

To see the edits easier, select the cage mesh, then go to Object properties. Scroll down to the Viewport Display setting menu, in the Display As option, chose Wire. This will render the cage as wire and you can see the vanilla meshes below as you edit.

After finishing sculpting, you don't have to apply the modifier to the base meshes. As long as your export settings are correct, and you remember to delete all Shape keys, the changes will be applied automatically upon export. That's why this method will make all the changes non-destructive and you can revert to vanilla by toggling the modifier.

Troubleshooting

Sculpt changes don't show before I enter and leave Sculpt Mode

You need to delete the shapekeys.

Summary

Published: Feb 08 2024 by manavortex Last documented edit: Feb 08 2024 by manavortex

This page will show you how to run Python scripts in Blender. It's not strictly speaking part of the Blender plugin, but I had to put this somewhere, and it's least out of place here.

The Scripting perspective

To run scripts, you need to switch to the scripting perspective. Click the corresponding entry on the perspective toolbar at the very top:

The script panel looks like this:

Running a script

2. Click into the Text Editor panel directly below it

3. Paste the contents of whatever script you want to run (Hotkey: Ctrl+V)

4. Hit the Play button above the editor panel to run the script (Hotkey: Alt+P)

5. Optional: Look at the Python Console below the 3d viewport to see feedback

Troubleshooting

If your script doesn't work, Blender will have generated an exception. To look at it, toggle Blender's System Console:

Copy the contents of the console window, or pull it as big as your screen allows and take a screenshot. Give this information to the Netrunner who told you to run the script and watch as they fix it.

If you don't have a Netrunner (or if you are that person), this is where you hit up Google or ChatGPT (you can skip the steps 1-5 in the linked guide).

Summary

This page will give you a short explanation on why 3d objects are moving.

Wait, this is not what I want!

• To learn what a rig even is, check Armatures: .rig files

• Maybe you want the Weight Painting for Gonks guide?

• For a documentation of the import/export options in Wolvenkit, check here.

• Guides on how to transfer weights between rigs: blender plugin, youtube video, wiki page

The connection between a mesh and a rig is made via vertex groups. Any number of vertices can be assigned to a group, which is then matched to a rig's bone via name.

How much every bone influences the vertices is determined by vertex weight, which can be altered in Blender's Weight Paint perspective:

Vertex weights are assigned for every vertex group, and each vertex will move on the basis of the sum of all its weights.

This page contains a theory part and a guide.

The guide section of this page has been created in the context of First Person Perspective Fixes: #editing-the-.mesh. It will show you how to split a mesh into submeshes (or how to alternatively delete these parts of the mesh).

What are submeshes?

For more information about this see Submeshes, Materials and Chunks and the section #submeshes-in-blender

To learn how you can use them for appearance management, check #chunkmasks-partially-hiding-meshes

Guide: Splitting off submeshes

Prerequisites

You have the Wolvenkit Blender IO Suite and a compatible version of Blender installed.

Importing the mesh into Blender

1. Open Blender and create a new General file.

2. Optional, but recommended: delete everything in the file. In the scene collection in the top right, right click on “Collection” and click “Delete Hierarchy,” as we don't need these.
3. Press File → Import → Cyberpunk GLTF and browse to your .glb file.

4. Import the file (default settings).

Selecting the right parts

Directly after importing the mesh, Blender will be in Object Mode.

1. Your item should appear in the 3D viewport now. Use the camera controls to the left of the scene collection (or mouse/keyboard shortcuts if you're familiar with them) to get a better view of the item.
2. In the scene collection, find the newly-added collection and expand the armature

3. You will see the item's meshes (which correspond to Wolvenkit's submeshes as defined by name).

   • My jacket only has one submesh. Your item might have more.

1. In the scene collection, select all the submeshes of your item

   • click on the first, then shift-click on the last

Edit Mode: making a selection

Now, select the parts of your mesh that you want to split off (or delete). If you have never done that, read the section below before starting, as it can save you a lot of time.

1. Switch to Edit Mode (keyboard shortcut: Tab)

1. Click in the 3D viewport next to your mesh to deselect everything. Use the camera controls to get close to what you want to select. In my example, it's going to be the entire collar.

2. Start by selecting a single vertex on the part that you want to get rid of.

3. Press Ctrl + L (select linked)

4. If you're lucky, it will select what you want. If not, undo (shortcut: Ctrl+Z) and select things by hand.

5. Once you have made your selection, decide how to proceed: either by #splitting-off-submeshes or by #deleting-vertices.

Splitting off submeshes

TODO: This needs a screenshot or two

1. Split your selection (shortcut: P)

2. You will now have (a) new mesh(es) in Blender. Those are your future new submeshes

   • Each will be named original_mesh_name.001

3. Rename each of them, following the naming schema from the original meshes:

submesh_<index>_LOD_1

1. After you have renamed all meshes, proceed to #exporting-from-blender.

Deleting vertices

At any point, you can press x and select delete vertices to remove parts of your mesh. In this example, we will delete the entire collar:

Exporting from Blender

After your mesh is edited to your satisfaction:

1. If you're still in Edit mode: change back to object mode (shortcut: tab)

2. The meshes should still be selected.

3. Hit File → Export → Cyberpunk GLB

Now, you can import your mesh into Wolvenkit.

Summary

Created: July 21 2024 by @eagul

This guide will show you how to create your own hair in Blender from scratch.

Prerequisites:

• Some familiarity with Blender and basic modeling skills. If you don't know how to Use Blender yet, check out and complete at least the donut tutorial!

• The paid Blender AddOn Hair Tool (purchase it on )

Usefull links: Hair Tool discord server: Hair Tool official documentation:

You can download the example project !

Step 1: Creating a grid surface.

Using any modeling method you like, create a so called grid surface. This should have the topology of a plane (no holes, loops, etc). Mark the root edge sharp. Core concept: Keep the poly count low. The less 'control points' you have, the easier it is to control the object.

Step 1.1: Generating the first layer

Open the HT panel (N), expand the Hair System, Sub-Systems and Deformers menus.

Press CTRL + Shift + H, then Transfer Hair system to Empty Curve. The hair object will now be a curves object parented to the grid surface.

Add the following deformers: - Align tilt to source surface - Mirror

Additionally, set the desired profile width in the Profile tab.

Step 1.3: Adding volume to the first layer

Add a 'Filter' Subsystem below the Grid Generator Subsystem. This subsystem allows you to add deformers to any curve object. It does not matter if curves are virtual or real.

A separate filter subsystem is created for the upcoming deformers. This is done so the first subsystem can be later baked separately from these deformers. It will facilitate manual edits, because there will be far less control points.

Add the following deformers: - Duplicate strands - Attach to surface - Mirror (hide it in the first subsystem)

Step 1.4: Breaking up the perfection

In order to create a convincing mesh, you need to introduce some imperfections. In procedural HT, this is mostly accomplished by using randomizing input masks, and the noise deformer.

Add the following deformers: - Add Tilt - Noise Deform

Step 1.5: A quick preview

It's a good practice to check the shaded look of the hair during modeling. This can for example help you spot clipping or thin areas, while also providing a more accurate visual representation of the final result.

Navigate to Render settings, select EEVEE, and enable Ambient Occlusion!

And now, you should have a decent preview of what you have created already :D Here, I added a Lenghten deformer to re-gain some of the length lost to UV transparency (which i forgot to account for before).

Step 1.6: Generating the second layer

Duplicate the curve object you used for layer 1. Press the [2] indicated with the red circle. Do this for both subsystems! If you don't want profile data to remain linked, make profile data unique too. I will not be making profile data unique for this hair.

Hide the filter subsystem of the second layer.

Add the following deformers: - Slide Points - Push Out - Attach to Surface

Step 1.7: Adding volume to the second layer

Unhide the filter subsystem. Hide the mirror deformer in the first subsystem.

At this point, you are free to customize this layer however you like. These are the changes I made: - Increase the amount of strands generated from the grid - Randomize spacing of said strands to some degree - Increased random tilt to 15 degrees - Increased Noise Deform amplitude a bit - Slightly increased Lenghten, and added a random Trim deformer. Average length slightly increased. - Selected lower density UV boxes for this layer.

Step 1.8: Final layers

Optional, but if your poly limit allows for it, you can include additional layers for even more detail. Use similar techniques as described above to create those layers. I am adding 2 more layers, low density, with large push out values.

Step 2: Fringe

To create a fringe, you can simply repeat the same steps as for the main body of the hair, so create a grid surface and generate layers from it. However, for the purpose of showcasing HT's features, I will demonstrate a more manual approach to modeling hair.

Select the scalp mesh. Press Shift + A, add Curve > Empty Hair. Then, select Sculpt mode. In the top bar menu, change settings for Curve Shape. I used 0.05m and 5 points for this. Both can be changed easily later in edit mode. Place down a couple curves. Comb them into position using the appropriate brushes, using edit mode, or Hair Tool's modeling workspace.

Add the following deformers: - Align Tilt - Mirror - Radius set, and taper the roots (flip influence range arrow) - Optionally other procedural deformers, I added a Lenghten, but you can just as well simply edit the curves directly.

Then, duplicate the object, make subsystems unique, push it out using the deformer or manually do it, in order to create the next layer. It is inefficient to model every curve manually, so make use of the duplicate strands deformer, as showcased earlier in the procedural section.

Again, if your poly count allows, it's good to add some thin coverling layers on top, they will aid with realism and blend the fringe a bit better into the main part of the hair.

Step 3: Baking Subsystems and manually finishing

Any hairstyle will have some strands that cannot be tamed. Sometimes they are referred to as flyaways. When making the fringe, you can simply model them while making the final layers, because you are using real curves anyway. See image above.

After baking your subsystems, you can use any curve modeling tools to edit them further. HT's Hair Modeling is very well suited for this.

Step 4: Finishing Touches

Add a couple extra strands to break up the flow, if desired.

Add some deformers to the strands, be creative!

Final result:

Summary

Created by @eagul Published March 20 2023

This guide will teach you everything you need to know about dangle bones, focussing mostly on hair meshes. However, dangle bones can also be applied to any other mesh

Assumed skill level: - You are familiar with Wolvenkit and Blender. - You know what bones and weights are. - You are able to read and comprehend instructions.

What are dangle bones?

Dangle bones are a 'chain' of linked bones which are used by the game engine to simulate physics (dangle). They're found mostly in hairs, but also in certain clothing items. For a mesh to have working dangle physics, corresponding .rig and .animgraph files are also needed The image below depicts how a dangle skeleton looks. The .animgraph will move the dangle bone chains, which are connected to the mesh using weights, which will then in turn animate the mesh.

Transfering a skeleton and weights

The easiest way to add physics to a mesh that does not have them, is to transfer them from another mesh. If you are doing a hair port, prepare the (static) .mesh and textures first. 1) Locate a 'donor' mesh. It should have a similar mesh, and physics that you could also see working on your 'new' mesh. 2) Add both the donor mesh, together with it's .rig and .animgraph pair, and your new mesh to the project in wolvenkit. 3) Import both meshes to blender. 4) Using alt+P, clear the parent of the new mesh. Now select the new mesh, and then the armature of the donor mesh, and press ctrl+P, followed by Armature Deform with Empty Groups. 5) Select the donor mesh, and secondly the new mesh. Swap to weight paint mode. In the top-left cornet, press 'weights' and then 'transfer weights'. In the bottom-left corner, a small black window will appear. Click it. Set Vertex Mapping to nearest face interpolated, and source layers to 'by name' 6) Go into weight paint mode and manually clean up the weights, using the weight transfer as a reference. Optionally duplicate the mesh and move the copy to the side, so you keep an untouched reference. 7) Import it back into wolvenkit, and you're done!

Some tips for editing hair meshes

1) Oftentimes, you can get away with editing a hair mesh, and not having to touch the physics at all, especially if the changes you are making are fairly small. 2) If you move the mesh away from the bones, it might move in unexpected ways. The further the mesh is from the bone, the more of a 'lever' effect will happen. This is particularly noticable when bones are rotating around an axis perpendicular to the one you moved the mesh away on. Usually small movements are fine and will not affect the dangles in a noticably bad way. If you do find yourself in a situation where you need to move the skeleton as well, check the 'Moving a Dangle Chain' section. 3) Check out UUH4V. It's an amazing resource that will allow you to load multiple hair meshes with each their own rig/anim pair simultanously. Keep in mind that you cannot have 2 of the same rig/anim pair loaded in the same hair slot simultanously, as this will cause unacceptable deforms. You need to merge any 2 meshes that use the same rig/anim pair in blender and import them as one .mesh.

Leverage effect

Included is an image of what i mean by the leverage effect. I used a handy little trick here to make bones visible in-game. Overlay a simple mesh over each of the bones in blender and weight paint it completely red. Load the boxes instead of a hair mesh. Edit the material used by the mesh to make it better visible. I used plastic_red here. Congratulations, you can now clearly see what bones are doing in-game. Hiding the body mesh helps with visibility. Green circle includes the true location of the dangle bone chain. Meshes in the yellow circle are rigged to the same bones as those in the green circle. Bone 3 is invisible. Upon moving bone 3 to the right (by editing the .rig), bone/mesh 1 rotated slightly, making mesh 2 do a huge leap. If you were to load a hair mesh in the same location as indicated by the yellow circle, you would end up with horrible stretching and deformations, even without exxagerating the effect by moving bone 3.

Summary

Created by @eagul Published March 20 2023

This guide will go deep into detail about moving dangle bones. Still unknown: changing bone parenting, rotating bones, editing the animgraph physics, adding new mirrored dangle chains for better coverage. If anyone has done tests on any of these topics, please contact me.

Assumed skill level: - You understand what you are doing, and know why you need to move dangle bones - You are able to read and comprehend instructions.

MATH WARNING

Okay.... Let's get started. If you are doing physics stuff, and need to move the dangle bones to fix the leverage effect, or for any other reason, you are in the right place. I will be using my long hair dangles project for examples here. Read 'Leverage effect' section in 'Dangle Bones' page for the reasoning behind why this process is necessary. (Using a normal hair dangle skeleton is not an option because it is parented to the 'head' bone, which causes horrible clipping and unnatural movements when the head turns. It might be possible to change the parenting to spine3 bone, but i have yet to test. Even if it is possible, the process described below would still be usefull to move the chains into the right positions) You will need to do a couple things: 1) Get everything into blender. 2) Isolate the bones you need to move. Hide other bones in armature edit mode. 3) Duplicate the bones and move them to the desired position. 4) Edit the bone positions in both the .mesh and .rig, sometimes editing the collision hitboxes in the .animgraph will also be required. I would also recommend having a rigged and weight painted mesh ready, for testing purposes. I will explain each step of the process more in-detail below.

MultiMesh Export

Usually, you can get the skeleton in it's real form into blender by using WithRig export on the mesh. However, if the .mesh contains bones that are not present in the .rig, you will need to use MultiMesh Export. You need to find a second (or even more) .rig file, so all the bones that are present in the mesh have a counterpart in the .rig. You then need to also add the meshes that correspond to the new .rigs and then export. Attached images show settings i used to export base\characters\garment\citizen_formal\torso\t1_072_shirt__netwatch\t1_072_ma_shirt__netwatch_dangle.mesh with rig, which i used for long hair dangles.

Editing the .rig

Open the .rig file in Wolvenkit. Under boneNames you can find which index corresponds to which bone. Expand boneTransforms. Locate the bones you want to move. Moving a bone in a chain will also move every bone that's parented to it (located lower than it in the chain). In the case of the image above, moving the bone selected in yellow, also moved the entire chain. In this case i moved bone 8 (selected in yellow) by 0.283076668 on the Y axis.

Animgraph edit

As you can see, the skeleton exploded. This is (to my understanding) caused by collision hitboxes on the spine bones. It will only happen if you have moved the dangle chain inside of those hitboxes. If this happens to your skeleton/mesh, follow these steps to fix it: 1) Open the .animgraph file in Wolvenkit. Expand the 'rootNode' array, and keep expanding untill you see collisionRoundedShape and then lower the roundedCornerRadius for each of the bones untill your skeleton no longer explodes. Here i set the value to 0, the animations work fine, but a correctly set value might reduce clipping in some poses.

Notice how editing the bone positions in the .rig also deformed/moved the mesh in-game. At least it's dangling nicely now, and it no longer explodes :copium:

Editing the .mesh

The .mesh also contains bone matrices. To my understanding, these are used to map the bones from the .rig to the vertices. You will need to move the bones in the .mesh to match the changes You did to the .rig skeleton, and this will fix the mesh deform. In this case, I'm editing bones 79-83. The goal is to move each of them by -0.283076668 on the Y axis. Open the .mesh in Wolvenkit and navigate to boneRigMatrices.

Notice how the bottom row of the inverse matrix corresponds to the coordinates of the bone, which you can see in Blender.

Next, copy the new Y coordinate from the bone you duplicated and moved.

After that, return to the calculator, and press 'Insert in B', and then replace the matrix entry corresponding to the Y position of the bone with the new coordinate.

Then, press 'inverse'

Next, press the 3 small lines below the output, click on Show LaTeX, and copy the top row entries back into wolvenkit.

And now repeat all of those steps for each of your bones... enjoy... After that, you should be finished!

Importing

My import won't show up in-game!

We need to troubleshoot your import.

Does the Wolvenkit preview update?

Yes: The problem is somewhere else, the mesh import works fine.

No:

Is there an error message in the console?

Yes: Here's where your problem is. Make the error message go away by checking the rest of this guide.

No:

Do you have extra shapekeys?

In Blender, check your shapekey section. It should look like the green box (or be empty).

Tangents

You get an error message like this:

Message: One or more Geometry in provided GLTF doesn't contain Tangents data. Tangents must be included within glTF files.

Use the Cyberpunk Blender IO Plugin to export

Alternatively, you can check by hand:

Bone: neutral_bone not present in export Rig(s)/Import Mesh

The neutral bone is created by the glb export plugin when there are vertex groups without a parent bone. WolvenKit will not let you import if there is a mismatch.

The following two scripts help you finding and/or fixing the problem. Switch to the Blender Scripting perspective and create a new, blank text file. Then, toggle the Blender system console to see their output (Blender: Window -> Toggle System Console)

Missing bones

Vertices without weights

Option 1: Fuck those bones: Python

Option 1: Fuck those bones: Noesis

Option 2: The Netrunner suit

The armature from the following mesh has a lot of bones and will often resolve most of your issues:

If you end up with missing bones,

Option 3: Transferring bones

It's time to play 3d puzzle and assemble bones from multiple sources. Unfortunately, there is no simple solution for this yet. You need to

• find the bones that your armature is missing in other meshes

• export all the extra meshes into Blender

• and finally reimport everything back into Cyberpunk.

Everything else

WolvenKit will not import a mesh that has any kind of issues. Those include, but are not limited to:

• non-flat faces

• zero faces/edges

• loose vertices/edges

There is no guarantee that any of the steps below will actually solve your problem.

Edit Mode

In Edit Mode, you can find a few commands in the Mesh -> Clean Up menu:

• Delete Loose

• Split Non-Planar Faces

• Split Concave Faces

• Merge By Distance

It's still broken

Fortunately, the tool is free, easy-to-use and already included in your Blender.

• Zero Edges: Those are bad, fix them (click on them, then press X and just delete them)

• Non-Flat Faces: Those are even worse, as they can make the game crash. You need to split them up until they are flat, or investigate the surrounding edges/vertices to see what's going wrong here.

• Zero Faces: Only fix if you have <100 of them — the tool doesn't always identify them correctly (the mesh analyzed above was h0_000_pwa_c__basehead, which is absolutely fine).

In-Game

My mesh won't show up

In Blender

• make sure that you have exactly one UV map

• check Face Orientation — most materials won't show backfaces (red). You can import submeshes with the suffix _doubled to make WolvenKit generate them for you, like it does with hair.

In Wolvenkit

When saving your mesh, check the console for errors. In version >= 8.9.0, a basic material validation is taking place. If you don't see any warnings, make sure that the resource paths in your mesh are correct and that you aren't loading invisible textures.

Parts of my mesh are missing

Do they show up in the Wolvenkit preview?

My mesh won't move at all

Changes from Blender are missing in-game

For example, you have moved something, but the change doesn't show in the game: this most often happens when you change things around in edit mode, since they are stored as object properties rather than applied immediately.

1. Select the object in edit mode

2. Press Ctrl+A

3. Select "All Transforms" to apply all transformations.

My mesh is moving weirdly

E.g. you've changed a shape, but now everything moves at an offset.

Replacing the vertices

My mesh is completely warped

My shadow mesh is always visible

Check the renderMask attribute inside heder / renderChunkInfos / index. For shadow meshes, there shouldn't be anything but MCF_RenderInShadows.

My mesh ignores my texture edits!

The textures are most likely embedded. Here's how you can force your material to pull in external textures instead:

Garment Support

My mesh is string cheese/exploding vertices/a puddle on the floor

This section will tell you how to delete garment support. If you don't want that (you shouldn't! It's cool!), check the next section.

Option 1 (likely to work): Import your mesh with garment supports

Option 2 (guaranteed to work): delete GarmentSupport from the mesh

I'm doing everything right, but garment support still explodes!

Component IDs

Check the component's id in the mesh .ent or .app appearance's components array:

If any given ID is equipped twice, it can break garment support in the way you're observing.

As of January 03 2023, we don't know how these are generated and can't tech the problem away in Wolvenkit. Your only choice here is to manually randomize your ID in a text editor by switching out single digits. Remember that the resulting ID needs to be an even number!

Import settings

Summary

Created by @manavortex Published November 05 2022

This guide will show you how to - export meshes from the game for use in other projects - import those meshes back into WolvenKit

Assumed skill level: You are able to read ;)

Wait, this isn't what I want!

Would you rather…

Legacy: Noesis

Exporting the mesh

glTF Binary (*.glb)

If the export fails, try unchecking the following properties in the export settings (you have to do this for each individual mesh)

• Export Materials

• Export Garment Support

Path example

Assuming you are exporting t2_002_pwa_vest__puffy.mesh, WolvenKit will do the following:

Path of mesh: <yourModDir>\source\archive\base\characters\garment\player_equipment\torso\t2_002_vest__puffy\t2_002_pwa_vest__puffy.mesh

Path of glb: <yourModDir>\source\raw\base\characters\garment\player_equipment\torso\t2_002_vest__puffy\t2_002_pwa_vest__puffy.glb

Blender: Saving the mesh

glTF Binary (*.glb)

For historical reasons, the box below holds the minimum steps to export via the vanilla Blender plugin. You shouldn't want to do that.

Importing to *.mesh

glTF Binary (*.glb)

Import/Export: _doubled

Normally, a mesh's backfaces are invisible/transparent - you aren't supposed to see a mesh from below, so it doesn't matter. But some, like hair and eyelashes, are different, and need to be doubled.

When importing via Noesis, you need to do this by hand: duplicate all the vertices in the mesh, and flip the normals. When importing via WolvenKit, it will automagically do that for you if a mesh name ends with _doubled.

The suffix also indicates that Wolvenkit de-duplicated a mesh on export!

Troubleshooting

Summary

Published August 2023 by Last documented update: March 18 2024 by

This guide will take you through the steps of replacing one of Cyberpunk's neon signs with a custom mesh.

If you want, you can then turn your replacers into new for AMM!

Wait, that's not what I want!

• To learn how material assignment works, check and its sub-page

• To learn more on how materials in general work, read

• For a guide on changing an existing mesh, read

Prerequisites

You need the following software:

Step 0: Make or find an image

Start with an image. We're aiming for our own neon sign here, and we'll aassign the colours later in Wolvenkit, so make sure that it is something with clean lines and good contrasts. I'll use this:

Step 1: Convert to SVG

1. Open Inkscape and create a new document

2. Select File -> Import and import your .png from step 0

3. Make sure that your image is selected (click on it if you're not sure, it will have that resizing handle)

4. From the menu, select Path -> Trace Bitmap (it doesn't have to be a bitmap)

6. Press the Apply button at the bottom

7. Your new traced path will be auto-selected for you.

8. Select File -> Save As and save it as an *.svg file.

Time to switch to Blender to turn it into a mesh!

Step 2: Making a mesh

1. In Blender, select File -> Import -> Scalable Vector Graphic (SVG)

2. Import your SVG. It will show up as solid black:

1. With an active selection, find the curve properties panel in the bottom right (the green icon).

2. In the "Geometry" section and find "Extrude".

3. Set it to something like 0.001 — play around with it until your mesh is appropriately extruded.

   1. Do not bevel it! We want the corners nice and sharp, we can always make it round l,ater.

4. Once you're satisfied, transform the curve into a mesh: Object -> Convert -> Mesh

We're now leaving the previous guide.

Step 3: Fixing up the mesh for Cyberpunk

Scale, rotate, and move your curve to the centre of the viewport

1. Fix rotation: Press R -> X -> 90

2. Fix scale: Press S and move the mouse

3. Fix position:

   1. Press G -> Z to move the mesh up and down

   2. Press G -> X to move the mesh left and right

   3. You don't need to move it on the y axis

4. Apply transformations: Press Ctrl+A -> T

Cleaning up the geometry

Remesh modifier

1. Switch to the "Modifiers" tab in the sidebar panel on the right (the wrench, below the one highlighted in the screenshot above)

2. From the dropdown, select Generate -> Remesh

3. Your mesh will be a black box now. Don't panic, we'll fix this by setting the modifier proprerties:

Switch back to Object Mode (press Tab) and apply the modifier. The result should be something like this:

Now, triangulate: switch to edit mode, select everything, and press Ctrl+T. It's necessary for the Cyberpunk reimport.

Creating an UV map

Switch to the Object Data Properties in the right sidebar, fold out "UV Maps" and click the + button. This is necessary for material projection, and Wolvenkit won't let you import if you didn't do it.

Naming

Rename your original mesh to submesh_00_LOD_1 — we need that for the import in Wolvenkit.

Optional: More submeshes for more colours

You can assign one material per submesh. To split off a part of the mesh,

1. Change back to Edit Mode

2. Turn on X-Ray (Alt+Z) and select the shape that you want to split off

3. Press P -> S (Split -> Selection)

4. Rinse and repeat until you have all the submeshes split off

Creating a Wolvenkit project

Time to pull up Wolvenkit.

I'll be replacing base\environment\decoration\advertising\signage\sex_shop_neon_sign\sex_shop_neon_sign_b.mesh, the heart-shaped ad banner.

1. Decide on a mesh and add it to your project.

3. In the project explorer, right-click on the exported file (sex_shop_neon_sign_b.glb) and select Show in Windows Explorer, because we will now overwrite this file in Blender.

Exporting

In Blender,

1. select all the meshes that you want included (in Object Mode)

Assigning Materials

Open sex_shop_neon_sign_b.mesh in Wolvenkit and open the appearance on (as this is the one they're using on Jig Jig Street).

ChunkMaterials

At the very top of the mesh, we'll need to change the chunkMaterials as follows:

MaterialEntries

Now, we define the materials:

1. Find the array materialEntries

2. Add four new entries (or duplicate one four times, or…)

3. Name each item according to the entries in the previous step

4. Make sure that their index property is unique and corresponds to their array position.

LocalMaterials

… and finally, we actually add the materials.

1. Find and expand the array localMaterialBuffer and its child materials

2. Copy the second entry, sex_shop_neon_sign_emissive_red_on via right-click menu

3. paste it into materials

4. Duplicate it three more times

5. In the new material entries, find the property ColorOneStart and change it in the side panel.

6. Repeat for each material, then save the mesh.

Testing!

Let's hit up Jig Jig Street to look at our sign…

Congratulations! If everything works, you just made a mod!

I don't want a replacer!

Troubleshooting

There is really very little that can go wrong here if you closely follow this guide.

Something is wrong with my 3d object!

Something else is wrong!

Summary

Created on: 29. 12. 2023 by Last documented update: Nov 10 by and

This guide will teach you how to add garment support to a mesh that doesn't have any.

Wait, that's not what I want!

• To learn what garment support is, check

• For general Blender editing tips, check

Difficulty

You should know what , because it won't be explained here.

This guide assumes that you know your way around in WolvenKit. If you don't and you want to mess with this, kudos — I salute your frustration tolerance. In this case, the wiki's search function will be your new best friend.

Prerequisites

• A

• One or more

Step 0: export and join the base

As a preparation for our garment support, we need a base that we'll shrinkwrap to. For this guide, we'll be using the full player body in a single mesh.

You need the following files:

Female body gender

Male body gender

1. In the viewport, click anywhere to deselect everything

2. Press A to select everything visible again

3. Shift-click on something (e.g. the head) to deselect it

4. Shift-click again to re-select it (you need a most recent selection)

5. Press Ctrl+J to join all those meshes together

Optional: Clean up

• In the outliner on the right, delete all empty collections

• Double-click on your mesh and rename it to something, e.g. body

You should be looking at something like this:

This is the base that your items will shrink to, thus not-clipping. Neat, isn't it?

Step 0.5 (optional): activate garment support

If you're using a custom mesh as the base, you need two prerequisites:

1. Join everything, so that you have only one mesh. This mesh must cover everything that yours can potentially shrink to - if you fit the Netrunnner suit without the head mesh as part of the body, the collar will clip into the neck when you're wearing a coat

2. You need to activate garment support on the mesh. You do this by switching to the Data tab and setting its Value to 1:

Step 1: Add garment support

Import a mesh that needs garment support. In Object mode, select it by clicking on it so that it has a yellow outline like the body in the picture above, and switch to the Data tab on the right:

The Shape Keys dropdown should be empty. (Otherwise, hit the - button until it is).

1. Click on the + button to create a shape key with the name Basis. This is the garment's original shape and will tell Cyberpunk how it looks when it's not squished.

2. Repeat this process for every submesh (submesh_01_LOD_1 and submesh_02_LOD_1 on the screenshot above)

3. Switch to the Modifiers tab (the blue wrench icon, it's active in the first screenshot)

4. Add a shrinkwrap modifier

5. Target it to the mesh from the previous step (e.g. body):

1. optional: Add a small offset (e.g. 0.001) to make it not-clip. If the mesh you're shrinking to has garment support and you haven't enabled it, this isn't necessary.

2. You will now see that the garment has shrunk down to the body's dimensions — this is how the game avoids clipping.

3. Apply the modifier as shapekey:

1. You will now see that the garment un-shrinks itself: that is because the shapekey isn't active.

2. Switch to the Data tab again (the green triangle). There is a new shapekey now; it's called Shrinkwrap.

3. If you want to see it in action, set its Value to 1.

4. Rename it to GarmentSupport (capital G and S, no spaces — double-click on the name):

That's it, your mesh has now garment support. Rinse and repeat the process with the other submeshes, then export everything back.

Troubleshooting

My garment support isn't working!

My garment support is clipping into the body!

Try re-doing the shrinkwrap, but with a higher offset instead. Try something like 0.002 or so, whatever works for you.

Summary

This page will teach you how garmentSupport works – the system that Cyberpunk2077 uses to tuck pants into boots and shirts under jackets. It contains theory, which you don't need to understand to use the system.

Credit goes to psiberx ( with initial explanation of the algorithm), island dancer for providing screenshots and know-how, and Auska for making morphtarget/garmentSupport import able in Wolvenkit.

Wait, that's not what I want!

If you want to create garment support, check

If you want to use garment support in an existing mod, you only need to use

If your garment support is shrinking too far, check the section for

If you have other problems, see at the end of the page.

What is garment support?

The engine morphs garments to avoid clipping — for example, if you equip a pair of boots and V's jeans no longer cover the shoes, but get tucked under.

This process is accomplished via 'parameters' on the mesh:

Why doesn't it work on my NPC?

GarmentSupport only works on actual garment items that have been equipped using the game's transaction system. As of October 2024, that's not the case for NPCs. You'll have to go refitting!

Component prefixes

Garment support will be applied based on garmentScore. For this, the prefix of the component name will be considered (components are named in your .app or .ent file's component array).

The prefixes are as follows:

How it looks if it's broken

The algorithm

The game calculates the garment score by checking the prefix of component names, where the one with the lowest prefix is the innermost:

After considering the component name, the game will consider the tags in the .ent's visualTagSchema:

An example for t0_000_pma_base__full (the default body component, torso+legs):

Painting Garment Support in Blender

based on experimental research by revenantFun

TL;DR:

1. Make sure that you have the parameters _GarmentSupportWeight, _GarmentSupportCap and Col, and that all of them are in the format Face Corner > Byte Color

2. _GarmentSupportWeight: Vertex paint it red (RGB 1, 0, 0)

3. _GarmentSupportCap: Vertex paint it black (RGB 0, 0, 0) if it isn't

4. Col: Vertex paint it black (RGB 0, 0, 0) if it isn't

5. You're done!

Step by step, with explanations

In a given mesh, garment support is handled by two color attributes: _GarmentSupportWeight and _GarmentSupportCap. In Blender, these are found in the Data panel under Color Attributes, together with the third attribute, Col.

Here's how it looks like:

Fixing up old meshes

If you are editing vanilla items, you may find parameters of the type Vertex -> Byte Color with their names in ALL CAPS, such as _GARMENTSUPPORTWEIGHT and _GARMENTSUPPORTCAP. Delete them by selecting them and clicking the minus icon:

If all you're doing is trying to preserve existing garment support before doing some light editing or refits on vanilla garments, you can stop right here!

If you're making a brand new item and making your garment support from scratch, however, you'll need to keep reading to find out how these parameters should look.

Painting Your Parameters

Garment support color attributes are edited in Vertex Paint mode in the viewport:

_GarmentSupportWeight

This attribute affects how the mesh behaves when layered with other garments:

_GarmentSupportCap

_GarmentSupportCap determines stopping points for the deformation effects of garment support. Like _GarmentSupportWeight, it is painted only with red and black.

With vanilla items, you will see red GarmentSupportCap on areas that will either

• directly intersect with the body (the ends of sleeves and legs, the bottom of a shirt, the opening of a turtleneck...)

• sit right above something that shouldn't be deformed (the player body, or a tight-fitting shirt, or the lapels of an open jacket)

The cap provides a shrinking limit, so without GarmentSupportCap, every part of your mesh will apply shrinking/tucking on the meshes layered "below".

Often, this is completely okay and your _GarmentSupportCap layer can be flat black. Otherwise, you need to paint red those parts which either cut straight through the body or butt right up against other items.

If this step is skipped, you can have unexpected clipping, but nothing will break. If your mesh seems like it's being too aggressive when you layer it over other things, and leaving holes in whatever you're trying to layer under it, try painting more of the inside faces red.

That all seems like a lot of work? Can I make this less worse somehow?

The simplest way to add functioning garment support to your custom item is to have a flat red _GarmentSupportWeight attribute, a flat black _GarmentSupportCap attribute, and a flat black Col attribute. Your mesh will export and, assuming you have the proper shapekeys, will morph in (more or less) the way you'd expect! The next page will outline this process step-by-step.

Troubleshooting Garment Support

My garment support is shrinking too far!

My garment support explodes on contact with another item!

It's not doing that to spite you. Most likely, you have a non-unique component ID, and the game can't tell the two items apart. Here's how to resolve that:

Importing with Garment Support

Yeeting Garment Support

Summary

Created: ??? by PinkyDude 🦝 Last documented edit: Sep 22 2024 by manavortex

This guide will show you Pinky's weight painting workflow, sharing tips and tricks on how to fix weights on garments for both refits and custom ports. You can find the original tutorial on Google Docs.

This guide will use a masc garment, but the process works the same regardless of rig or body type.

Wait, that's not what I want!

• For porting objects altogether, see Porting 3d objects to Cyberpunk

• For help with refitting, see R&R: Refitting (step by step)

• For converting between bodies, see RIG Swapping Garments - other body conversion

Requirements

For this guide, you need:

You also need a Wolvenkit project with an item where you want to fix the weights.

Step 1: Exporting your weight source

For this example, I’ll be starting the weight from scratch for my Tracksuit Jacket:

1.1: Finding a donor mesh

It's best practice to stealcopy the weights from an existing in-game item.

A good candidate is the tight version of T-Bug's netrunner suit, as it has the required bones for almost everything:

base\characters\garment\player_equipment\torso\t0_005_pma_body__t_bug\t0_005_pma_body__t_bug_tight.mesh
base\characters\garment\player_equipment\torso\t0_005_pma_body__t_bug\t0_005_pwa_body__t_bug_tight.mesh

Add the correct version for your body gender to your Wolvenkit project.

Why this is a good mesh

It is really tight. This has a few nice side effects:

• If it clips, it will clip into the body — that is perfect for weights!

• It will avoid "bat wings" around the armpits, where parts of the sleeves or sides will stretch next to the chest

Unfortunately, a perfect fit does (usually) not exist. But don't worry, we can fix this!

Step 2: Transferring weights

2.1.: Importing the Netrunner suit

1. Export the Netrunner suit to glb

2. Import it into your Blend file

3. You'll notice it has 3 submeshes. Merge them into a single submesh:

   1. Click into the viewport to deselect everything

   2. Hold the shift key and click on each of the three meshes

   3. Press Ctrl+J

2.2: Preparing your own mesh

If your refitted garment is already broken down into multiple submeshes, you’ll have to do the same thing here. The result will be called "weight container" or "target mesh" in the rest of the guide:

Create a joined duplicate “weight container”:

Merging by distance

Even if we merged the submeshes, the actual models themselves are still separated. Editing and smoothing the weights will cause them to detach from each other, creating holes and gaps along the seams.

For that reason, you should now clean up your mesh and merge the vertices by distance:

❓ Edit Mode > Mesh > Clean Up > Merge by Distance

Cleaning existing vertex groups

When porting assets from other games, a good habit is to always clean the Vertex Groups before transferring weights :

Step 3: Transferring weights

1. Click the weight source (the Netrunner suit)

2. Ctrl+Click on your merged weight container (the target mesh)

3. Switch Blender to Weight Paint mode:

1. Select Weights -> Transfer Weights

1. A pop up will appear in the bottom left corner of your viewport window. Make the following changes:

   • Vertex Mapping - Nearest Face Interpolated

   • Ray Radius - 5m

   • Source Layers Selection - By Name

You have now successfully transferred the weights from the Netrunner suit to your ported garment. Let's clean this up.

3.1 Cleaning up

1. Select Weights -> Limit Total.

2. In the pop-up at the bottom left, change the limit from 4 to 8.

1. Finally, select Weights -> Normalize All

2. In the pop-up at the bottom left, un-check Lock Active:

Step 3: Testing on an animated body

We could now transfer the garment's weight to our submeshes, import the result into the game, notice that something is off with the weights, fix it in Blender, rinse, repeat, and waste a lot of time.

Instead of doing that, we'll simply hook our garment to an animated body.

3.0: Using the prepared resources

I took the time to merge and weight-fix two full bodies who are also already hooked to the inventory “Jacket Check” animation

You can download them from my Resources folder, here:

🔻 MA Body - Man Average RIG

🔻 WA Body - Woman Average RIG

To add it to your .blend file, select File -> Append, and select the collection [MA/WA]_weightCheck:

You can now skip to #id-3.4-connecting-the-meshes-to-the-armature

3.1: Getting a rig

1. From the Blender AddOn's Animation Tools Panel, select the correct rig for your mesh. You'll most likely want man_base or woman_base:

1. Change your weight container's armature modifier to point at the rig you just imported:

3.2 Getting a body

You can use the same body that you've already used for refitting. This tutorial won't cover this — look it up in R&R: Refitting (step by step).

1. Import your body mesh into Blender

2. Join all the submeshes together

3. Change the body's armature modifier to point at the rig you added in 3.1

3.3 Getting an animation

You can see that our added armature already has A-Pose and T-Pose hooked up:

We need a bit more than that, so let's grab ourselves an .anim from the game files.

For fitting clothes, you might want to use the inventory idle animations:

base\animations\ui\male\ui_male.anims
base\animations\ui\female\ui_female.anims

Otherwise, you can get creative with the Wolvenkit Search (something like .anims > !fpp)

1. Pick an animation and add it to your project.

2. Export it from Wolvenkit

3. Import the glb into Blender

This will populate the Animsets list.

We can use the play button to make everything move. Now, time to hook everything up.

3.4 Connecting the bits

1. Select your merged weight container and change its Armature modifier: aMa / aWa if you used the prepared resources, the armature from 3.1.2 otherwise

1. Rotating your body, you might already notice holes or clipping:

1. Let’s check the animation by pressing the Play ▶ button on the timeline or in the Animation Tools:

1. Arms and collar will need some fixing. Let's go and do that.

3.5 Weight Painting Prep

1. Use the Play button at the bottom of Blender's viewport or in the Animation Tools

2. Let the animation play to a point where your issues are clearly visible, then hit the button again to pause it

3. Hide any armatures and collections, so that only the jacket mesh is visible.

Step 4: Manual weight painting

From experience, we know which bones are responsible for the bat wings, but we'll go through the list one by one. If you want the more target-oriented approach, skip ahead through #id-4.1-fixing-the-bat-wings

1. Enter Weight Paint mode (at the top left of the Blender viewport)

2. Open and expand the Vertex Group list on the right:

1. On the right, select the first vertex group (Hips)

2. Use the Blur tool to fix anything that looks janky

3. Select the next vertex group on the list (Spine)

4.1 Fixing the bat wings

1. Smoothing out the Spine groups helps a bit, but the mesh is still being pulled: