# Your image as custom mesh

## **Summary**

**Published August 2023 by** [mana vortex](https://app.gitbook.com/u/NfZBoxGegfUqB33J9HXuCs6PVaC3 "mention")\
**Last documented update**: March 18 2024 by [mana vortex](https://app.gitbook.com/u/NfZBoxGegfUqB33J9HXuCs6PVaC3 "mention")

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

If you want, you can then turn your replacers into new [custom-props](https://wiki.redmodding.org/cyberpunk-2077-modding/for-mod-creators-theory/3d-modelling/custom-props "mention") for AMM!

### Wait, that's not what I want!

* To learn how material assignment works, check [https://github.com/CDPR-Modding-Documentation/Cyberpunk-Modding-Docs/blob/main/for-mod-creators-theory/files-and-what-they-do/file-formats/3d-objects-.mesh-files](https://github.com/CDPR-Modding-Documentation/Cyberpunk-Modding-Docs/blob/main/for-mod-creators-theory/files-and-what-they-do/file-formats/3d-objects-.mesh-files "mention") and its sub-page [submeshes-materials-and-chunks](https://wiki.redmodding.org/cyberpunk-2077-modding/for-mod-creators-theory/files-and-what-they-do/file-formats/3d-objects-.mesh-files/submeshes-materials-and-chunks "mention")
* To learn more on how materials in general work, read [materials](https://wiki.redmodding.org/cyberpunk-2077-modding/for-mod-creators-theory/materials "mention")
* For a guide on changing an existing mesh, read [changing-materials-colors-and-textures](https://wiki.redmodding.org/cyberpunk-2077-modding/modding-guides/items-equipment/editing-existing-items/changing-materials-colors-and-textures "mention")

## Prerequisites

You need the following software:

<table><thead><tr><th width="199">Software</th><th>What's it for?</th></tr></thead><tbody><tr><td><a href="https://inkscape.org/release/inkscape-1.3/">Inkscape</a> 1.3</td><td>Converting your picture into an svg which you can then import into Blender to create a mesh</td></tr><tr><td><a href="https://github.com/WolvenKit/Wolvenkit/releases">Wolvenkit</a> (recent)</td><td>converting your mesh to an in-game-item</td></tr><tr><td><a href="https://www.blender.org/download/releases/3-6/">Blender</a> 3.6</td><td>Converting your SVG to a 3d object that you can import into Cyberpunk.</td></tr><tr><td><a data-mention href="../modding-tools/wolvenkit-blender-io-suite">wolvenkit-blender-io-suite</a></td><td>Exporting from Blender to Cyberpunk</td></tr></tbody></table>

## 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:

<figure><img src="https://1427525421-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4gzcGtLrr90pVjAWVdTc%2Fuploads%2Fgit-blob-7677b57e1cc24172937b6b184b75d6cf8945a222%2Fpacman.png?alt=media" alt=""><figcaption></figcaption></figure>

{% hint style="danger" %}
Make sure that your image is as clean as possible. I can't stress this enough – any rough or fuzzy edges will result in extra geometry, making the cleanup in Blender much harder.
{% endhint %}

## Step 1: Convert to SVG

I started by following [this guide](https://linuxhint.com/convert-png-to-svg-inkscape/), but I'll write you a TL;DR

1. Open Inkscape and create a new document
2. Select File -> Import and import your .png from step 0
3. Make sure that your image is **selected** (click on it if you're not sure, it will have that resizing handle)
4. From the menu, select Path -> Trace Bitmap (it doesn't have to be a bitmap)
5. Pick your options in the right-hand panel. I won't cover them in detail here, check the [linked guide ](https://linuxhint.com/convert-png-to-svg-inkscape/)or noodle around until the result looks OK.
6. Press the Apply button at the bottom
7. Your new traced path will be auto-selected for you.
8. Select File -> Save As and save it as an \*.svg file.

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

## Step 2: Making a mesh

For this, I've originally followed [this](https://devforum.roblox.com/t/converting-svgs-to-meshes/884514) guide, but here's a TL;DR for you again:

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

<figure><img src="https://1427525421-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4gzcGtLrr90pVjAWVdTc%2Fuploads%2Fgit-blob-c5c7d8ea46408a0cd885d02ff371cfb588a1dfbb%2Fpacman_extrude.png?alt=media" alt=""><figcaption><p>In case you end up with an object rather than a curve (a spiraly thingy rather than a フ), you used the wrong import.</p></figcaption></figure>

3. With an active selection, find the curve properties panel in the bottom right (the green icon).
4. In the "Geometry" section and find "Extrude".
5. Set it to something like 0.001 — play around with it until your mesh is appropriately extruded.
   1. Do not bevel it! We want the corners nice and sharp, we can always make it round l,ater.
6. Once you're satisfied, transform the curve into a mesh: Object -> Convert -> Mesh

We're now leaving the previous guide.

## Step 3: Fixing up the mesh for Cyberpunk

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

1. Fix **rotation**: Press `R` -> `X` -> `90`
2. Fix **scale**: Press `S` and move the mouse
3. Fix position:
   1. Press `G` -> `Z` to move the mesh up and down
   2. Press `G` -> `X` to move the mesh left and right
   3. You don't need to move it on the y axis
4. Apply transformations: Press `Ctrl+A` -> `T`

<figure><img src="https://1427525421-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4gzcGtLrr90pVjAWVdTc%2Fuploads%2Fgit-blob-6235d1a0c27e1f48cd5629b063da4bad3ac4bdac%2Fcustom_neon_repositioned_mesh.png?alt=media" alt=""><figcaption></figcaption></figure>

### Cleaning up the geometry

{% hint style="info" %}
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 [here](https://exoside.com/quadremesher/quadremesher-download/).
{% endhint %}

Let's reduce poly count and clean up our mesh. For a detailed guide, see [here](https://all3dp.com/2/blender-simplify-mesh-simply-explained/), I'm going to give you a TL;DR again:

### Remesh modifier

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

| Setting      | Value | explanation                          |
| ------------ | ----- | ------------------------------------ |
| Mode         | sharp | Remesh type: preserving sharp edges  |
| Octree Depth | 8     | Level of detail                      |
| Scale        | 0.1   | Size of quads in the remeshed object |
| Sharpness    | 1     | Preserve sharp edges                 |

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

<figure><img src="https://1427525421-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4gzcGtLrr90pVjAWVdTc%2Fuploads%2Fgit-blob-157f84b788503275cea8b609f4645b5801051450%2Fcustom_neon_after_modifier.png?alt=media" alt=""><figcaption><p>You can play around further, trying to get the poly count down. We'll leave it at this for now.</p></figcaption></figure>

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

{% hint style="info" %}
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.
{% endhint %}

### 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.

![](https://1427525421-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4gzcGtLrr90pVjAWVdTc%2Fuploads%2Fgit-blob-d223eaa1aefdb1b6754f28bd4b9c436738943b47%2Fcustom_neon_add_UV.png?alt=media)

## Naming

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

### Optional: More submeshes for more colours

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

1. Change back to Edit Mode
2. Turn on X-Ray (Alt+Z) and select the shape that you want to split off
3. Press `P` -> `S` (Split -> Selection)
4. Rinse and repeat until you have all the submeshes split off

<figure><img src="https://1427525421-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4gzcGtLrr90pVjAWVdTc%2Fuploads%2Fgit-blob-90bd2314702892110953a0039443902acca64e69%2Fcustom_neon_post_split.png?alt=media" alt=""><figcaption></figcaption></figure>

## Creating a Wolvenkit project

Time to pull up Wolvenkit.

Assuming you have Wolvenkit [installed](https://app.gitbook.com/s/-MP_ozZVx2gRZUPXkd4r/getting-started/download), you can now [create a new project](https://app.gitbook.com/s/-MP_ozZVx2gRZUPXkd4r/wolvenkit-app/usage/wolvenkit-projects#creating-a-new-wolvenkit-mod-project). 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.

{% hint style="info" %}
You can obviously use any kind of mesh or material here!
{% endhint %}

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

1. Decide on a mesh and add it to your project.
2. [Export the mesh from Wolvenkit](https://wiki.redmodding.org/cyberpunk-2077-modding/modding-tools/wolvenkit-blender-io-suite/wkit-blender-plugin-import-export#export-from-wolvenkit)
3. In the project explorer, right-click on the exported file (`sex_shop_neon_sign_b.glb`) and select **Show in Windows Explorer**, because we will now overwrite this file in Blender.

## Exporting

In Blender,

1. select all the meshes that you want included (in Object Mode)
2. use the [wolvenkit-blender-io-suite](https://wiki.redmodding.org/cyberpunk-2077-modding/for-mod-creators-theory/modding-tools/wolvenkit-blender-io-suite "mention")to [export into](https://wiki.redmodding.org/cyberpunk-2077-modding/modding-tools/wolvenkit-blender-io-suite/wkit-blender-plugin-import-export#exporting-from-blender) the file from the previous step.

<figure><img src="https://1427525421-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4gzcGtLrr90pVjAWVdTc%2Fuploads%2Fgit-blob-4ff47df1c174f78191137f91afaeea82064d299b%2Fcustom_neon_export.png?alt=media" alt=""><figcaption></figcaption></figure>

In Wolvenkit, use the [Tools #Import Tool](https://app.gitbook.com/s/-MP_ozZVx2gRZUPXkd4r/wolvenkit-app/tools#import-tool "mention") to import `sex_shop_neon_sign_b.glb`. The preview in the `File Information` panel should update.

## Assigning Materials

{% hint style="info" %}
I'll give the TL;DR version, you should be able to follow along. If not, feel free to read up on [how materials work in meshes](https://github.com/CDPR-Modding-Documentation/Cyberpunk-Modding-Docs/blob/main/for-mod-creators-theory/files-and-what-they-do/file-formats/3d-objects-.mesh-files#material-assignment) or find us on [Discord](https://discord.gg/redmodding)!
{% endhint %}

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

{% hint style="info" %}
To learn more about this, check [submeshes-materials-and-chunks](https://wiki.redmodding.org/cyberpunk-2077-modding/for-mod-creators-theory/files-and-what-they-do/file-formats/3d-objects-.mesh-files/submeshes-materials-and-chunks "mention"). This is not necessary for completing this guide.
{% endhint %}

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

<figure><img src="https://1427525421-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4gzcGtLrr90pVjAWVdTc%2Fuploads%2Fgit-blob-f845e0c70c29fc6dbae5e50b6291cb6d16cf909e%2Fcustom_neon_chunkmasks.png?alt=media" alt=""><figcaption></figcaption></figure>

### MaterialEntries

Now, we **define** the materials:

1. Find the array `materialEntries`
2. Add four new entries (or duplicate one four times, or…)
3. Name each item according to the entries in the previous step
4. Make sure that their **`index`** property is unique and corresponds to their array position.

<figure><img src="https://1427525421-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4gzcGtLrr90pVjAWVdTc%2Fuploads%2Fgit-blob-8d39cebbf6396aa15781bde49d11069f3ed2fbb6%2Fcustom_neon_add_materials.png?alt=media" alt=""><figcaption><p>The left side of this screenshot</p></figcaption></figure>

### LocalMaterials

… and finally, we actually **add the materials**.

1. Find and expand the array `localMaterialBuffer` and its child `materials`
2. Copy the second entry, `sex_shop_neon_sign_emissive_red_on` via right-click menu
3. paste it into `materials`
4. Duplicate it three more times
5. In the new material entries, find the property `ColorOneStart` and change it in the side panel.
6. Repeat for each material, then save the mesh.

<figure><img src="https://1427525421-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4gzcGtLrr90pVjAWVdTc%2Fuploads%2Fgit-blob-8d39cebbf6396aa15781bde49d11069f3ed2fbb6%2Fcustom_neon_add_materials.png?alt=media" alt=""><figcaption><p>The right side of this screenshot</p></figcaption></figure>

## Testing!

In Wolvenkit's top bar, select [`Install`](https://app.gitbook.com/s/-MP_ozZVx2gRZUPXkd4r/wolvenkit-app/menu/toolbar#install) and then boot up Cyberpunk.

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

<figure><img src="https://1427525421-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4gzcGtLrr90pVjAWVdTc%2Fuploads%2Fgit-blob-172af6202314a00e16930ad0318175909a196a1c%2Fcustom_neon_jigjigstreet.jpg?alt=media" alt=""><figcaption></figcaption></figure>

{% hint style="danger" %}
Please remember that you are currently replacing all heart neon signs in the entire game! Before sharing your custom neon, consider making [custom-props](https://wiki.redmodding.org/cyberpunk-2077-modding/for-mod-creators-theory/3d-modelling/custom-props "mention")!
{% endhint %}

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

## I don't want a replacer!

That's A-OK, but exceeds the scope of this guide. Fortunately, you can just head over to [custom-props](https://wiki.redmodding.org/cyberpunk-2077-modding/for-mod-creators-theory/3d-modelling/custom-props "mention") and proceed from there.

## Troubleshooting

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

### Something is wrong with my 3d object!

If you can't export your mesh from Blender or import it into Wolvenkit, make a cube (right-click into the viewport, **`Add`**, select `Cube`. Before you get hung up on this step and burn out, let's add a few cubes to the game to give you a success. After that, you can hit us up on [Discord](https://discord.gg/redmodding) in the `#textures-and-models` so we can fix your mesh.

### Something else is wrong!

Check the [troubleshooting-your-mesh-edits](https://wiki.redmodding.org/cyberpunk-2077-modding/for-mod-creators-theory/3d-modelling/troubleshooting-your-mesh-edits "mention") pages or find us on [discord](https://discord.gg/redmodding). :)