1 of 73

Modding Guides

This page contains instructions on making mods. If you want to install mods instead, check here.

Here, you can find

various modding guides in the menu tree to the left
an overview on and
information on inside a mod
A guide on how to
Information and how to configure them
to quickly look up files in the game paths
Information on and

If you just want to look something up or find a file, check the "" section.

Analysing other mods

This guide will walk you through analysing or extracting archive files from tutorial resources or other mods.

Required: WolvenKit

Please keep in mind that you are looking at somebody else's work. Always credit if you use anything from other peoples' mods, unless it's explicitly stated that you don't have to!

Some modders don't want their mods to be unbundled. Most people don't mind if you do it for your own personal use, but you should seek permission and respect their decision.

For a documentation on how to use Wolvenkit CLI, see . Unless you have a very good reason to use the console, you probably don't want to.

Step 1: Switch to mod browser

You can now add the content to your project just like you do it with game files:

Step 2: Find the correct files

The folders in the mod browser correspond to the names of the .archive files you have installed.

E.g., To find all .mlsetup (colour definition) files inside the , search for:

If you want all mesh files from the , search for

f you want to know more, you can read up on .

Step 3: Add the files to your project

Select the file that you want to add by checking the box. Then right-click on it, and click on the Add selected items to project option.

That's it!

Legacy: Analysing other mods with Wolvenkit Console

Unbundling mods with CLI

This technique is outdated as of 2023. If you don't have a very good reason why you need Wolvenkit console, then you should .

wolvenkit.cli.exe

Animations/Poses

This page will gather knowledge and guides about animations.

Summary

This page and its subpages contain links to guides about making animations and poses (static animations) for Cyberpunk 2077 and importing them into the game. For theoretical information, please refer to the .

For individual guides, please check the sub-pages in the navigation tree or use the "Next" button at the bottom of this page to browse through.

NPCs & V

This is the landing page for guides on how to change people. Here you can learn how to modify or create custom NPCs.

Please check the link tree in the menu on the left for details.

If you want to know where to find a specific NPC, check NPCs and their files in the References, lists and overviews section.

NPV: Cleanup and troubleshooting

I'm done, what's next?

Re-path your folder

Why are we doing this?

When packing a mod, Wolvenkit generates an .archive file with the files in your project's

Swap Johnny during the Alt's scene

Summary

Created by @Pinkydude Published Summer 2021

What you’ll need :

A “Never fade away” Savefile before entering the room

First off, grab my FixSwap and Removers mods and drop them in your Mod Folder

Load your “Never Fade Away” save file before entering the room, and open AMM

Spawn > At Own Risk > Johnny mirror

The spawned Johnny will be invisible, you’ll need to scan his feet shadow to be able to swap!

Make a quick save and reload it

Make sure to despawn your V/Johnny before entering the room!

There will be small a moment, when Alt takes off Johnny’s glasses, where your V will turn invisible ; That’s ok, they’ll pop right back when the mirror scene start!

Items: Equipment

Weapon, armour, consumable, hair, cyberware..

Welcome to the equipment section. Here, you can find guides on how to edit equipment and wepaons in Cyberpunk. The section is split into the following subsections:

Wait, that's not what I want!

This section contains hands-on guide for editing equipment.

R&R: Troubleshooting

The troubleshooting section for the Recolours & Refits guide

Summary

Created by @manavortex Published September 30 2023

This page is a part of the Recolours and Refit guide. It will

The troubleshooting steps below will be expanded as people follow this guide and run into problems. If you encounter anything not on the list,

make sure to double-check the guide — did you complete all required steps in the correct order?
find @manavortex on the , for example in #mod-dev-chat

Import/Export

You can check or see for general troubleshooting.

I can't import my file back

Have you moved any files?

File paths are which files belong together. If you have moved files, do this:

Export the target file again
Overwrite the exported file in your project's raw folder with your changes
Import back

MLSetupBuilder

You can find tool-specific troubleshooting on .

I can't build a depot

That's okay, you can still , or you can check for more instructions.

Refitting

My mesh is string cheese!

You either need to , or .

Editing existing items

Irons, threads and everything else

This section contains guides how to alter or overwrite already existing items (please see the page tree in the navigation menu on the left).

If you want to look up , find the corresponding page in .

Textures and LUTs

Modify Cyberpunk's visuals

This section contains guides for

the process of modifying Cyberpunk's visuals.

Troubleshooting normal maps

In-game, your normal map isn't looking as expected

Import settings

The texture has to be imported without the isGamma flag. Import over an already-existing normal map to rule out this as a source of error. See for more detail.

Archived

Out-of-date content and guides.

All of these articles are out-of-date. Only use if you really know what you're doing.

Custom icons and UI

Expanding Cyberpunk's base UI

This is the landing page for guides that teach you how to influence Cyberpunk's base UI and its textures.

For a full overview of guides linked here, please check the link tree on the left.

Inkwidgets: a custom interface

How to create a custom interface via inkwidgets

There's nothing here yet! Maybe you are the person to change that?

Gendered preview icons

This is a sub-page of "your own preview icons" and only contains information on how to hook up gendered variants once you already have the files. If you aren't quite there yet, refer to the other guide first.

Requirements:

This will not work unless your item is using the corresponding suffix. Without it, the game has no way to tell male and female items apart.

If you want to know more about this, you can read up here:

If you don't have a gendered item yet, see the original ArchiveXL guide, section "".

How to do it

By adding an icon property to your item's yaml, you're telling ArchiveXL to create an UIIcon record for you. The generated records will be the same for all genders, variants and tags.

If you want to use a gendered preview picture, you can create a more specific record yourself. In this case, you can delete the icon entry from your item.

Its name will follow this schema:

Wait, what?

ENTITYNAME, APPEARANCENAME, SUFFIXES and VISUALTAGSabove are placeholders for the corresponeding fields in your YAML.

You can look up the actual names of the created records in CET's Tweak Browser and simply copy them to your .yaml

For example, if you have the following item:

… then you'd define a preview image like this:

The trailing underscore separates the empty visual tags from the suffixes entry.

Your items won't need an icon record anymore, the assignment now happens by magic!

Vehicles

This section collects information for vehicle modding. However, all we have as of now are two links.

Boe6 has been so nice to share their (very detailed) guide on Google Doc and given full permission to transfer it to the wiki. However, nothing has happened yet.

A second guide is here, although it is not very detailed.

World Editing

Step by step guide on how to move or delete a object from the world of cyberpunk 2077.

Summary

Created by @Krat0es Published October 10 2022

This guide aims to teach you moving and deleting objects from the world.

Requirements

or higher

For more documentation on streaming sector files, see .

For a list of interesting locations to modify, see .

For a guide how to export streaming sectors to Blender, see .

Finding the required sector

first of all you will need your in-game player coordinates you can use print(GetPlayer():GetWorldPosition()) in the CET console to get them.
after that search for streaming block in the asset browser and open the block then click on sector preview

After finding the sector you need add it to your project then open it then click on sector preview again, from the menu on the right find the object you want to move or delete, click on the small red box to confirm if its the right object or not (you will see it disappear when you do that)
After finding the object you want to move or delete go back to the WorldStreamingSector tab then click on nodeData then find the object in the list (You can memorize where the node is from the sector preview menu) (edited)

Note: when you delete a object and you see a low res mesh in its place in the game that means the object has a proxy assigned you will have to find the sector the proxy is in and delete the proxy mesh. (you may do that following the same steps)

Adding Objects to the World

will share info on how to add objects like door, loot, walls etc

Summary

Created by @Krat0es updated by Doctor Presto Valid as of March 21, 2023

This guide aims to teach you adding objects to the world.

Requirements

and updated file created by KeanuWheeze - this archive contains an ent for every single vanilla mesh in the game, allowing you to spawn anything you'd like. place the archive in your mods folder and use the allpaths text file to replace the one in your object spawner data folder in the CET directory - should be something like this: Cyberpunk 2077\bin\x64\plugins\cyber_engine_tweaks\mods\entSpawner\data

Adding Objects to the World

Install Object Spawner
Start the game, load a save, navigate to the location you'd like to build and press your CET hotkey. Object Spawner will open along side CET and any other CET mods you have installed
Go to the "Spawn New" tab of Object Spawner and search for the objects you'd like to spawn - simply click on the name to spawn it.

Note: depending on the object spawned, it may or may not have baked in collisions. Keep this in mind and don't worry - there are a number of ways to either add collisions or fake them depending on the context.

Add your objects to a group - if creating a building or other complicated structure, you should also create subgroups for each of your exterior walls and other major components.
after placing the objects, save the group incase you want to change something later on and then use Object Spawner's export function to create a .JSON file which you can use to add these objects permanently to the world.

Now you are ready to move on to the next guide which will help you add these items to a new .streamingsector file and merge your additions with the game world using ArchiveXL so that your items are a permanent addition with no worries about conflicting with other mods.

Adding Locations and Structures with ArchiveXL

This guide demonstrates how to add new locations to the world by creating new .streamingsector files and adding them to the game world by merging them with the all.streamingblock via ArchiveXL

Valid as of March 21 2023

Requirements

Wolvenkit 8.8.1 (bugs in nightlys and stable version 8.9.0 prevent adding new nodes to a streaming sector)
(thanks Psiberx!)

Resources

- this adds a low poly house exterior mesh to the center of the glass dome in corpo plaza (near the giant holo fish)

Adding a custom location to a new streaming sector and merging it with the game world

After following the previous guide to add and position the objects you want to add to the game, open the example mod project in Wolvenkit and open the file new_mod_sector.streamingsector
in the "Node Data" section, right click on the existing node and click "Import from JSON (no coords update)

Sound

WIP: This page contains a selection of guides on how to create sound-related mods but is still incomplete.

Feel free to sign up and add your knowledge to the wiki. It doesn't matter if the guide is shitty or if your English is bad, the next person can always improve on your stuff – as long as there is any stuff!

Guides:

Playing Sounds in-game : Basics

External links:

There are a couple of pages about sounds on Roms1383s wiki for his Addicted Mod:

Playing Sounds in-game : Basics

A Basic guide on the different ways to play a sound effect in-game

Difficulty:

This is a very basic tutorial so you don't need much knowledge to do it successfully.

Quests

How to Edit Voiceover and Subtitles In a Quest.

Guide made by Forsentio - Quest Team member working on WolvenKit at RED Modding Tools.

Requirements:

CP77 Tools
(Thanks to alphaZomega for his great work)
Some basic knowledge of what are you doing (Seriously)

First and foremost you need to have the raw files of the game extracted If not, use the latest release of CP77 Tools and extract the archive. You also need to extract and unbundle the lang_eng_text archive for this tutorial.

Now that you have the raw files, head to the "quest" folder (found here: [...]\basegame_4_gamedata\base\quest) then chose a quest from one of the sub folders:

main_quests (the main story quest, internally labled as qxxx)
minor_quests (minor activites such as psycho sighting... etc, internally labeled mqxxx)
side_quests (the side gigs such as Judy's quest, River's story... etc, internally labled as sqxxx)

For this guide, we're going to use the one named MQ041, also known as "War Pigs", avaialable only for the Corpo lifepath. You should find it here: [...]\basegame_4_gamedata\base\quest\minor_quests

We want to make the main character say a different line then the one he is supposed to. For example replacing "Hey, yeah, sure. Damn, you ol' bastard, been a while since..." with "Fuuuck!" when the holocall starts.

You should have also unbundled and uncooked the lang_eng_text archive.

Okey, now that everything is clear, let's start. 1. Open the scenes folder inside MQ041, and then open the file named mq041_corpo_01_deadmans_switch.scene in 010Editor with alphaZomega's CP77_CR2W.bt template already installed.

2. Go to struct Data, open scnSceneResource, then scnscreenplayStore; inside you're going to find an array named scnscreenplayDialogLine 3. We're going to associate each entry with the line we see on screen; to do so we need the locstringIds and another file you can get from the lang_eng_text archive 4. Next, open the lang_eng_text archive and search for mq041 here: [...]\lang_en_text\base\localization\en-us\subtitles\quest 5. Once found the quest folder open the .json named mq041_corpo_01_deadmans_switch 6. Open struct Data, then JsonResource, handle:iSerializable, localizationPersistenceSubtitleEntry and finally array:localizationPersistenceSubtitleEntry 7. Here in the value column you're going to see lots of stringId; remember the locstringIds from point 3? Good! They're the same 8. We now know that stringId = 1822802647440039936 is responsible for "Hey, yeah, sure. Damn, you ol' bastard, been a while since...", and that stringId = 1874801294016040960 is the same as "Fuuuck!" 9. Let's go back to the the

[PLACEHOLDER FOR A VIDEO]

How to Change Position and Rotation of an entMeshComponent

Guide made by Forsentio with the help of Loomy, PixelRick and Sombra - Team members working on various projects at RED Modding Tools.

Summary:

We will guide you through the step-by-step process that will allow you to rotate and position differently the duvet above V's bed, so that it flows with how the sleep animation plays out.

Requirements:

.
.
Some basic knowledge about modding Cyberpunk 2077.

The Steps:

1. Unbundle and uncook basegame_3_nightcity.archive, basegame_4_gamedata.archive. 2. Find the entity you want to modify (in our case it's located here "basegame_3_nightcity\base\quest\minor_quests\mq000\entities") 3. Once you have the entity open its buffer in the Cyberpunk Save Editor by dragging and dropping it inside. 4. Open the entMeshComponent that has the same name as the mesh you want to modify (in our case is 3 entMeshComponent "bed_duvet_poor"). 5. Open the localTrasnform array, and inside of it Position and Orientation; you're going to see different values. IMPORTANT NOTE: ijkr are to be read as xyzw, **** where z is front/backword, x is left/rigth, y up/down. 6. Edit those values accordingly to how you want the entMeshComponent to appear in game (this is where experimenting is encouraged until you get the result you want ) IMPORTANT: For a better understanding of how your changes may affect the ingame position and rotation use this

How to Remove an Animation (and Potentially Replace It)

Guide made by Forsentio - Quest Team member working on WolvenKit at RED Modding Tools.

Summary:

We will demonstrate the step-by-step process which allows you to remove (and potentially change or replace) an animation in game.

Requirements:

(thanks for rfuzzo).
.
(thanks to alphaZomega).

The Steps:

1. Unbundle and uncook basegame_3_nightcity.archive, basegame_4_gamedata.archive using CP77Tools 2. Find the animation you want to remove (in our case we want to remove the idle animation that plays when the player is standing in front of a mirror)

The game works by using .scene files for certain interaction; you should take a look into those and search for the sectionNode that plays the animation you want to remove after you opened it in the 010 Editor, by using alphaZomega's template. The scene file we are using is located in "base\quest\minor_quests\mq000\scenes\mq000_01_apartment.scene"

3. Once the sectionNode is found, open Struct Data, then scnSceneResource, then scnSceneEvent array, then scnPlaySkAnimEvent, then scnEventBlendWorkspotSetup; inside of it you will find a workspotId, which you must take note of.

SIDE NOTE: Most of the game relies on Workspots used as interactable points both by the AI and the Player. In this case, the Workspot we are changing is used for the various interactions in V's appartment. The Workspot's location is "base\worksposts\quest\main_quests\prologue\q001\q001_01_wakeup\q001_01_wakeup__look_mirror.workspot"

4. Return to scnSceneResource and open scnWorkspotInstance. Search for the one that has the same number right next to workspotInstanceId; open it and take note of the dataId 5. Return to scnSceneResource and then open the scnWorkspotData and open each of theme until you find the one that has the same dataId. Open it and take note of the path right after the workspotResource 7. Open the .workspot file and then go to Struct Data, then workWorkspotResource, then workWorkspotTree, then handle:worldEntry, then workSequence, then worklEntry: there you will find a different named work[...]Anim; search for the one that has the same name as the animation you want to remove and take note of the number right before the name 8. Go into the CNAME array and zero out the name 9. Save, pack and place in the Mod folder

Everything else

Stuff that didn't fit the other categories

This collects all guides that didn't fit any of the other categories. Check the navigation tree on the left / in your phone's menu.

f!V and her gremlin feet

Summary

As you have probably noticed, female V has two different feet states because fuck you, that's why. Fortunately, that's why a bunch of really smart people came up with ToggleableFeet, which gives you some freedom for ArchiveXL and EquipmentEx.

To see the documentation, scroll to the bottom of the Nexus mod's page and click on the spoiler tags

Customise CP77 info on GOG

Summary

Created by @Pinkydude Published Summer 2021

Go in the two little lines with circle thingies, and go to “edit” / the second option. Click on the “Media” tab and you’ll be able to put any pictures!

Mind the resolution, and put something smaller than the ones recommended (it doesn’t work if it’s exactly 660x930px)

R&R: Colour Editing

Doing a custom recolor of the Netrunning suit

This page is a subsection of the Netrunning Suit guide. It will teach you how to recolour Cyberpunk items via MLSetupBuilder.

Assumed level of skill:

You know how to read — if you can read and struggle with this guide, then it's not yet good enough. Please reach out to on the redModding Discord so that I can improve it.

Time to complete:

<1h for the tutorial
< 5 minutes once you know how it works

Prerequisites:

You have either decided against a preview, or for the preview
You have a
You have from the original mod's .archive and added them to your project

If you can check all those boxes, let's go.

Overview

MLSetupBuilder can't directly edit game files. For that reason, we need to

export our .mlsetup to an .mlsetup.json
edit that file via MLSetupBuilder
import it back

You can't skip any steps in this section that don't say otherwise.

Do not move any of the files. Wolvenkit will lose track of them if you move them around.

Step 1: Loading the file into MLSetupBuilder

Getting the file into the tool, and opening the right preview

Now that you have added the right file(s) to your project, right-click on them or on their folder and select the option to export them as json:

Once you have done that, switch to your project browser's raw tab, right-click on the first file, and select the option to open it in MLSetupBuilder:

This will open MLSB with the correct file already loaded.

Alternatively, you can also open MLSetupBuilder by hand, then press Ctrl+I or select Import from the menu.

If your material list is saying [object object], check the

(Optional) Step 2: Preview and Layer Masks

If you don't care for this, you can skip to

Enable preview

Switch to MLSetupBuilder's .
Check if the .mlsetup that you want to edit is in a subfolder layer_mask_2
- No: Search for t0_005_pwa_body__t_bug

Songbird's suit has a custom mlmask, which I've been too lazy to set up. Future MLSetupBuilder updates will support dynamic switching.

What's going on here?

This is an optional theory block. You can skip this box.

An .mlsetup is a list of 20 material definitions, which are projected on the 3d object like layers of paint. The is a list of 20 cut-out stencils, which block out parts of the layer. (You can see a live example by clicking through the list of layers in MLSB!)

The layers will be applied in order: first Layer 0, then Layer 1, then Layer 2. This is how we can colour the arm stripes separately on t0_001_wa_body__t_bug.

Step 3: Recolouring

Prerequisites

You have
It's open in MLSetupBuilder (if it's not, import it now — you can press Ctrl+I to open the file picker)

There will be a bunch of links in this section, which you can absolutely ignore. They'll lead you to look-up tables or extra theory.

Potential breaking point

If you are here to edit other mlsetups, you can skip this section

Some suits are using custom materials, which MLSB isn't yet equipped to handle. You can identify them by the missing icon in the preview (see the screenshot below). For details on how to handle those, check below.

Change the colours

Click through the layer list on the left (1).
The Material value (2) changes based on your layer selection, as will the available options
Change the colour by clicking on it in the Color Picker (3)

Repeat the process until you're satisfied
Now export the .mlsetup (shortcut: Ctrl+E).
Overwrite the file you imported (e.g. mirror_hex_black.mlsetup.json

Custom material paths

This section tells you how to deal with custom materials. You can identify them by their broken preview icon.

If you don't have any of those in your .mlsetup or if you are just recolouring MlSetups independently from the Netrunner guide, then you can skip to

Since I knew that I was going to share this, I've moved custom materials into a subfolder manavortex in their original path.

To get the original color picker back, we'll need to change the path while you're editing the material, then put the original back when it's time for export. You do it like this:

Click into the material path (orange box)

Press Ctrl+A to select the path.
Press Ctrl+C to copy it. Paste it into a text document so that you can restore it later.
Find the subfolder manavortex\

You now have a working colour palette and can edit the material.
When you're done, click into the material path again and restore the original value.
You can now export (ctrl+E)

Step 4: Importing into Wolvenkit

Switch back to Wolvenkit.

Make sure that the Project Explorer shows either of the tabs source or raw
Find the file that you just edited
Right-click on it and select the option to convert it from JSON:

Step 5: Testing

Time to test! Install and launch your Wolvenkit project:

If you did everything right, your recolour will now be active.

Otherwise, check .

Creating a LUT from scratch

A description of a streamlined, refined, accessible, and relatively easy system for creating Cyberpunk 2077 LUT mods from scratch.

This method is for LDR. Little to none is known about HDR LUT creation, so please, do not expect anything on HDR LUTs.

What is a LUT, really?

It's imperative to understand what LUT really is before starting. Often, beginners have a misconception caused by other software which often uses different formats for LUTs and different ways to apply them, such as ReShade.

Cyberpunk LUTs are distinctly different from ReShade LUTs due to two things:

They are 3D textures, not 2D textures with tiles describing different parts of the RGB cube, no, Cyberpunk LUTs are full-on 3D textures sampled with trilinear filtering.
They are applied with an input of ARRI LogC3 data with an sRGB color space. This means you can't go and use any ReShade LUTs, as they often do not expect LogC3 output. Along with this, many tools expect ARRI LogC3 data with an ARRI Wide Gamut 3 color space when generating your LUT. If you do not convert to it, you will end up with clipping colors.

But, aside from that, they are similar. Any LUT expects an input of a color, with an output of a new color. That's it. Cyberpunk's implementation is as simple as extracting the pixel out of the LUT texture that matches the input color, and if there isn't an exact match, it interpolates linearly to get a near-perfect approximation of the true output color.

If you're still confused, I recommend looking at .

Prerequisites

A backup of NVTT can be found here

If you don't trust a random exe file, that's good, but if you want to download it from the source you need to create or use your current NVIDIA account and add yourself to the developer program.

DaVinci's website prompts you to fill out some data before being able to download the software. You can fill this out with fake data, it doesn't really matter.

You can use Fusion Studio just as easily as well for parts of the guide, and DaVinci Resolve Studio is also recommended in general.

By the way, if you just wanna skip the steps on repeat projects, there is a reference GitHub repository containing NVTT settings, DaVinci Resolve and WolvenKit projects, as well as pre-made LUT files if you just wanna test them out quickly.

Workflow

WolvenKit

Create a new project in WolvenKit and import the file base\weather\24h_basic\luts\cp2077_gen_lut_nge_v017.xbm and export to a DDS, then rename it, removing the xbm file extension. You should have a dummy name with a file path containing that same file in the "raw" folder. You can delete the file in there, we only need the folder set up correctly.

DaVinci Resolve

If you have issues getting Resolve to run for the first time, uninstall the panels program. It causes crashes if you don't have any DaVinci panels or sliders.

Create a Resolve project, and head straight over to the Fusion tab, without importing any media. Add a LUT Cube Creator node, change the type to vertical and size to 32, 48, or 64. Remember this number, as you will use it later. Select for the generated Media Out node to output to both sides of the preview by enabling both of the circles below it. On one of the sides, select Views>3D Histogram. You should now have a LUT cube present. If you'd like more accuracy, right click and go to 3D Histogram and select solid with 1:1 sampling.

Right after the LUT Cube Creator node, add a Color Space Transform node, and matching the fact that tools expect ARRI Wide Gamut 3 with ARRI LogC3 data, but the game outputs sRGB with ARRI LogC3 gamma, we need to go from sRGB color space with ARRI LogC3 gamma to an output color space of ARRI Wide Gamut 3 with output gamma of ARRI LogC3

After this, we need to go from this LogC3 data to sRGB, which is what our display expects.

ACES method (recommended)

This is the method used by the original game to go from the input LogC3 to sRGB output, so it's what's recommended.

Add an ACES Transform node after the Color Space Transform node. Set the input transform to ARRI LogC3 with an output transform of sRGB and use ACES reference gamut compression.

ARRI LogC3 method

This method uses LUTs from ARRI themselves, and as such gives us two options: LogC3 and LogC3 "classic". I encourage you to use the normal LogC3 LUT, but experiment with Classic and see if you like it. Though, this method requires a change in the settings that are described later.

In the link above, select LogC wide gamut as the source format and destination format as video. Select your preference of ARRI Classic 709 and ARRI 709 in the conversion parameter. The file type can be either Blackmagic Fusion or Blackmagic DaVinci Resolve, it really doesn't matter.

Add a serial File LUT node and point to your downloaded file.

ARRI LogC4 method

It may share a name with the LogC3 method, but is distinct from it as it uses a more recent revision of the color science compared to the LogC3 method, but we will need to change things before and after this step if you decide to use this method.

Follow the same link described in the section until you reach this part. Download the "ARRI LogC4 LUT Package".

Once you have downloaded it, extract the Rec.709 Gamma 2.4 65-point .CUBE file from the zip file. Add a serial node after the Color Space Transform called File LUT and point the LUT file to your extracted .CUBE file.

We have to make some changes to the Color Space Transform node, change the output color space to ARRI Wide Gamut 4 (instead of 3) and then the output gamma to ARRI LogC4. Your LUT should now look correctly exposed.

You can mess with the Tone Mapping Method, but just select None as a good option.

We need to change an option afterward that will be described later for both the LogC3/4 methods.

Resolve Color Managed method

This method uses DaVinci's integrated tone mappers to go from the LogC3 input to sRGB output. It produces a neutral and accurate output. It's also very minimal.

For this method to work, we just need to change the settings in the Color Space Transform.

Instead of having an output color space of ARRI Wide Gamut 3, set the color space to sRGB and gamma to sRGB as well. Then, change the tone mapping method to DaVinci, or some other method if you know what they mean.

This method creates a color cube that is very "unbiased"--it has fidelity in all directions, which, while creating a good representation of true color, can result in unnatural saturation. To account for this, the saturation compression gamut compression method can be selected.

After you have used your preferred method, you need to apply gamma correction. If you do not do this, you end up with incorrect gamma, which can mainly be seen on skin tones.

For the ACES method, you need to add another Color Space Transform node, with input color space and gamma of sRGB, with the output color space of sRGB but output gamma of linear.

For both ARRI methods, nearly the exact same steps are taken as the ACES method, but, instead of sRGB input color space and gamma, we use an input color space of Rec.709, but input gamma of Gamma 2.4. Keep the output color space at sRGB and output gamma at linear.

For the Resolve Color Managed method, simply change the output gamma in the color space transform to linear, but turn on Apply Forward OOTF.

This is the final stage. We now just need to output to an image, and use the right format. To do this, use a Resolve FX Transform>Transform node (not any other transform node) and switch on "Flip Vertical" to correctly output.

Right click on the LUT picture and save your image as a TGA or PNG file.

NVIDIA Texture Tools

Drag on your exported file onto the NVTT window and tick off "Generate Mipmaps" and select format as 32x4f. Tick off KTX2 compression and tick on DXT10 header as well turn on Highest compression quality.

Turn on "Extract From Atlas" and set "Depth of Volume" to the exact size of your LUT that you set up when first creating it. To verify you got it right, you should see a Z slider on the top right of the NVTT interface. Drag it and see if there is any vertical shift in the texture. If there is not, you got it right.

Save as a DDS file (only DDS) and put it in the folder that was generated after you exported the XBM file at the start of the article.

WolvenKit again

You should now see it in the import tool in WolvenKit. Change its TextureGroup property to TEXG_Generic_LUT, turn off IsGamma, VFlip, GenerateMipMaps, IsStreamable, and PremultiplyAlpha. Set compression to TCM_None. If your file doesn't have RawFormat as TRF_HDRFloat, then something in the DDS importing went wrong, and you need to re-set the format as 32x4f in NVTT.

Import the DDS. We need to tell the file it is actually a 3D texture in the header (even if the 3D data is already there), so go to renderTextureResource>renderResourceBlobPC>header>textureInfo>type and change it from TEXTYPE_2D to TEXTYPE_3D.

Make a copy of the XBM file and rename it to cp2077_gen_lut_nge_v017. Our dummy file there is for being able to quickly copy the filename, so, select your LUT XBM, C-c, C-v, select the dummy file, F2, C-c, select your LUT copy XBM, F2, C-v.

Your LUT is now correctly set up. You can install and launch now!

Results

Custom facial piercings - PRC Framework

Adding custom facial piercings through PRC Framework.

Created by Mx_OrcBoi

Published on 12/07/2023

PRC Framework was created by eagul, he also taught me how to do them, so I'm passing on the knowledge.

Required:

Blender 3.5

Wkit 8.9.1-Nightly

Level: If you can read and follow instructions you should be ok.

Disclaimer: The detailed steps show how to place piercings in spots where vanilla ones already are.

For any other location on the face the steps are slightly different, as you will need to create your piercing on the head mesh and import over head mesh.

This is explained in a separate section.

I would suggest trying to create one in an existing location first, so you familiarise yourself with the steps and then play around with different locations.

Getting started

Download and install the below:
In wkit import the below to your project depending on which V you want to create the piercings for:

Export to GLB so you end up with those files in the raw folder.

Import them into Blender using Cyberpunk GLTF import plugin. In this example I will be working on fV. You should end up with files like this and be able to see the head, vanilla piercings and a set of shape keys.

Each shape key corresponds with the number on the character creation slider. Basis is 1 on all sliders or no shape keys active. The rest is divided into ears, nose, eyes, mouth and jaw and subsequent numbers correspond to the character creator settings (1x is slider 2, 2x is slider 3 and so on).

You can see the shape keys actually working by selecting one of them and setting Value to 1.

For easier selection merge head mesh vertices by distance. To do this, select the head mesh, go into edit mode (Tab) and go to Mesh -> Clean Up -> Merge by Distance. Set merge distance to 0.0001.

Import your piercing mesh. I’ll use the septum half ring as an example. Make sure the mesh is already UV unwrapped if using custom mesh.

Duplicate the vanilla piercing. To do so select it in the viewport (object mode), press shift+D and then click the right mouse button. Hide the original mesh.
With vanilla mesh duplicate selected, go to edit mode (TAB) and press Del -> vertices. You will end up with an empty submesh.
Select your piercing mesh, then Ctrl select newly emptied vanilla submesh. Press Ctrl+J to join.

Weight painting

Now we need to either weight paint, or transfer weights if your new piercing is in the same position as vanilla one. Mine is, so I will go over transferring weights.

You can see the current weights the mesh has in Weight Paint mode.

I’ve selected the vanilla piercing here. By clicking different vertex groups you can see the colour of the mesh changes. This colour denotes how much influence each bone has on the mesh. Red is 100% and dark blue is 0%.

Go back to object mode if you’re in weight paint mode. Select your mesh and remove all vertex groups.

Go to modifiers (wrench icon) and add Data transfer modifier with below options. The source would be the vanilla piercing submesh that has weights.

Click Generate Data Layers, then apply the modifier.
You can now see that your mesh has weights the same as vanilla mesh:

Creating morphtargets (shape keys)

Unhide the head mesh if hidden and make sure no shape keys have value other than 0, then select Basis shape key.
Go to edit mode (TAB) and position your mesh where you want it to be. You can keep the vanilla piercing visible for reference.
I wanted mine to be a bit further back than the vanilla one, otherwise it clipped with the nostrils.

Now go through all the nose shape keys and position your mesh in the best position for each. You can set the value of the corresponding shape key on the head and vanilla piercing meshes to 1 for easier positioning (to do that come out of edit mode back to object mode) - if you do that, make sure you’re not setting any shape key to 1 on your new piercing mesh, they all have to stay 0. If creating nose piercing you only need to go through all the shape keys with nose in the name, if creating earring, go through ear shape keys and so on. No need to go through other, like for example eyes for a nose piercing.
Delete all unnecessary meshes if you have them, like head reference. Also delete the original piercing submesh, so only yours is left and rename the submesh accordingly (it should be something like submesh_00_LOD_1 and not something like submesh_00_LOD_1.005)

Exporting the mesh from Blender and importing in Wkit

Once you’re done export your mesh as gltf 2.0 with below settings. Save it over the glb exported in wkit.

If your piercing is influenced by more than 4 bones, also include this option on export.

Next import it in wkit.

Creating the mod

Add to project a morphtarget from PRC or create folder structure manually. They need to be named exactly like this, do not create a custom folder.

Now rename the morphtarget you imported from blender to whichever slot you want to use. The number will correspond to the slot. It does not matter which you use really, but if you want your mod to be compatible with any specific set of piercings made by someone else, check what slot they used and use different.
Move the file to eagul/piercingmorphs/.. (if you added to project a morphtarget from PRC to create the folder structure, delete it first, just leave empty folder before moving your new renamed morphtarget).

Now you can delete the character folders in base and install the mod.

Naming is important, your mod needs to load before PRC, so it is best to follow PRC’s naming convention: PRC_f/m_slot#.

To test your mod, set piercings to slider 12 for fV or 14 for mV and you should see your creation.

Supplement for creating piercings in non-vanilla locations

You can only export the head morphtarget as it is the only one we’ll need.

Import selected one into Blender, merge by distance, duplicate the mesh and delete all vertices from your duplicate in edit mode. This is similar to points 4-8 from the first section of the guide, except we’re working just with head mesh, not piercing meshes.
Weight paint your piercing. Since the location is not covered by any vanilla piercing, transfer the weights from your head mesh. Delete unused vertex groups (the ones that do not affect your piercing, ie have 0 weight). Since piercings are solid objects we don't want them to stretch, so go through the vertex groups that affect your piercing in weight paint mode and colour them in one sold weight colour (you can use the picker to pick one from somewhere around the middle of the mesh).

Change the path to: eagul\piercingmorphs\wa_linked.mesh for fV eagul\piercingmorphs\ma_linked.mesh for mV

If you ever need to re-export your mesh again for editing you’ll have to change this back to the original path.

Now install your mod and enjoy.

Appearances: change the looks

Changing an NPC's default appearances (and adding more via AMM)

If you want to create a custom NPC from scratch, look here.

You can find another guide about this linked on the Community Guides page (direct link)

Created by @manavortex Published December 27 2022

This guide will walk you through editing NPC appearances for Cyberpunk 2077.

If you want to create your own custom NPC, see .

It uses the following versions:

Cyberpunk 2077 game version >= 1.6
>= 8.7.1-nightly.2022-11-04
(only if you want to add new appearances) >= 1.15

Assumed skill level: You're able to read.

The .ent file

The game's first point of contact is the .ent file. You can find it by searching WolvenKit like this:

If you come up blank, try around with variations. E.g., Johnny is "silverhand", Viktor is "ripperdoc".

You don't need to add the .ent file to your project, unless you want to .

However, the file contains the path to an .app file. Find and add it to your project.

Major NPCs have their own .app files: base\characters\appearances\main_npc\.

Others are not so lucky - e.g., Mamá Welles is lobbed in with the other valentino goons: base\characters\appearances\gang\gang__valentinos_wa.app

The .app file

The array appearances will contain a list with every appearance that's defined for this NPC, matching the key appearanceName in the .ent file.

Not all of these have been "published" (as in "hooked up to .ent files"). For an example of this, check base\characters\appearances\citizen\citizen__children_mc.app

The only thing you need to care about is the components array, where you can add, remove, or modify parts of an NPC's appearance:

The names of components need to (read: "should") be unique so you can .

CDPR's style of unique naming allows us to find components and their usage across the game files, which will come on handy when we're trying to add items.

This is where the magic happens.

Changing and removing components

Change items by selecting a or a :

Remove items by deleting their entries from the list:

Animations: if you can't avoid them, copy them as well!

Anything of the type entAnimatedComponent means that components are animated. That's mostly the case for physics-enabled stuff influenced by gravity, such as coats, jackets, or long hair.

Physics gave us the atomic bomb. (It also gave us computers, but this is besides the point right now.)

Animations are usually unique to meshes on a by-pixel basis and do not react kindly to edits or swaps. (Try splitting the obi from Saburo's kimono into its own submesh if you don't believe me).

If you copy an animated component (e.g. Johnny's vest), then you need to copy the corresponding entAnimatedComponent as well, or the mesh won't move.

If you delete a physics-enabled component, you can safely delete the corresponding AnimatedComponent.

(Safely) adding components

If you want to exchange an NPC's hair, check .

The obvious thing to do if you want to add a new item is to duplicate another component and then act as if it was just another change:

And this might work. Or it might end up leaving them standing in an exploded pixel cloud. In case of animated components, editing them will almost certainly break them.

Anything of the type entGarmentSkinnedMeshComponent will not take kindly to manipulation.

In that case, you need to browse the files for any occurances of the component you want to add and copy the relevant components. For example, if you want to put Johnny into a different kind of vest, this is how you'd go about it:

Search for the mesh name of the vest that you want to use (e.g. ma_vest__high_collar*.mesh)
Select the mesh, then "find files using this": If you run into an error, make sure that you have the "Wolvenkit Resources" plugin installed!I
Find an .app file that looks promising - for example Scorpion's: Open it without adding it to the project (you don't need the file).

Save the .app file, pack your mod, and go testing!

Adding new appearances

This part of the guide requires

Adding a new appearance to AMM requires you to register it in three files:

the .lua
the .ent
the .app

If you are using HotReload, don't forget to "reload all mods" to make AMM pick up the changes in the script.

The .lua file

To tell AMM about your new appearances and make them available, you have to create a LUA file in the following folder: Cyberpunk 2077\bin\x64\plugins\cyber_engine_tweaks\mods\AppearanceMenuMod\Collabs\Custom Appearances. Let's call it AMM_JohnnyTutorial.lua.

Give it the following content:

The entity_id is unique for each NPC and tells AMM which file to load.

You can find the correct entity ID by looking at the character with AMM:

If the NPC doesn't yet exist, you can create a custom entity. For an example file, check one of .

Now, we have to hook up the new appearances.

The .ent file

Find the .ent file that you've identified in the , and add it to your WolvenKit project. Open it, then duplicate the last item in the appearances array. Now, change the new entry to match your custom appearance:

The .app file

In the app file, duplicate one of the already existing appearances, and change the name of the new item to the one you specified in the .ent file:

Congratulations — that's it! Install your mod and go testing!

Troubleshooting

My new component won't move at all!

You may have forgotten to copy the animation file. Look for an entAnimatedComponent inside the .app — they're usually called something like xxx_dangle(s) or collar.

I added an appearance, but a random one is showing when I select it

That's what happens when the game can't find the appearance you picked. You're probably trying to add an AMM appearance. Check the spelling between your lua file with the appearance name, the mapping entry inside the .ent, and the appearance's name in the .app file.

For further troubleshooting steps, see .

Your image as custom mesh

Guide to creating neon signs from 2d textures

Summary

Created by @manavortex Published August 2023

This guide uses the following tools and versions:

This guide will take you through the steps of replacing one of Cyberpunk's neon signs with a custom mesh. If you want to add custom props to the game, you can check out the corresponding after you're done with this one!

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:

Make sure that your image is as clean as possible.

Step 1: Convert to SVG

I started by following , but I'll write you a TL;DR

Open Inkscape and create a new document
Select File -> Import and import your .png from step 0
Make sure that your image is selected (click on it if you're not sure, it will have that resizing handle)

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

Step 2: Making a mesh

For this, I've originally followed guide, but here's a TL;DR for you again:

In Blender, select File -> Import -> Scalable Vector Graphic (SVG)
Import your SVG. It will show up as solid black:

With an active selection, find the curve properties panel in the bottom right (the green icon).
In the "Geometry" section and find "Extrude".
Set it to something like 0.001 — play around with it until your mesh is appropriately extruded.

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

Fix rotation: Press R -> X -> 90
Fix scale: Press S and move the mouse

Cleaning up the geometry

You will get much better results with the Blender AddOn QuadRemesher; however, after the first 30 days it costs money. You can download a trial version .

Let's reduce poly count and clean up our mesh. For a detailed guide, see , I'm going to give you a TL;DR again:

Remesh modifier

Switch to the "Modifiers" tab in the sidebar panel on the right (the wrench, below the one highlighted in the screenshot above)
From the dropdown, select Generate -> Remesh
Your mesh will be a black box now. Don't panic, we'll fix this by setting the modifier proprerties:

Setting

Value

explanation

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.

For better results, I cheated: I split off the ghosts' eyes, the ghosts themselves and Pacman, and used Quad Remesher on each of them. This guide will show you the basics, you can make prettier meshes on your own later once you got it to work.

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,

Change back to Edit Mode
Turn on X-Ray (Alt+Z) and select the shape that you want to split off
Press P -> S (Split -> Selection)

Creating a Wolvenkit project

Time to pull up Wolvenkit.

Assuming you have Wolvenkit , you can now . Let's find ourselves an in-game neon sign to replace by searching in the Asset Browser for neon > .mesh and scrolling through the entries until we find one that we like.

You can obviously use any kind of mesh or material here!

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

Decide on a mesh and add it to your project.
In the project explorer, right-click on the exported file (sex_shop_neon_sign_b.glb) and open it in the Windows Explorer. We will now overwrite this file in Blender.

Exporting

In Blender,

select all the meshes that you want included (in Object Mode)
use the to overwrite the file from the previous step.

In Wolvenkit, use the Import Tool to import sex_shop_neon_sign_b.glb. The preview in the File Information panel should update.

Assigning Materials

I'll give the TL;DR version, you should be able to follow along. If not, feel free to read up on or find us on !

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 chunk masks as follows:

MaterialEntries

Now, we register the materials:

Find the array materialEntries
Add four new entries (or duplicate one four times, or…)
Name them according to the entries in the ChunkMaterials step

LocalMaterials

… and finally, we actually add the materials.

Find and expand the array localMaterialBuffer and its child materials
Copy the second entry, sex_shop_neon_sign_emissive_red_on via right-click menu

Let's pack the project!

In Wolvenkit's top bar, select Install and then boot up Cyberpunk. Let's hit up Jig Jig Street to look at our sign…

Please remember that before sharing your custom neon, you have to change the paths, or you'll conflict with the next modder! You can find a full guide on the fastest way to do that .

Recolours and Refits

How do I change this item?

Summary

Created by @manavortex Published August 20 2023

If you just want to change the emissive colour, check

This will guide you to the process of making your own custom edit of my . It has several sections, which you can find linked below (but please check the wiki's navigation tree anyway).

Assumed level of skill:

You know how to read — if you can read and struggle with this guide, then it's not yet good enough. Please reach out to on the so that I can improve it.

The steps in this guide teach you how to recolour or refit almost every item in Cyberpunk. Keep reading!

Time to complete:

Setup:
- If Wolvenkit is already set up: ~ 5 - 30 minutes for MLSB
- Full setup: 30 minutes to ~2 hours (most of which you can spend afk)

If you are editing modded items, you should seek permission first. For your personal use, you can (legally) do what you want, but making mods takes time and effort.

Please respect mod creators' wishes in that regard.

You can check find the standard permissions on a mod's Nexus page, Description tab, under the

Tools and versions used

Skipping and skimming

TL;DR

Do not skip or skim anything. Also, if you find a TL;DR block, this sums up all sections until the next header (in this case, until ).

I'm writing these guides with the minimal amount of fluff and no background information — that will be linked, but not included, which is the opposite approach from the rest of the internet and the .

The sections are annotated with a rough estimate of how long a total newbie would need. They're guesses, so if you're slightly off, don't worry. If you're wildly off, you might want to get in touch.

If you skip or skim in these guides, you will get in trouble. Unless a section's first paragraph offers you to read on somewhere else, do not skip. Don't skim and do ok it was something like this. You're supposed to stick to the road, where you won't run into monsters, and the guide will not tell you what to do if you encounter any.

The bright side of this approach is that you don't need to understand what you're doing as long as you do what the guide says.

Links

You will find two kinds of links. It's usually clearly annotated which is which.1

The first will help you do something, leading to other guides on this wiki. They usually link the specific section that you need to complete. Please be thorough here as well, as the rules above apply.

The second contains background information and references (like "here's how this can look"). They are optional, you can browse or ignore them, and skim all you want.

Overview

To do this, you must have MLSetupBuilder running at least minimally. If you don't, then please complete the section "" below.

This guide will walk you through the following steps

Doing the
- If you already have MLSB working, please read !
Creating a with the right files

R&R Step 0: Setup

This section will link you to guides for installing Wolvenkit and MLSetupBuilder, which allows you to use the cool preview of which parts of an item you're colouring.

You will also be told how to download and extract the files for the .

If you have done both, you can skip it and proceed with .

: You need Wolvenkit on your computer, and you need to be able to start it. Follow the steps in the linked guide until you can open the program.
Follow the steps under until you reach Configure MLSetupBuilder.
Make a decision if you want to use these features independently of the Netrunner suit

Netrunner Suit Preview

In this step, we'll enable custom previews by downloading the files I've prepared and extracting them into MLSB's depot. It should take you no more than five minutes.

The Netrunner suit uses custom multilayer masks. To get an accurate preview in MLSetupBuilder, you need to complete this section.

You can make recolours blindly by just tweaking the colour values without knowing which parts of the mesh they affect, so you can skip this step and ,

MLSB's Uncook Folder

This is where MLSB (and Wolvenkit) store the files they extracted.

Go to Nexus page. You can find two files here, one with the modded multilayer masks, one with the original ones
Download the archive with the modded mlsetup
Extract the entire archive into MLSB's uncook folder, or drag and drop the base

Open the Model Library and search for t0_005_pwa_body__t_bug.

Click on the entry. If a 3d model shows up, you're done here and can go on.
If no model shows up, select View -> Logs from the taskbar. It will complain about files being in the wrong spot. You need to make sure that the files you downloaded in Step 1 end up in exactly these folders and none other. If the file paths are ending in .dds, open MLSB's preferences and configure it to use pngs instead.

Install the mod

The tutorial assumes that the mod is installed manually rather than via Vortex. If you have already done that, no sweat — it means that a few files might be in different places, and all this is annotated.

If you don't want the extra complication, simply deactivate the mod in Vortex and follow the steps below.

TL;DR

Extract the downloaded archive directly into your Cyberpunk 2077 directory and go to .

Detailed instructions

Download the mod from
Open the downloaded .zip file. You will see something like this:

These files need to go directly into your Cyberpunk 2077 directory, where they will merge with the existing folders. This is the same directory that contains REDprelauncher.exe.
Extract or

OK, what now?

Now that you're all set up, we'll .

Poses/Animations: make your own

Make your own pose, then import it into photo mode

Summary

Created by @manavortex Published September 2023

This guide will teach you how to create a custom pose in Blender and import it into the game via Wolvenkit.

You will make a photo mode replacer - your custom pose(s) will replace to existing vanilla pose(s) provided by Photo Mode in the game.

This is a prerequisite for pose sets for both and .

Check the section for more general knowledge.

It has been tested with the following software versions. Install these or newer.

We all stand on the shoulders of giants: this process has first been documented by , who also provided the . Thank you!

Skipping and skimming

This guide will include the minimum amount of fluff and will link background information rather than giving it.

For that reason, you shouldn't skip or skim unless the section tells you that it's optional.

Any links in the text will either

provide additional information which you do not need to complete this guide
lead to step-by-step instructions for any given process

Follow them if you want to learn more, or if you are unclear on how to complete the current step, then come back here.

Step 0: Preparations

Your Wolvenkit project

To import your pose into Cyberpunk, you need a Wolvenkit project.

. Give it a name that you can identify later.
Now, your project needs the photo mode .anims file appropriate for your pose(s). The table below shows your options. for the correct photo mode file and add it to your project:

body gender

file

Export the file(s) to GLB via . Default settings are fine. (We will overwrite these glb(s) with our new pose, then use Wolvenkit to merge them into the existing .anims file.)

You can not move these .glb files. Wolvenkit needs them to stay where they are so it can splice your new animation into the existing .anims file.

Download the template files

Download the animation template(s) for your rig(s):

for single characters: from
for multiple characters: of Angy's templates

Move/copy them somewhere, then open the one you want in Blender.

I'll be using Angy's template for female V, because ~~the other one doesn't exist~~ I happen to have one of those.

Step 1: Posing the mannequin

This step will happen in Blender.

If the written instructions aren't clear enough for you, check the screenshots below them.

Open up the file
Select the armature by clicking on one of the bones in the viewport (the red circle on the screenshot below). They will be highlighted if you did it right.

Switch the viewport to Pose Mode in the dropdown menu at the topleft of the viewport, immediately below the "File" and "Edit" menus. This will turn the armature red.

Now, you need to create your pose. Before you do that, check the box below:

Nice-to-know about creating poses

General

The real human skeleton changes pose only via bone rotation — moving bones leads to dislocated joints. Do not move bones.

Tooling

As of today (September 2023), we can only create poses and animations by adjusting each bone by hand. This is how:
1. Select a bone by clicking on it (it will appear highlighted)
2. Rotate the bone by either

Now, , then proceed to the next section.

Step 2: Creating the animation

You now need to create an animation that Wolvenkit can add into the existing file. For that purpose, we will create a nonlinear animation in Blender.

In the panel at the bottom, click on <No Action> to select it.
In the Armature -> Animation Data panel, click on the New button.

Now, we need to add keyframes, one for the fallback position and one for the pose.
1. Make sure that the keyframe selected in the animation timeline is 0 (see "Animation Timeline" screenshot below)
2. Click into the main viewport next to the armature

Now, rename both your NLA strip and your animation to idle_stand_01. This will overwrite the "Tabula Rasa" animation. (Find a list of animations and their associated names .) If you aren't planning on replacing the in-game idle poses (i,e., Tabula Rasa), it is still required that your NLA strip and your animation have the same name.

This is important!

This step is crucial. If you don't do this, then Wolvenkit won't import your animation.

The names must be the same, and they must match the name in your .anim file.

Go back and read the warning box under step 4.
Double-check the names. (Yes, this is that important)
Optional: To add another pose, you can go back to Step 1, then rinse and repeat.

This will open a file picker. Do the following things:
- Check the As Photomode Pose box on the right
- Navigate the to the path of the file you exported in the and click on it to overwrite it

Now it's time to import the file back into Wolvenkit.

Step 3: Importing and testing

Switch back to Wolvenkit and open the .
Click on photomode__female__idle.glb to select it and open the import settings panel.
In the panel on the right, change Target File Format

Hit the Import Selected button.

Youc an now test your mod: Install your Wolvenkit project by clicking the green button on the taskbar, and launch the game.

If all went well, entering photo mode will show your new pose.

Troubleshooting

My pose doesn't import!

I have no idea how to tell you this, choomba, other than stressing thrice that it's important and putting a big red box, but the NLA strip and the animation must have the same name. Go back to "" and double-check. The animation might have trailing numbers, e.g. be called photomode__female__idle.001, that will already do it.

Very funny, but it wasn't that

If you're really 100% sure, then you might have a broken NLA strip. That happens sometimes — simply recreate it:

If your armature isn't selected anymore, click on it to select it
Switch into Pose Mode
Press A to select all bones

Nope, still borked

We're reaching the end of the rope here. Go back and . If that wasn't it,

create a new copy of the .blend file you downloaded (but keep yours open)
In your old Blend file, repeat 1-4 of the
In your new Blend file, repeat 5+6 of the

R&R: Your own Wolvenkit project

Summary

Created by @manavortex Published September 30 2023

This page is a part of the Recolours and Refit guide and will walk you through the process of creating your own Wolvenkit project. Here, we will:

create our project
solve load order via project name
get the files from the mod that we want to change

Time to complete:

~30 minutes for the tutorial
once you know how it works: < 5 minutes to create a project and add the correct files from a mod

The principles you learn here are universal. Once you have understood how this works, you can recolour and refit any Cyberpunk item.

If you are editing modded items, you should seek permission first. For your personal use, you can (legally) do what you want, but making mods takes time and effort.

Please respect mod creators' wishes in that regard.

You can check find the standard permissions on a mod's Nexus page, Description tab, under the

Prerequisites

The links in the check list go to more detailed guides. For the exact things you have to do if you can't check the boxes, see the previous section of the guide ->,

You have and configured
You have and
You have

Why do I want a Wolvenkit project?

To edit an appearance, you need to make a mod, and for that, you need a Wolvenkit project.

As soon as you have changed the first file, you can and check if it is working.

There are two ways you can go about the process: do either a full repack of my mod, or create a compatibility archive. This section will explain the differences, the will walk you through the process of setting things up for either of those options.

Full Repack

Compatibility Archive

Once you've made your decision, you can proceed to the next section and . If you aren't certain yet, you can keep reading to find the pros and cons listed more clearly.

A full repack

Your mod completely overwrites the original mod, creating your own local copy.

I do this with mods for my own personal use — I don't care if the original mod is updated, my character will only ever wear that one custom variant.

Pros:

Anything I do to the mod in the future won't affect you

Cons:

Anything I do to the mod in the future won't affect you
If you update or reinstall the original mod, you will overwrite your changes
If you're anything like me, you'll lose track of which files you have or haven't modified

A patch

You'll create a compatibility mod that will exist together with the original.

I do this with mods where I only want to change little things, e.g. removing a submesh. When the original mod updates, I can update my compatibility mod in <5 minutes.

Pros:

You can still update and reinstall the original without overwriting your changes
Your mod has only exactly those files that you've actually changed

Cons:

You have to keep the original installed
Only works together with the original
Updates on the original mod might necessitate an update on your part

This is where you pick any of those options.

Creating your Wolvenkit project

The .archive that Wolvenkit packs for you will have the same name as your project. Stick to the recommendations in Step 4, or read the expandable box to learn more.

From Wolvenkit's menu bar, select File -> New Project
Fill the fields in the dialogue:
Creation Location: This is where your loose files are going to live. From here, Wkit can pack it as a mod and install it to your game directory. Select any folder outside of your game directory.

Why do we name it like that?

In Cyberpunk, any file can only be modded once. When something has altered a texture or mesh, everyone else can get lost.

At some point during start-up, Cyberpunk 2077 will open up the mod directory, grab a list of all mods, and load them. Naturally, it will start at the top of that list, so your mod needs to be further up than the original.

We achieve that via file name - hence #4 on the above list.

Add files from the mod to your project

This part will show you how to add files to your project (you can't change them if you don't).

Prerequisites

You have installed the mod from .

Why are we doing this?

Skip to if you don't care.

To alter an existing item, you need to create a mod that will overwrite the original resource. This mod must modify that file first - which is where the load order comes in.

Do not move or rename any of those files, they need to be exactly where Wolvenkit puts them.

The section

describes the process of
tells you which files to use it on for

For the general documentation on adding files to your project, see .

How to export files

In Wolvenkit, open the Asset Browser (pinned at the right-hand side by default), and toggle the switch to "Mod Browser".

Find _ArchiveXL_Netrunner_Variants, then click on it. It will be near the bottom of the list, together with your other mods starting with _
You can now browse the archive, or use (next to the big red toggle button) to find files inside the archive by searching for archive:ArchiveXL_Netrunner.

Selected files: full repack

If you want to overwrite the complete mod, run this query in Wolvenkit's Mod Browser:

Add all files to the project — everything.
Now, switch the Project Explorer to Resources. It will be empty; you have to create the following folder structure:

Find and copy the following files from your game directory into the subfolders of resources (there'll be a screenshot in a minute)

_ArchiveXL_Netrunner_variants.yaml

From: Cyberpunk 2077\r6\tweaks\manavortexTo: resources\manavortex

ArchiveXL_Netrunner_variants_atelier.reds

From: Cyberpunk 2077\r6\scripts\manavortexTo: resources\r6\scripts\manavortex

_ArchiveXL_Netrunner_variants.archive.xl

From: either vanilla install: Cyberpunk 2077\archive\pc\mod REDmod: Cyberpunk 2077\mods\RANDOMNUMBER_ArchiveXL_Netrunner_variants\archivesTo: resources

Selected files: Emissive

TL;DR: via search browser query

Add all those files to your project, then skip the rest of this page and go to

Selected files: Recolour

All material colour definitions are stored in .mlsetup files, which we'll be editing in .

TL;DR: via search browser query

File structure explained

All material definitions in this mod are in the folder manavortex\torso\netrunning_suit\textures
The first level subfolders group the .mlsetup files by material (e.g. nylon, snake, other)

If the names aren't clear enough or if you can't guess which file you have to take, you can open netrunner_recolours_translation.json in Wolvenkit:

Expand the root node and then the entries node. By selecting a node, you can see the translation text. The field for secondaryKey contains the colour variant, which corresponds to the mlsetup file name:

Selected files: Refit

For a refit, you only need two files (one if you don't care about the emissive properties):

female body gender

mesh

path in files

male body gender

mesh

path in files

Simply add both files to your project, then hit up the section to get them fixed.

OK, what now?

Depending on which files you added, you now proceed to the next guide:

NPV: Preparing the head in Blender

Step 1: How to generate your V's custom head mesh

Summary

Created by @manavortex Published May 13 2023

This page is a part of the NPV guide. It will show you how to create your V's head in Blender.

Prerequisites

You have downloaded the prepared Wolvenkit Project from
You have installed (confirmed working on 3.5.1 and 3.6, should work with >= 3.4)

In this section, we will be moving/deleting files. You can complete these steps in Wolvenkit or in the Windows File Explorer.

It's important that you leave the file structure as it is. Moving or renaming files will confuse Wolvenkit and break the example project.

The final section of tells you how to safely move files.

Step 1: Getting head

Open the head folder in your project's archive section.
1. Optional: Be confused and/or panic about why there are over 9000 files.

It's too many of them!

True! That's because I included all options for any given V. But don't worry: after you have deleted the ones that you won't be using, you should be left with a maximum of 13 files for female V and 14 files for male V.

I have included all meshes and morphtargets from the game files. We'll now thin out the options, deleting those parts that your NPV won't be using.

Deleting unused files: the convenient option

The best and most convenient tool for the job is . It will give you a list of files that you need to keep.

The list will give you a number of Source Mesh entries like h0_000_pwa_c__basehead.mesh.

You need to keep these files inside the head

What the actual fuck are all these files?

If you don't care and just want to know what to delete, go .

Meshes vs Morphtargets

The .mesh files are the 3d files making up your NPV's head. I've taken them from the game files and prepared them for you (by making them use the player animations and -expressions).

The .morphtarget files are the character creator options (a direct game export). You can safely overwrite them with the most recent version by searching Wolvenkit for the file name – you need to put it into the correct folder, though, or it won't be picked up by the scripts.

We only need the .morphtargets to generate the actual meshes by duplicating the character creator process.

Okay, and all those numbers?

The different variants in the character creator correspond to the different meshes. For example, if you select cyberware 3 in the character creator, the mesh that will get loaded is cyberware_03. Not so difficult, is it?

Here's what the prefixes mean:

Finding the right piercing

If your V isn't using any piercings, you can skip this step and go directly to .

In the files, you will see four files for jewelry:

… none of which is your V's exact piercings. Instead, there are full sets of jewellery, most of which will be hidden.

You have to look at the meshes and find the file that includes your set of piercings. We'll go about hiding the excess in one of the later steps.

Deleting files

Number in file name <=> Number in character creator

Do not delete any files if you're (Ignore this hint if you don't)

Many of the files are variants and your V will be using one or none of them. That means you have a bunch of files to delete. If you have chosen above, you should already have a list of files that you need to keep. Otherwise, the table below should give you some oversight.

When deleting files that you aren't using, you need to remove both the .mesh file in the head folder and the .morphtarget file in the head/morphtargets folder.

The following table will show you examples on what to keep (as in, you delete everything else):

Body gender/variant

Files not to delete from variants

Expected result

After deletions, both head and head/morphtargets should hold only the files that your V is actually using.

For a list, see the .

Once you're done, you should have this many files:

Step 2: Exporting head

Now, we will export all .morphtarget files from Wolvenkit so that we can edit them in Blender. You will complete most of these steps in Blender, only the import/export happen in Wolvenkit.

Find the Export Tool (Tools -> Export)
1. To filter, click into the empty row under "name" and write "morphtarget"
2. Check the box in the header to select everything

Switch to your project's raw folder or Wolvenkit's raw perspective. You will find the entire file structure mirrored there.
In head folder, find the file head_import.blend. This file is a utility file which will automatically import and export the files for you. For that reason, it needs to be in a certain relative path.

If you have already changed your structure (by re-naming your folders), you need to make sure that head_import.blend is in the folder head right next to the folder morphtargets.

Open it in Blender. It will take you to the scripting perspective, where you'll see something like this:

Press the play button.
The script will now import a bunch of armatures from the morphtargets folder. You will see them showing up in the topright corner (see the next screenshot under 7. for how it should look)
Switch to the next script in the file, but don't run it yet:

If you've been previously afraid of scripting: This is a good place to stop! :))

Find line 26 and following in the script, and alter the values to those of your V (which you get from the character preset, see for further explanation).

You don't need to select the eyebrows here, as those are "painted on" later via mesh appearance. The mesh only needs to have the right shape, which is what we're doing here.

After you've changed the values to those of your V, click the "play" button again. This will apply the morphs to your V's face:

Some shapekeys don't correspond 1:1 with their numbers in the character creator. If a part of your shape is shaped subtly wrong or looks weird in the game, undo your changes (Ctrl+Z), add or subtract 1 from the corresponding shape key, and run the script again.

Step 3: Importing head

Unless you are editing original V, start by deleting the morphtargets from the template file — we don't need them anymore.

Remove the entire folder, both from raw and archive. From now on, it's meshes only!

Exporting from Blender

Now that your head looks the way you want, it's time to run the final script, which will export your changed head to .glb for you:

This will overwrite already existing files, leaving you with a set of import-ready mesh files.

Now it's time to get them back into Wolvenkit.

Find the Import Tool (Tools -> Import Tool)
Click "Import All"
You're done!

You can now start the game and look at your V's face to make sure that your head and eyes are showing up correctly . If it does, read on how to . Otherwise, keep reading.

Can I have that with textures?

Yes, you absolutely can! Once you have imported them back into Wolvenkit, you can use the With Materials option and the Wolvenkit Blender Plugin to get a fully textured and shaded set.

Step 4: Troubleshooting

Optimally, this process just runs with no hitches. However, during beta testing and troubleshooting, people ran into a few issues, so I'm listing them here.

Blender import errors

If you get an error within Blender, e.g. something like AttributeError: 'NoneType' object has no attribute 'name', then something is wrong with your install or you are using the wrong version. Reminder: This has been tested with 3.5.1, but anything >= 3.4 should work.

The piercings are in the wrong position!

The problem went away after the person having it upgraded Blender to 3.5.

V was imported, but the textures are all wrong!

This happens when the UV maps are flipped. 8.9 doesn't implement that feature yet, so you might have to use a of Wolvenkit — the Nightly from is currently stable.

Alternatively, you can use the last script in the file, which will attempt to flip the UV maps for you. It might have an offset, though.

V was imported, but they're unsettlingly, subtly wrong

If you had the example project lying around for a very long time, please try and redownload it (), as the first version had been using an NPC animationgraph for facial expressions.

If that's not it, then you ran into the shapekey offset issue: ssome shapekeys don't correspond 1:1 with their numbers in the character creator. If a part of your shape is shaped subtly wrong or looks weird in the game, add or subtract 1 from the corresponding shape key, and run the script again.

Custom props

How to create custom props to use with AMM or sector editing

Summary

Created by @manavortex Published April 2023, updated July 2023

This guide will teach you how to create a customizable by chaining an .ent, an .app, and a .mesh file with multiple appearances.

For a guide on how to make meshes out of 2d textures, see .

Its focus is on the file structure and the relations between the files. If you want more hands-on tips what you can do with materials, check or .

It uses the following versions:

Cyberpunk 2077 game version 1.6.1 (DLSS)
>= 8.8.1
(>= version 2.1, anything earlier won't have customizable appearances)

Level of difficulty: You know how to read.

Setting up the project

This section will tell you how to get the files, then give you an of what they do and finally show you a on how they hang together.

Create a project in Wolvenkit and give it a name. This will later be the name of your archive file.
Download the AMM prop template from or from manavortex's , or download the complete for Wolvenkit. It will have prepared files, which is faster than doing everything from scratch by yourself.
Prepare your Wolvenkit project and make sure that you have the following files:

The first part of the structure is up to you, although for the sake of the tutorial you might want to stick to it. There's a section later on .

The second part (under "resources") is where AMM will look for custom props. You can't change it other than creating subfolders under "Custom Props".

Explanation: what did you just download?

This section gives an explanation of the included files, explaining the difference in file structure between props with vs without variants.

If you don't want to know this, you can skip ahead to to get crackin', or check the to see how the files connect.

LUA file

This file registers your prop with AMM. File content looks like this:

Without a lua file, AMM (as of version 2.1) won't be able to spawn your props.

Here's what the lines do:

When you edit the .lua, it's usually enough to reload all mods in CET.

Entity file

Defined in your LUA file, this file holds the game entity that AMM spawns when you click the button. There are two ways of using entity files:

Mesh entity (the legacy version)

One entity file per variant. The props will not have appearances — AMM's prop browser has one entry per entity file (e.g. cube_black, cube_white, cube_glowing).

Fun fact: The cluttered prop browser annoyed manavortex so much that she joined the AMM developer team, helped Max implement the alternative workflow described below the picture, and wrote this guide!

It was bad!

You add props by putting meshes directly into the components array.

Root entity

One entity file per prop, one entry in AMM's prop browser (e.g. cube). After spawning it, you can toggle its appearances (white, black, glowing) the same way you do it with NPCs.

If you have , then this will be familiar to you. If you haven't, please ignore the link and keep reading — this is the simpler version!

Instead of adding items directly via the components array, we link appearances to an .app file. The only component we keep in the root entity is the targeting component for the CET cursor: this way, it will be added to each appearance in the .app file.

Appearance file

This file holds a list of appearances. Inside each appearance, you can define any number of things to be loaded (components) and specify or override their behaviour.

We will only use entPhysicalMeshComponents, and they must be named amm_prop_slot1 .. amm_prop_slot4 if you want to enable scaling.

If you have more than four mesh files assigned to your app's components, the prop will no longer be scaleable (as of AMM 2.1). You can get around this limitation by making meshes with more submeshes instead of having individual files.

template_textured.mesh

A pre-configured mesh for a textured material. Uses the following files in the subfolder textures:

template_01_d.xbm: A diffuse (albedo) map, colouring the mesh
template_01_n.xbm: A normal (bump) map, adding depth to the object.

If you stick to this naming convention and have your filenames end in _d or _n, Wolvenkit will recognize and identify the correct settings for image import.

You can learn more about textured materials . This is not necessary for the purpose of this guide.

template_multilayered.mesh

A pre-configured mesh for a multilayered material. Uses the following files in the subfolder textures:

6_layers.mlsetup: A with colour properties
6_layers.mlmask: A , determining which parts of the mesh are affected by which layer of the mlsetup. In this case, it just contains six blank layers.

You can learn more about multilayered materials . This is not necessary for the purpose of this guide.

If you have downloaded the example Wolvenkit project, you can now install it and launch the game, seeing everything in action.

Diagram

Okay, now that we've gone through the theory, let's have a quick overview how everything hangs together:

Without variants

With variants

Creating another prop

This step is optional. If you just want to see how this works, you can pack your project with Wolvenkit and search AMM for "tutorial item". However, assuming that you actually want to make cool things, you will be doing this a lot.

If you want to create another prop, here's the fastest non-script way to go about it (tried and tested by manavortex):

In Windows Explorer, duplicate the template folder
Rename the new folder (template - Copy) to the name of your prop (e.g. baseball)

Now you can launch the game and check your prop. If everything went well, you should see something like this now:

If not, it is time to hit up the .

The final touches

Before you can share your custom props, you have to change the folder structure and file paths. Otherwise, two people overwrite tutorial.lua, and one of the mods stops working.

You can find a step-by-step guide on the process .

Troubleshooting

This section will only cover troubleshooting steps for this guide. For anything related to mesh imports, see . For general 3d model troubleshooting (including import errors), see .

My prop doesn't even list in AMM!

The problem is in your .lua file. Use to check the syntax and make sure that there are no errors - usually, it is missing/extra commas and/or missing/extra braces.

If the syntax is okay and your prop still doesn't show up, double-check your category and make sure that it is one of the existing ones.

My prop won't spawn!

... and I can't target it!

AMM can't find your .ent file. Make sure that your .lua points to the correct path in your archive (right-click -> copy relative path and paste it to your lua file.

Make sure that you don't delete any quotation marks or commas while you do that. If you're unsure, you can double-check .

... it all looks good, but there is no prop!

Toy around with the scaling. Sometimes, your prop doesn't show because it's the size of Johnny's ego and hovers somewhere above your city block – or the opposite, it's microscopically tiny. Don't be afraid to change it by the factor 10 or even 100 and see if that does anything.

If that's not it and if you have a customizable prop (with a root entity), try adding an appearance default to the mesh. The game will fall back to that one if there are issues with your custom appearances.

My prop spawns, but something about it is weird!

In general, your answer is probably in the guide on , section 2 () – check that guide's .

Archive XL: Item structure explained

More detailed explanations for the guide "Adding new items"

Summary

Created by @manavortex Updated June 10 2023

This page is a part of the Adding new items guide and explains how the different files interact with each other.

If you have come here from the main page because you want to change the existing files, search for Making changes in each section. To add new appearances, the following files are relevant:

Unless stated otherwise, any linked resources are optional and might not even be related to this exact guide.

Structural files: telling the game about your mod

We need four files to tell the game about our new items:

the .xl file, which tells ArchiveXL which files to register
the .json file with the translations
the factory.csv, telling the game about your custom files

The .xl file

This file will be in the same directory as your mod's .archive file. It lets ArchiveXL register the (my_shirt_factory.csv) and the (translation_strings.json).

You usually touch this only once, unless you want to add more factories or translation files.

.xl: Making changes

You only need to change this file if you have changed the factory's file path (moved the file) or want to add a second factory file (there is no need to, though).

The .json file (custom texts, i18n)

This is the localization file for language-specific entries (green boxes on 's screenshot). If no entry for a language is defined, then the English one will be used.

An entry will look like this:

If you don't need a male-specific translation, you can leave it blank — by default, femaleVariant will be used.

.json: Making changes

You need to change this file every time you want to add a new text entry to your mod. The easiest way to do this is by duplicating an existing entry.

The .csv file (the factory)

The factory connects your .yaml to the corresponding rootEntity.ent via entity_name.

When reading your .yaml file (e.g.tutorial_my_custom_tshirt.yaml, ), the game will find entries like this:

The csv file is where ArchiveXL will find an entry with the yaml's entityName in the first field. It will then check the corresponding for an appearance with the name in appearanceName.

Making changes

You only need to change this file when

you move a root entity (update the path!)
you add a new entityName — for example, a second t-shirt that you want to have its own root entity.

The control file: yourModName.yaml

When editing this file, please keep in mind that indent is important!

The first line of each block must not have spaces, the blocks below must have the same amount of spaces. More spaces means more nesting.

Making mistakes here might break your entire mod, so if in doubt, run your edited file through an .

This file controls the adding of items to the game. An entry looks like this:

The entry above will let you add the item via Game.AddToInventory('Items.my_custom_shirt_redwhite')

Four mappings take place here:

entityName: Points to the (see documentation there as for what it works)
appearanceName: In the specified in the factory, it will look for an appearance by this name.

The appearance name will only be considered up to the first . If you want to know what those pesky & things are doing, read up the corresponding documentation.

You don't need to know this unless you want to add variants for different genders or camera perspectives: we're avoiding them by puttingappearanceSuffixes: [].

displayName/localizedDescription : In the translation_strings.json, find an array where the value for [3] (the last entry) is identical to this key. Then, check which gender V has, and display either femaleVariant or maleVariant.
icon:

What is it, precious? The $base parameter

$base defines which slot the item will use. For the full documentation, see "".

The inherited properties can cause problems (see "" for more detail).

You don't need to know this unless you want to add variants for different genders or camera perspectives: we're avoiding them by puttingappearanceSuffixes: [].

.yaml: Making changes

You need to touch this file every time you want to add a new item (or when you want to change an existing one). It is easiest to duplicate an existing entry.

If you want more than just the base properties, check the documentation for .

The game files

Now that we're done with the base structure, we can take a look at the game files. Like for any of the vanilla game items, we have four of them. This guide will only hold information that's directly relevant to adding item, but in the individual sections below, you will find links to more documentation about the files.

With ArchiveXL >= 1.5, there is a new way of making these connections, saving most of the work of making many variants. You can still complete this guide and then see the documentation for dynamic loading .

If you want to do more than 5 variants (for both body genders and camera modes), that approach is strongly recommended. Since there isn't a detailed guide yet, you can find us on in the #archive-xl channel.

appearance.app
mesh_entity.ent

Overview

This is how the files connect to each other. If your head explodes now, don't worry: it's not as complicated as it looks, and the item addition guide will walk you through step by step.

root_entity.ent

Full documentation of the root_entity is on its own page.

Understanding this is not necessary for the purpose of this guide.

The entry point from your yaml, this file is a glorified lookup dictionary: for any appearanceName, it will specify an .app file and the name of an appearance in the .app file.

An entry looks like this:

If you don't know what this means, skip it and wait for the full step-by-step guide!

For using , you only need one appearance here, which must match the field appearanceName in the .yaml up to the variant separator ! Make sure to add the DynamicAppearance tag here.

Suffixes

The root entity's name field is where you would put suffixes for different appearance variants.

You don't need to know unless you want to make variants for different genders or camera types. In fact, you will want to skip this until you have a confirmed and working mod!

To disable them, each entry in your contains the following line: appearanceSuffixes: []

Root Entity: Making Changes

When you change the path of this file, you need to adjust the path inside the .

Adding a new appearance:

Expand the list appearances and duplicate your already working entry.

Change the following fields: appearanceName => everything before the & must match appearanceName in your *.yaml name => must match the name you're going to put in your app.app

Example:

old (copy):

new:

You do not need to change the appearanceResource.

mesh_entity.ent

For experienced modders

This file replaces the component array inside the .app!

Check for how to find the right mesh entity for each equipment slot.

This file holds a collection fo components that determine how our equipment item behaves and moves. Each kind of equipment has different types of components, which is why you need to pick the for each equipment slot.

Would you like to know more?

Full documentation of More intel on

Understanding this is not necessary for the purpose of this guide!

By bundling them in this file, we save ourselves a lot of copy-pasting inside the .app file. The only component we actually need to change is the one with "Mesh" in its name, typically entGarmentSkinnedMeshComponent:

The component's name will be used in appearance.app's materialOverride array (see )

When changing component names, you want to leave the (t1_) in place — the game needs them to calculate collisions!

If the text in this box tells you nothing, just ignore it for now

If you're using , you can use property interpolation in paths. For example, *p{gender}a will resolve to pwa or pma, based on V's body gender. Read more about this on .

Mesh Entity: Making Changes

When you move this file, you need to change the path inside every appearance inside the . file.

Otherwise, you only need to touch this file if you move the .mesh file.

appearance.app

Contains a list of appearances as mapped by . Each of the appearances will load mesh_entity.ent via partsValues and specify

For experienced modders

The .app file's component array should be empty: this is not an NPC appearance! :)

An entry will look as follows:

partsValues will define what file(s) to load (as a list of components), while partsOverrides tells the which appearance to use.

For ArchivXL >= , appearance overrides can understand the following variables for meshAppearance:

If you don't know what this means, skip it and wait for the full step-by-step guide!

For using , you only need one appearance here. In this case, components will be ignored — make sure to put them all into your mesh_entity!

Appearance: Making changes

When you move this file, remember to change the path inside the root_entity.ent

You need to touch this file every time you add a new appearance:

Open the .app file and expand the list appearances.
Duplicate an item and select the new one.
Change its name to the one you just defined in the .yaml (black_blue_appearance_name)

You can leave partsValues alone - this just points at the file that loads the mesh, and you've already set it up above when setting up the file.

Mesh

The mesh file maps materials to appearances. To find out how exactly it does that, find the on the mesh wiki page.

Would you like to know more?

#appearan

The documentation for .mesh files lives on their own page!

For our purposes it's enough to say that you can define your individual appearances here.

Mesh: Making changes

Find the array appearances and open it.
1. Duplicate any meshMeshAppearance.

For further information and guides, check or see .

The final result

This is how everything plays together:

Textured items and Cyberpunk materials

Importing textured items (and creating an AMM prop set in the process)

Summary

Created by @manavortex Published February 11 2023

This guide will walk you through importing 3d objects into Cyberpunk 2077, which can then be spawned via Appearance Menu Mod.

It uses the following versions:

Cyberpunk 2077 game version 1.6.1 (DLSS)
>= 8.8.1
(version 2.0.2, but pretty much any version will do)

Level of difficulty: You know how to read.

If you only want to know how to apply Cyberpunk materials to parts of your mesh, check "" below.

For a guide about changing materials, check

If you want to understand how material loading works, check the .

You can find explanation and documentation about materials .

Where to find models

You can find many free 3d models across the web.

For game design or rendering, usually textured:

For 3d printing, usually not textured:

You can also search Google for "thing_I_want free 3d model" or "thing_I_want free <format> file" (<format> = STL, OBJ, FBX), or check or the pages on .

Setting up the project

This section is already covered in the guide for , using the source folder variant, or directly download and extract it into your Wolvenkit project.

Optional: Complete the section from the custom props guide, or alter one of the two existing template items.

This guide will assume that you are editing template_no_variants.mesh, as our focus is on mesh import and material assignment. You can delete the folder amm_props\template, since we won't need it.

Delete obsolete files (Windows Explorer or WKit):

amm_props\template
amm_props\template_no_variants\template_no_variants_multilayered.mesh
textures\6_layers.mlmask

Importing a mesh

Step 1: Exporting

The first step to importing a mesh is exporting a mesh, since the import needs to overwrite already-existing files.

In Wolvenkit, open the Export Tool (Tools -> Export), and export everything in your folder: the mesh(es) you want to use and the textures.

This will create the following files under the project's raw section:

Step 3: Importing

Optional: Download - I have prepared it for import. It contains both the original glb from sketchfab and the version I prepared for import:

After you have exported the files from Wolvenkit, use the Windows Explorer to overwrite them with the files that you want to bring into the game. They need to have the same names!

Use baseball_02_d.png, as the other one doesn't have transparency.

The import/export process has . There's also a if you're stuck.

Now that all files are in place, open the Import Tool in Wolvenkit (Tools -> Import), and re-import the files. The Wolvenkit preview should show your new imported mesh.

The next step is to to the object.

Wait, where did Step 2 go?

Good! You've been paying attention! Step 2 is to prepare the downloaded 3d asset to work with Cyberpunk. Depending on your target file, this can be any level of difficult, but the steps below should be enough for most meshes.

Step 2: Processing the downloaded mesh

All of these steps will be taking place in Blender.

The files you download will have all sorts of structures. In the end, you want to end up with a flat hierarchy of object(s):

LOD_1 indicates the level of detail, whereas the submeshes need to be numbered explicitly (or Wolvenkit will number them for you, which messes up the material assignments. You'll want to avoid this).

The easiest way to get there is by running (source: manavortex's github) in Blender after import: - Switch to the "Scripting" perspective - Create a new file - Paste the contents of the script into the file - Hit the "play" button

A mesh that I imported with 9 simultaneously visible submeshes made the game crash with a likelihood of ~ 80% when I spawned or de-spawned it (scaling was fine). You might want to create two separate files if you have too many objects.

Since it clearly works for e.g. the body mesh, make of this what you will.

Submesh by material

Sketchfab meshes often use dozens of submeshes, but we want to split by cyberpunk's logic:

Every submesh can have its own material assigned in the mesh, and can be hidden or displayed via chunkmask. This is how you assign Cyberpunk materials to parts of your imported asset.

I've always found it easiest to join all meshes into a single one:

In Object Mode, select all meshes but one
Select the last mesh
Press Ctrl+J to merge everything into that last mesh

This will let us assign one material per "section" of your mesh.

Especially when exporting meshes from sketchfab, there are often duplicate materials. Feel free to fuse everything that you want to e.g. slap black plastic on.

Splitting off submeshes (mildly advanced)

I usually join everything into one object that'll have the same material in the game, unless I want to hide parts of it to make variants.

But the opposite is also possible: You can split off parts from the original object, putting them into their own submeshes. I have done this in the : the seams will get a texture, and the rest of the mesh will be coloured with a cyberpunk material.

You do that by changing into the edit mode, then selecting everything that you want to split off ("Select Linked" or "Select More" is your friend here), and splitting it (P -> Split Selection).

You can duplicate your selection first (Shift+D, ESC)

Now, switch back to Object mode and select your new mesh before going back to Edit Mode. Make sure to your new mesh, so that it is slightly above the surface of the old one - otherwise, you will have two things in the same place, which will look like shit.

Make sure to , or run again.

Unparent

You can complete unparent + apply transformations via : Switch to the Blender "Scripting" perspective, create a new file, paste the code from mana's github, and click the play button.

Select everything (click the viewport and press A), then unparent the objects by pressing Alt+P. Select "Clear and Keep Transformation".

Applying transformations

Since those are saved relatively and Wolvenkit will ignore them, your objects might end up larger or smaler than you expect them, or be in different places.

Select your objects in the viewport, then press Ctrl+A and choose "All Transforms".

Scale it

Scale your 3d object in Blender until it has the size you expect it to be in-game.

If you do this in the object mode, you need to afterwards. Alternatively, you can scale the vertices in edit mode.

If your mesh still scales weirdly in Wolvenkit / the game, you can create a new mesh in Blender, delete its vertices in edit mode, and then join your original object on top of it.

If you need a reference object, you can use this from my .

Origin

Keep in mind that your prop will rotate around the world origin, and position it accordingly.

Once you are done, import the glb file over your original mesh (you can consult the below).

Your import has been successful when the preview in Wolvenkit changes (you might have to select another file first).

Material assignments

For an overview of materials that you might want to use for something, check .

You can check a material's properties by opening the file inside of Wolvenkit and checking the last entry of the "parameters" array, or search for "files using this" and looking at how they're doing things.

Setting up our materials

You can find explanation and documentation about materials .

Add a new material entry

Select the entry "texture" inside the array materialEntries
Duplicate it
Select the new entry

Assign the submesh

Open the array appearances, select the first appearance (default) and select the array chunkMaterials. Create a new entry, or duplicate the existing one. Make sure the list order shows

Transfer the material

Open baseball_textured.mesh
Find the CMaterialInstance "texture" inside localMaterialBuffer.materials.
Select it, then copy it via right-click (Copy (Selection) from Array/Buffer)

Change the material parameters

Let's update paths and values. Still inside of localMaterialBuffer.materials, change the following properties:

Material

name of KeyValuePair

value

For the leather texture, I've just picked a random mlsetup from the game files (which I found by searching Wolvenkit for leather > .mlsetup). If you want to make your own mlsetups, see .

Save the mesh. You can check the "Mesh Preview" tab if the materials show up. If the mesh turns invisible, you'll want to double-check your paths, though!

Let's set up our entity file

Open the baseball's entity file (your_name\your_prop_pack\baseball\baseball.ent).
Open the components array.
Select the second component (amm_prop_slot1

If you have more than four mesh files assigned to your entity's components, the prop will no longer be scaleable (as of AMM 2.0.2). You can get around this limitation by making meshes with more submeshes instead of individual files.

AMM: Let's set up our lua file

Open the lua file under resources\bin\x64\plugins\cyber_engine_tweaks\mods\AppearanceMenuMod\Collabs\Custom Props\your_prop_pack.lua.

Set modder to your name and unique_identifier to anything, e.g. your_name_your_props. Now, adjust the first entry in the "props" list to point to your entity file:

The "path" parameter is the relative path to your entity file, but every backslash has to be doubled.

"name" is what you'll search for in AMM. "distanceFromGround" is pretty self-explanatory, but I prefer it if my objects are floating.

Save the lua file, install your mod, and launch the game. Time to test!

Material assignments

For an explanation how materials are assigned to a mesh, check - this guide will just tell you what to do.

You can copy entire materials between meshes: select one, right-click, and pick one of the "copy from…" entries.

Open template_no_variants_textured.mesh in WKit. All of the following operations will take place in that file.

Adjust your chunkMaterials

Open appearances/default/chunkMaterials. You need to have one per submesh.

For a more detailed explanation/guide, see the next section. If you don't care, you can skip straight to the next section and fix up the .

Explanation:

chunkMaterials are where you assign materials by submeshes. The identifier here is the name. Before changes, the first (and only) submesh will use the material mat_textured. Our newly imported mesh (the baseball) has two.

Add a new chunkMaterial to the array by either

right-click the existing chunkMaterial and select duplicate
select the array chunkMaterials and then click the yellow (+) button int he side panel

then change the name of the first entry to mat_ingame:

You can name your materials whatever you like, as long as you stick to the following rules:

You need one chunk material per submesh
chunkMaterials needs to be

Material entries

Find the array materialEntries at the root level of the mesh and open it. It will have two entries:
Select the second entry and change its name to the one from your chunkMaterial (mat_ingame). Numerical order does not matter here.

Explanation:

MaterialEntries are a lookup map between the material names in the chunkMaterials and the actual materials (see for an explanation). You can have local or external materials or a mix of both; check for an explanation.

Now, we adjust the materials — we'll just change a few properties to show you how it works, and then you can go play.

For another guide on how to edit materials in detail, check

Setting up the materials

Find the array localMaterialBuffer/materials and open it. It contains two materials. Wolvenkit will display the names corresponding to the so you can see which is which.

For an explanation of material parameters, see .

The first one, mat_textured, is the one that we will use for the seams. If you imported your textures by overwriting the original export, you shouldn't need to do anything here.

Instead, we will change the second material, mat_ingame.

Re-using an mlsetup

If you rather want to make your own mlsetups, see .

Select mat_ingame
Expand the material and its values array
Delete the parameter MultilayerMask

Make it gold, baby!

Select mat_ingame
Delete all parameters from the values array
Set the baseMaterial to base\environment\decoration\containers\cases\coffin\textures\m_z_gold.mi

The possibilities are basically endless, so go and explore them already! For a nifty list with materials to get you started, check . For a guide on creating AMM props, see .

Troubleshooting

This section will only cover troubleshooting steps for this guide. For general 3d model troubleshooting (including import errors), see .

My prop doesn't spawn and AMM won't target it!

AMM can't find your .ent file. Check the paths in the lua.

My prop is invisible (but AMM targets it)!

This can be one of the following issues:

the path from .ent to .mesh is wrong
the mesh appearance in the .ent file can't be found (check spelling in both .ent and .mesh)
the mesh appearances's chunk materials can't be found (check spelling in the .mesh, both in the chunkMaterial assignments and the CMaterialInstance in localMaterialBuffer.materials)

If that doesn't help as well, try assigning a default game material (search for anything ending in .mt and put the path in your material's baseMaterial.DepotPath).

Try assigning a default game material by searching for

My prop is all over the place / too big / too small

Check the in Blender and make sure that you have .

I don't have a normal map texture, but my import looks shit without one

Use engine\textures\editor\normal.xbm

Some of my props are much "lighter" than others!

These ones will have a blue normal map as opposed to a yellow one. Invert the blue normal texture before importing it..

Adding new items

No more replacers! Add your own gear with TweakXL and ArchiveXL

Summary

Created by @manavortex Published November 04 2022

This guide will walk you through adding your own items to Cyberpunk 2077, which can then be spawned via console.

It uses the following versions:

Cyberpunk 2077 game version 1.6.2 Hotfix
>= 8.9.0
1.1.4

Assumed skill level: You should be able to find your way around WolvenKit, but I aim to keep this as noob-friendly as possible.

For experienced modders

I have repeatedly observed that newbies are fine with this guide, while people who know how to mod are not. Watch out for boxes like this one to avoid those pitfalls.

The guide was created after reading and being left with a bunch of question marks. To get a deeper understanding, refer to the initial guide and follow the linked resources or consult ArchiveXL's .

To troubleshoot your ArchiveXL mods, you can make use of the FileValidation in Wolvenkit >= 8.9.1. As of Jul 22nd that isn't yet released, but you can download a (for example , as it's pretty stable).

There is a new way of connecting your files: . There is no detailed guide yet, but if you want to create lots of options, then you will definitely want to check out this approach, as it cuts down your file structure overhead by virtually eliminating the root entity and .app file.

Grab the example files

Create a new Wolvenkit project
Download the prepared files from and extract them to the root of your new project (overwriting the "source" folder)

If you would rather start from scratch: Check the detailed instructions .

Understanding of the file structure is not required as long as you follow the guide to the letter, but if you want it anyway, see the sub-page.

⚠ Do not edit those files outside of WolvenKit, and whatever you do, do not let Microsoft Excel touch the clothing.csv! ⚠

You should now have the following files:

Start the game

Wait, am I not supposed to do anything first??

Actually, no! This is how you later debug your custom items — by packing your project and checking that everything works in-game. So we're starting with a dry run here.

Press "Install and Launch" in WolvenKit. This will do the following things:

Copy all supported file entries from source to their destination under packed, overwriting older files (but not removing files that you renamed!)
Copy all files under packed into your game directory, again overwriting older files

You should now see ~~your~~ the tutorial item. If not, consult the section below, or retrace your steps and make sure that everything works before proceeding to the step below.

Great! You added items! Now what?

You've successfully pushed a button and everything worked, but so far, you haven't done anything. If you're okay with this, then you're done now.

To start changing the existing files, check the page for "Making Changes" headers.

Otherwise, you will want to complete one or more of the following steps:

add than a torso item
Add more
Add for different genders or different camera modes

Diagram

This is how everything connects. Looks pretty scary, but is actually simple: whenever you want to rename or repath something, make sure that you catch both ends of the arrow.

You can find a breakdown-by-entry on the .

Adding an appearance (example: blackblue)

Before you add an appearance, make sure that your item is loading up correctly and looking as expected. If you have to debug, you will have to look through every appearance you made!

For experienced modders: This includes you! :)

If you would rather have a step-by-step guide for a gendered variant, see .

To add an appearance, you will have to touch the following files:

*.yaml: Adding an entry
appearance.app: Adding a mapping between rootentity and mesh's appearance
rootentity.ent: Adding a mapping between yaml's appearance and app's appearance

For a diagram of how everything connects, go . To follow the

Step 1: Register it in your *.yaml

Duplicate the entire appearance block for an already working item. ⚠Mind the indent!
Change the first line to a unique name like Items.my_custom_shirt_blueblack
Set the new appearance name for the rootentity.ent

The total entry should look like this:

Step 2: Add it to the rootentity.ent

Find the step-by-step guide in the on the "" page.

If you want to add a , make sure to add the DynamicAppearance tag here.

Step 3: Add it to my_custom_shirt.app

Find the step-by-step guide in the on the "" page

Step 4: Add it to the .mesh

This tutorial assumes you already know how to . Quick reminder about the mlsetup:

Export it to json
edit the mlsetup.json with the
Import it back

Find the step-by-step guide in the on the "" page

Test it

Now, log into the game and spawn the item variant. The name is the header you defined in the yaml file, in this case

Adding a Male Instance

This part of the tutorial isn't fully up-to-date with the overhauled file structure yet, so keep that in mind when studying the screenshots.

Also, this part is super easy to follow and even if you make a mistake, fixing it won't be a problem. But hey, you've put in a lot of work and made great progress, so why not take a sec and back up your project files? Better safe than sorry, right?

Before we proceed with the tutorial, it's important to address a common issue you might have encountered while creating your mod.

If you've tested the mod on a Male V, you might have noticed some weird glitches like mesh clipping or wonky shapes.

You see, we've been using a mesh designed specifically for Female V, and that's why we've been running into some roadblocks. But don't worry, we're here to help you overcome this challenge!

Preparing the mesh file for the male variant

To fix this issue, we'll need a mesh that's compatible with Male V.

In the interest of keeping things simple, we've found just the mesh for you! It's called t1_024_ma_tshirt__sweater.mesh and it can be found in the base\characters\garment\citizen_casual\torso\t1_024_tshirt__sweater directory.

If you plan on using other meshes for your mod, ensure that it has ma or pma in its name.

Keep in mind that some ma meshes may still have clipping issues when paired with certain types of clothing, while pma meshes are specifically designed for V and don't have this problem.

Now, add the file to your project, move it to the tutorial\torso\my_custom_shirt\ folder and rename it from t1_024_ma_tshirt__sweater.mesh to my_mesh_m.mesh.

Next, follow the steps you used for the original my_mesh.mesh by removing any unnecessary entries and adjusting the indices.

To avoid any issues, it's crucial to pay close attention to this step and double-check that the correct materials are present in the localMaterialBuffer and materialEntries, and that the indices are adjusted correctly.

This will ensure that your mod works as intended without any glitches or errors. If you need a refresher, to return to that section.

Creating a .ent File for Your Custom Mesh

It's time to set up the .ent file for our mesh. Don't worry, it's easy!

Start by making a copy of the mesh_entity.ent file that you previously created for the female version by duplicating it, and rename it to mesh_entity_m.ent.

Inside the mesh_entity_m.ent file, find the first component of the type entGarmentSkinnedMeshComponent. Set the following values:

Edit the yourModName.yaml

Inside the yourModName.yaml file set the appearanceSuffixes array to itemsFactoryAppearanceSuffix.Gender

If you are unclear about why this step was taken, we recommend !

Edit the rootentity.ent

Find the array appearances.
Expand the first entry.
1. Append &Female to the name attribute. This will change the name from appearance_root_entity_white_red

Edit the appearance.app

Find the array appearances
Duplicate the first entry to create a new one and expand it
Set the name attribute to my_shirt_m

Testing the mod

To test your mod, it's important to ensure that it works correctly for both male and female V. This means you'll need to have two separate save files, one for male V and one for female V, unless you're using a mod that allows you to quickly switch between them.

Test your mod independently for both cases by loading the appropriate save file and checking that the mod is working as intended. To spawn and equip your item, use the command specified in your YAML file.

Consider reviewing the guide to ensure that all steps have been followed correctly and that the values have been set appropriately. Ensure that the mesh is compatible with the male variant of V. If errors persist, review the for further assistance.

The final touches

If everything is working: Congratulations! You have successfully made a mod!

But before you can share it, you need to do one last thing, which is changing the file structure. Otherwise, everyone will overwrite the same tutorial files, and only one of those mods will work.

You can find a full guide on how to do that .

Troubleshooting

The easiest way to spot what's wrong is to use Wolvenkit's new FileValidation feature, which will print warnings and errors to the log file for you, starting at version >= 8.9.1.

First of all, check the logs for errors including the name of your mod:

red4ext/plugins/ArchiveXL/ArchiveXL.log
red4ext/plugins/TweakXL/TweakXL.log

ArchiveXL added clipping!

You have read right past those warning boxes telling you about . Make sure that you add them back.

My item warps weirdly

... deforms incorrectly, or is a puddle on the floor?

Most likely, you have ignored the when picking your mesh_entity.ent: Make sure that you're using an entity file that corresponds with the slot that you are trying to replace (e.g. if your item is a pair of shoes, you need an entity file from base\characters\garment\player_equipment\feet).

If you are here because of a link from a different guide:

You can find out which entity file your item uses by right-clicking on your mesh and selecting "find files using this". Add the .ent file to the list and open it in WolvenKit. Then, of the "components" array with those of an .ent file from the correct folder — don't forget to change the path to your mesh again!

I spawn my item, but it's not added to my inventory!

Before you start digging into your file structure, check if there are any leftover yaml files from earlier versions/deploys in your tweaks directory. Do a full text search in e.g. Notepad++ in any files in the folder with the name of the item you want to spawn.

If no additional yaml files are messing things up, then the error is somewhere in the first part of the chain and relatively easy to fix:

Check the following places:

yourmodname.archive.xl:
- Is the indentation correct, as shown in the picture?
- Did you make any typos?

My item shows empty text instead of name/description!

Something went wrong with your json file:

If there are no errors in any of the log files, check the following places:

yourmodname.archive.xl:
- Does the key localization - onscreens - en-us exist?

The item spawns, but…

Congratulations, you've made it into the right half of the diagram! The error will be somewhere here:

can help you catch the error.

If you set your mesh_entity.ent to point at a vanilla mesh, you can rule out your custom mesh and .mlsetup as a source of errors. Original game meshes will always have a working default appearance and will thus always be displayed!

The game crashes!

That means the chain is working, but something isn't loaded correctly. That's good! Check the following files:

appearance.app: Check the partsValues and partsOverrides entries. They need to point at the mesh_entity.ent, not at the mesh.
mesh_entity.ent: Does the component

If the default mesh is displayed correctly, then we have narrowed down the problem.

If the default mesh is not displayed correctly, then there's an issue between the root_entity and your .app file, or in the .app file's internal logic.

Troubleshooting a mesh

For more detailed error handling, check the sections below, or check .

ℹ In the "Mesh Preview" tab of your mesh, you can "Generate Materials for Appearance". If the correct colours show up, you can at least rule out that the error is in the .*mesh or its material.

Make sure that you have the same number of entries in materialEntries and localMaterialBuffer.materials .
Go through the CMaterialInstances in localMaterialBuffer.materials.

If none of that helps, I suggest

doing a gdb export
throwing away your mesh (don't close the WKit tab yet), falling back to the original one
doing a gdb import

My mesh is black and shiny!

Congratulations, this is about the easiest-to-resolve error that you could've had. Your mesh is loaded correctly, there is only a problem with the rendered material.

Check your mesh file:

Check the connection between appearance, materialEntry and localMaterial.CMaterialInstance. Are the names correct?
Go through the CMaterialInstances in localMaterialBuffer.materials.

My mesh has the wrong appearance!

Either an appearance is incorrectly selected, or it is incorrectly resolved. Check the following places for copy-paste/duplication mistakes:

yourModName.yaml - is the appearanceName correct, or did you forget to change it? rootentity.ent - does the name corresponding to the field above point to the appearanceName with the right name in the right appearance file? appearance.app - does the appearance's partOverride set the correct appearance in the componentsOverride?

Now, check the mesh file (close and re-open it to make everything refresh):

appearance - does it use the correctly named material? materialEntries - is the index correct, or is it pointing at the index of the actually displayed material? localMaterialBuffer - does the CMaterialInstance use the correct .mlsetup file?

Finally, check the .mlsetup: does it actually use different colours, or is it just a duplicate?

My mesh is invisible!

Here we go. This is the big one, and it's Not Fun. The error can be anywhere between the yaml and the mesh. You can rule out one of the files with the following question:

Does the glitching stop after <10 seconds? If not: the appearance can't be resolved - ignore the .mesh If yes: the appearance is resolved, but can't be displayed - ignore the .yaml

The fastest way to find your error is Wolvenkit's FileValidation (in version >= 8.9.1). Save the root_entity.ent, and the recursive valudation will check the whole chain for errors and print them to the log files for you.

As of July 2023, you can download the right version from the page (for example , as it's pretty stable).

ℹIf the appearance is resolved, but not displayed (short glitch), the first thing you should do is to change the path in the mesh_entity.ent to one of the game's default meshes. This will rule out errors on your part. (Yes, even if your mesh worked in another mod. No, I'm not speaking from experience, why do you ask?)

If the hint above doesn't solve it, proceed to troubleshoot in the same way as "My mesh has the wrong appearance!" above.

My garment tucks into/under other garments incorrectly

That's due to - check the link to learn more.

Visual tags aren't working!

If you are hiding components via visual tags, these tags have to go into the appearance file rather than the root entity.

I can't find anything, kill me now

Time to restore your files one by one to the last working backup and restart from there. Don't delete them, keep them in a different folder - you will be able to copy a lot of stuff over.

By right-clicking on a tab title, you can move it to a new document group for easier copying.

Good luck, soldier.

Modding Guides

hashtagHere, you can find

Analysing other mods

hashtagRequired: WolvenKitarrow-up-right

hashtagStep 1: Switch to mod browser

hashtagStep 2: Find the correct files

hashtagStep 3: Add the files to your project

Legacy: Analysing other mods with Wolvenkit Console

hashtagwolvenkit.cli.exe

Animations/Poses

hashtagSummary

NPCs & V

NPV: Cleanup and troubleshooting

hashtagRe-path your folder

Swap Johnny during the Alt's scene

hashtagSummary

Items: Equipment

hashtagWait, that's not what I want!

R&R: Troubleshooting

hashtagSummary

hashtagImport/Export

hashtagI can't import my file back

hashtagHave you moved any files?

hashtagMLSetupBuilder

hashtagI can't build a depot

hashtagRefitting

hashtagMy mesh is string cheese!

Editing existing items

Textures and LUTs

Troubleshooting normal maps

hashtagImport settings

Archived

Custom icons and UI

Inkwidgets: a custom interface

Gendered preview icons

hashtagRequirements:

hashtagHow to do it

hashtagWait, what?

Vehicles

World Editing

hashtagSummary

hashtagRequirements

hashtagFinding the required sector

Adding Objects to the World

hashtagSummary

hashtagRequirements

hashtagRecommended

hashtagAdding Objects to the World

Adding Locations and Structures with ArchiveXL

hashtagAdding a custom location to a new streaming sector and merging it with the game world

Sound

hashtagGuides:

hashtagExternal links:

Playing Sounds in-game : Basics

hashtagDifficulty:

hashtag

Quests

How to Edit Voiceover and Subtitles In a Quest.

hashtagRequirements:

How to Change Position and Rotation of an entMeshComponent

hashtagSummary:

hashtagRequirements:

hashtagThe Steps:

How to Remove an Animation (and Potentially Replace It)

hashtagSummary:

hashtagRequirements:

hashtagThe Steps:

Everything else

f!V and her gremlin feet

hashtagSummary

Customise CP77 info on GOG

hashtagSummary

Analysing other mods

hashtagRequired: WolvenKitarrow-up-right

hashtagStep 1: Switch to mod browser

hashtagStep 2: Find the correct files

hashtagStep 3: Add the files to your project

Modding Guides

hashtagHere, you can find

Legacy: Analysing other mods with Wolvenkit Console

Here, you can find

Required: WolvenKit

Step 1: Switch to mod browser

Step 2: Find the correct files

Step 3: Add the files to your project

wolvenkit.cli.exe

Summary

Re-path your folder

Summary

Wait, that's not what I want!

Summary

Import/Export

I can't import my file back

Have you moved any files?

MLSetupBuilder

I can't build a depot

Refitting

My mesh is string cheese!

Import settings

Requirements:

How to do it

Wait, what?

Summary

Requirements

Finding the required sector

Summary

Requirements

Recommended

Adding Objects to the World

Adding a custom location to a new streaming sector and merging it with the game world

Guides:

External links:

Difficulty:

Requirements:

Summary:

Requirements:

The Steps:

Summary:

Requirements:

The Steps:

Summary

Summary

Required: WolvenKit

Step 1: Switch to mod browser

Step 2: Find the correct files

Step 3: Add the files to your project

Here, you can find

wolvenkit.cli.exe

Summary

Guides:

External links:

Summary

Summary

Wait, that's not what I want!

Import settings

Re-path your folder

My NPV doesn't show!

I'm getting errors in Wolvenkit!

It installs, but doesn't launch

Summary:

Requirements:

The Steps:

Adding a custom location to a new streaming sector and merging it with the game world

Requirements:

How to do it

Wait, what?

Summary

Requirements:

Summary

Import/Export

I can't import my file back

Have you moved any files?

MLSetupBuilder

I can't build a depot

Refitting

My mesh is string cheese!

Summary

Requirements

Finding the required sector

Summary