---
description: How to add custom preview images by using a custom .inkatlas file
---

# Your own inventory preview icons

## Summary

**Uploaded:** ??? by [mana vortex](https://app.gitbook.com/u/NfZBoxGegfUqB33J9HXuCs6PVaC3 "mention")\
**Last documented update:** Mar 18 2024 **by** [yellingintothevoid](https://www.nexusmods.com/users/127630298)

This guide will teach you how to make custom inventory preview icons.

{% hint style="info" %}
Technically, this guide is a subsection of the [ArchiveXL item additions guide](../items-equipment/adding-new-items), but you can use it to make any kind of preview item.
{% endhint %}

The guide below will teach you how to make preview icons. While it's a technically a subsection of the [ArchiveXL item additions guide](../items-equipment/adding-new-items), you can use the steps below to make any kind of preview item.

**Difficulty Level**: You know how to read and can either edit images or make use of [the corresponding guide](../textures-and-luts/images-importing-editing-exporting). While the process is easy, it also is, unfortunately, quite tedious!

### Wait, this is not what I want!

* If you want to have gendered preview icons, check [here](adding-items-preview-images/gendered-preview-icons).
* For a script to generate inkatlas files, check [The Magnificent Doctor Presto's github](https://github.com/DoctorPresto/Cyberpunk-Helper-Scripts/blob/main/generate_inkatlas.py)
* To learn more about the files involved, check [game-icons-the-inkatlas-file](../../for-mod-creators-theory/files-and-what-they-do/file-formats/game-icons-the-inkatlas-file "mention")

## Required tools

You need at least Wolvenkit 8.16.2 for this (download [stable](https://github.com/WolvenKit/Wolvenkit/releases) | [Nightly](https://github.com/WolvenKit/WolvenKit-nightly-releases/releases)), as it can generate inkatlas files.

## Destination path

If you downloaded the example project ([#getting-the-files](../../animations/animations/archivexl-adding-photo-mode-poses#getting-the-files "mention")), you will already find a preview, which we will overwrite:

```
tutorial  
    ops           
          - my_tshirt_factory.csv 
          - translation_strings.json  
          - preview_icons.inkatlas       <<<  
          - preview_icons.xbm            <<<  
```

## Image dimensions

You need to know the correct dimensions for your images:

| Item type    | Width   | Height(s) |
| ------------ | ------- | --------- |
| Clothing     | 130-160 | 76-160    |
| Gun          | 320     | 80-160    |
| Melee weapon | 320     | 60 - 145  |

## Taking preview pictures

You have two options on taking preview pictures. Both are relatively tedious, since you have to do it by hand.&#x20;

You can find more detail about how to take preview pictures in [#blender](#blender "mention") or [#in-game](#in-game "mention") further down the section.

### mana's workflow

#### Prerequisites

* [Photo Studio Props](https://www.nexusmods.com/cyberpunk2077/mods/7436)
* [Invisible V](https://www.nexusmods.com/cyberpunk2077/mods/8412)
* [Appearance Menu Mod](https://www.nexusmods.com/cyberpunk2077/mods/790)
* [Appearance Creator Mod](https://www.nexusmods.com/cyberpunk2077/mods/10795)
* Photoshop or [photopea.com](https://www.photopea.com/)

#### Taking photos

1. Strip V nekkid, then put on the [Invisibility Cloak](https://www.nexusmods.com/cyberpunk2077/mods/8412) and the item you want to create previews of
2. Use [AMM](https://www.nexusmods.com/cyberpunk2077/mods/7436) to spawn "Photo Studio: Wall Cover" from the [Photo Studio Props](https://www.nexusmods.com/cyberpunk2077/mods/7436)
3. Set the appearance to `white (matte)`&#x20;
4. Switch to photo mode. Find a good angle and lighting for your item.
5. Use [ACM](https://www.nexusmods.com/cyberpunk2077/mods/10795) to set the item's appearance to the darkest variant (e.g. `black`)
6. Take a screenshot. You will use this for **masking**.
7. Switch the background color to `black`
8. Use ACM to cycle through the item's appearances and take a screenshot of each
9. In Windows Explorer, find your item screenshots and move them to a folder
10. Re-name the png to the name of your future icon (e.g. `myItem_black`). You can also do this later.

#### Processing photos

1. Open the dark item on the white background in photoshop or [photopea](https://www.photopea.com/)
2. Drag all the other pictures you took on top of it. The items must be in the same space!
3. In the **Layers** panel (bottom right)
   1. &#x20;create a group and put all the layers inside
   2. Drag the layer of the white background picture to the top, and select it (click on it)
4. Press `W` to select the **Magic Wand** tool
5. From the top bar, use the `Select Subject` button
6. Optional: use the Select and Mask view to fine tune your selection
7. Confirm. You now have a selection that includes only your item.
8. In the Layers panel (bottom right),&#x20;
   1. select the group (folder) by clicking on it
   2. create a layer mask by clicking on the icon that looks like the Japanese flag
9. The background will now be transparent
10. Use the Crop Tool (Keyboard shortcut: `C`) to crop a rectangular selection with your icon in the center
11. Select the layers, right-click, and select "Quick Export as PNG"

<figure><img src="https://1427525421-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4gzcGtLrr90pVjAWVdTc%2Fuploads%2FrLkrSywCR0bEyfFUtltH%2Fimage.png?alt=media&#x26;token=a525dee2-3f4a-4114-af5f-543c33fb2f2e" alt=""><figcaption></figcaption></figure>

12. You should now have a bunch of transparent pngs. Now, let's see about [#generating-the-inkatlas](#generating-the-inkatlas "mention").

### Blender

You [can export your mesh with all its materials](../../../for-mod-creators-theory/modding-tools/wolvenkit-blender-io-suite/wkit-blender-plugin-import-export#export-from-wolvenkit) to Blender and take your preview pictures there:

<figure><img src="https://1427525421-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4gzcGtLrr90pVjAWVdTc%2Fuploads%2FZ1RyNFsBv6q06DZLi7gU%2Fblender_export_transparent.jpeg?alt=media&#x26;token=0291c0c8-a545-4370-b3c5-035bcde48578" alt=""><figcaption></figcaption></figure>

### In-game

{% hint style="info" %}
This part of the guide is a bit longer, since it tells you how to get decent-quality preview pictures. If you don't care for that (you should, but we all hate it), you can skip ahead to [#hooking-up-the-inkatlas](#hooking-up-the-inkatlas "mention").
{% endhint %}

### Overview of the Process

The idea is to combine mods that make V invisible and a ReShade filter called DepthAlpha.fx to create in-game screenshots of your item where the _background is transparent_. This means you don't have to spend a lot of time painstakingly removing the background manually in Photoshop. The screenshots taken with DepthAlpha.fx only need a little bit of cleanup ([#creating-the-actual-icon](#creating-the-actual-icon "mention")), but can be basically directly imported into the `.xbm` file containing your icons.

{% hint style="info" %}
Using ReShade is, of course, entirely optional, but teaching how to mask out objects in Photoshop is outside the scope of this tutorial.
{% endhint %}

#### Prerequisites

[Invisible V](https://www.nexusmods.com/cyberpunk2077/mods/8412) by [manavortex](https://www.nexusmods.com/cyberpunk2077/users/1630319) or the [Invisibility Cap and Shoes](https://www.nexusmods.com/cyberpunk2077/mods/8643?tab=files) by [PinkyDude](https://www.nexusmods.com/cyberpunk2077/users/20892624)

**Optional**, but highly recommended:

[AMM](https://www.nexusmods.com/cyberpunk2077/mods/790) & [AMM Props - PhotoStudio](https://www.nexusmods.com/cyberpunk2077/mods/7436)

[ReShade](https://reshade.me/)

[DepthAlpha.fx](https://github.com/luluco250/FXShaders/tree/master) (make sure to [set up the depth buffer properly](https://github.com/martymcmodding/ReShade-Guide/wiki/The-Depth-Buffer#verifying-the-depth-buffer-is-set-up-correctly))

[AppearanceCreatorMod](https://www.nexusmods.com/cyberpunk2077/mods/10795) or [Equipment-EX](https://www.nexusmods.com/cyberpunk2077/mods/6945)

### The Process

**Preparation:**

Start the game

1. Equip the invisibility garment and the item you want to create icons for.
   1. To switch through appearances on-the-fly, you can use [AppearanceCreatorMod](https://www.nexusmods.com/cyberpunk2077/mods/10795) while V is in the center of the camera.
   2. Alternatively, you can save outfits for all colour variations of your outfit In [Equipment-EX](https://www.nexusmods.com/cyberpunk2077/mods/6945):

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

**Lighting:**

{% hint style="info" %}
**Optional:** Finding a good spot

If you can't be bothered, you can simply teleport to the window of Saburo's office:

```
Game.GetTeleportationFacility():Teleport(GetPlayer(), ToVector4{x=-1349.5053710938, y=138.80358886719, z=545.84600830078, w=1}, ToEulerAngles{roll=0, pitch=0, yaw=0})
```

Make sure to have some decent lighting on your item.
{% endhint %}

<details>

<summary>See the long version</summary>

<img src="https://1427525421-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4gzcGtLrr90pVjAWVdTc%2Fuploads%2Fgit-blob-98cabff34ff33047051eaf450cad45247811ecc8%2Ficon_tutorial_01_photo_booth.png?alt=media" alt="" data-size="original">

1. Enter Photo Mode and build a black photo booth around V that looks like the one in the screenshot above using [AMM](https://www.nexusmods.com/cyberpunk2077/mods/790). The [AMM Props - PhotoStudio](https://www.nexusmods.com/cyberpunk2077/mods/7436) are very useful for this.
2. Save your photo booth as an AMM preset to create similar looking icons across all your mods.
3. It's also very useful to make sure the angle of the camera in relation to V remains similar across all your icons:
   1. Exit photo mode and look at the lower edge of your photo booth.
   2. Align the edge with the bottom of your screen, to ensure V is positioned parallel to the photo booth (this will make more sense later).
   3. Enter photo mode again and rotate V to about +15 in the Pose tab.
4. Add some area lights to the scene. The goal is to highlight the shape of the item. So aim for deep shadows, lots of contrast, and prominent contours. In the screenshot below, there are four lights: two from each side behind the item as rim lights, one at a roughly 45° angle in front and above the item as key light, and one of very low intensity directly in front of the camera to fill in shadows.

<img src="https://1427525421-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4gzcGtLrr90pVjAWVdTc%2Fuploads%2Fgit-blob-3cd28d2911bba4320405a505ee3b4e8cc466bacd%2Ficon_tutorial_03_lights.png?alt=media" alt="" data-size="original">

</details>

{% hint style="info" %}
Sometimes, it can be helpful to disable RTX to create icons. The screenshot of item on the left in the image below was taken using Path Tracing and DLSS, the one on the right using rasterised lighting without DLSS:

<img src="https://1427525421-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4gzcGtLrr90pVjAWVdTc%2Fuploads%2Fgit-blob-cfda5799408d4dbf4882a894f50814cdf597c0a0%2Ficon_tutorial_04_rtx-shadows.png?alt=media" alt="" data-size="original">

* If your item is a jacket, the shadows on the inside can look broken with RTX.
* If your item is jewellery made from glossy metal, you might get _unwanted_ reflections with RTX.
* If your item features fine textures, you might want to disable RTX, so that you can also disable DLSS/FSR without burning up your graphics card.
* If your item is a piece of clothing made from glossy material, you might _want_ RTX reflections.
{% endhint %}

#### Taking the screenshots

1. To actually take the screenshot, position the Photo Mode camera so that it is rougly parallel to the bottom edge of your photo booth.
2. Set the Field of View to about 30 to prevent distortion when taking a closeup.
3. Move the camera so that the item fills the entirety of your screen without cutting off a part of it.

{% hint style="info" %}
**If you're using ReShade:**

3.1 Enable DepthAlpha.fx in ReShade. Check `Colorize Transparency` and adjust the `Range` until your item is the only visible object in the scene.

<img src="https://1427525421-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4gzcGtLrr90pVjAWVdTc%2Fuploads%2Fgit-blob-cfb79a90a7cfd6327f259076c028b54a90fed4ab%2Ficon_tutorial_05_depthalpha.png?alt=media" alt="" data-size="original">

3.2 Disable `Colorize Transparency` and take the screenshot using ReShade (**not** the built-in Photo Mode).
{% endhint %}

4. Switch to the pose tab and cycle through all appearances of your item and take a screenshot of each one (make sure you haven't skipped any!).

{% hint style="info" %}
You can use [AppearanceCreatorMod](https://www.nexusmods.com/cyberpunk2077/mods/10795) to switch appearances without changing the tab!
{% endhint %}

### Photoshop

#### Fixing Jaggy Edges Left By DepthAlpha.fx

1. Open the first of your screenshots in Photoshop and drop all other screenshots of the item onto the one you've just opened.
2. Select the newly created Smart Objects, right click them and select "Rasterize Layers".
3. Select the first layer and hide all other layers.
4. Go to "Layer" in the menubar at the top of your screen on the left and select "Layer Mask" → "From Transparency".
5. Create a new colour fill layer and choose a colour that contrasts with your item.
6. Double click the layer mask on your first layer in the layers window to enter Select and Mask mode.
7. Make sure your View Mode is set to "On Layers" and play around with the "Global Refinements" until the outline of your item looks smooth.

{% hint style="info" %}
Smooth <5, Feather <1, Contrast 30-50, and Shift Edge of around -30% works quite well usually. Highly depends on how intricate your item is.
{% endhint %}

<figure><img src="https://1427525421-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4gzcGtLrr90pVjAWVdTc%2Fuploads%2F59ihl7ThoYLOWI2jH5bF%2Ficon_tutorial_06_mask_select_comparison.png?alt=media&#x26;token=fbfbda98-343a-4001-9086-7ad6326cf3e9" alt=""><figcaption><p>Before / After</p></figcaption></figure>

8. Duplicate the Layer Mask onto your other layers.
9. From here on out, you can play around with a bunch of Adjustment Layers with Clipping Masks for each of your layers/appearances. I recommend some Levels Adjustments to set proper black and white points, as well as Black & White Adjustment Layers for items that are black, grey, silver or white and so on.
10. Once you're done with that, select each layer and its Adjustment Layers, right click them, and select "Convert to Smart Object".
11. Give each layer a meaningful name and save your image as a `.psd`.

| Adjustment Layers                                                                                                                                                                                                                                | Converted to Smart Objects                                                                                                                                                                                                                   |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ![](https://1427525421-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4gzcGtLrr90pVjAWVdTc%2Fuploads%2F7tQHFwlbyftCjoDhpz88%2Ficon_tutorial_07_adjustment_layers.png?alt=media\&token=53adb94d-8dd8-4261-9640-482f97732fce) | ![](https://1427525421-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4gzcGtLrr90pVjAWVdTc%2Fuploads%2FhZo0bv5EXYypdn3gMGJj%2Ficon_tutorial_08_smart_objects.png?alt=media\&token=cc32f76f-f9bf-4c90-a512-a8741569cc35) |



#### Creating The Actual Icon

1. Open [this](https://github.com/CDPR-Modding-Documentation/Cyberpunk-Modding-Docs/blob/main/.gitbook/assets/item_icons.psd) `.psd` and import the Smart Objects of your icons into it. The `.psd` is based on the `preview_icons.xbm` found in [manavortex](https://www.nexusmods.com/cyberpunk2077/users/1630319)'s [Archive XL item additions and guide](https://www.nexusmods.com/cyberpunk2077/mods/8268) and can be easily used with projects based on the [guide](https://wiki.redmodding.org/cyberpunk-2077-modding/for-mod-creators/modding-guides/items-equipment/adding-new-items).
2. With all layers selected in Photoshop, transform them so that the longest side is 158px.
3. Align each item to the centre of each grey square.
4. Hide all other layers except your icons.
5. Now save the image as a `.png` in the raw folder of your WolvenKit project.
6. Import the `.png` into your WolvenKit project with the `TEXG_Generic_UI` `TextureGroup` setting and make sure that "Transparency from alpha channel" is enabled.

<figure><img src="https://1427525421-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4gzcGtLrr90pVjAWVdTc%2Fuploads%2FRJWJK4lzexF6fAVsu5f4%2Ficon_tutorial_09_align_icons.png?alt=media&#x26;token=3e3d15f8-be12-43b7-acd4-8542ec4c2101" alt=""><figcaption></figcaption></figure>

## Generating the inkatlas

{% hint style="info" %}
If you're missing the menu entry, you need to update Wolvenkit (download [stable](https://github.com/WolvenKit/Wolvenkit/releases) | [Nightly](https://github.com/WolvenKit/WolvenKit-nightly-releases/releases)).
{% endhint %}

1. Create an icon for each of your item's colour variants. Keep the [#image-dimensions](#image-dimensions "mention") in mind - if you save your files with the right aspect ratio or in the right size, you won't have to resize them later.

{% hint style="warning" %}
The .png files need to be named exactly like the `atlasPartName` property in the yaml.
{% endhint %}

In Wolvenkit, select File -> Add Files... -> Generate .inkatlas \
![](https://1427525421-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4gzcGtLrr90pVjAWVdTc%2Fuploads%2FXiUqqdARPxl1IRMPItzW%2Fimage.png?alt=media\&token=55e76971-f32b-4693-a551-b9933cd2e2a6)

2. Fill the dialogue like this:\
   ![](https://1427525421-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4gzcGtLrr90pVjAWVdTc%2Fuploads%2FEQ0M551SslrYp32v9oU1%2Fimage.png?alt=media\&token=2156b427-1ca8-491e-a3e0-ccc6e922f67d)\

3. Click the "Finish" button
4. Wolvenkit has generated two new .png files for you. Import them via the Import Tool.
5. Check your newly-generated inkatlas. You should see a preview, and everything should in general be fine.

<figure><img src="https://1427525421-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4gzcGtLrr90pVjAWVdTc%2Fuploads%2FYEvkYKQ8mKS55Ness8PI%2Finkatlas_icon_to_slot_assignment.png?alt=media&#x26;token=cfc6f398-466c-47c0-a553-beb800ca27b9" alt=""><figcaption></figcaption></figure>

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

{% hint style="success" %}
Congratulations! You now have preview icons!
{% endhint %}

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

## Using it

You can now hook up your preview icon(s) to whatever mod you are making.

{% hint style="info" %}
If you want to use gendered preview icons, check [here](adding-items-preview-images/gendered-preview-icons). In this case, you do **not** add an icon record to your item.
{% endhint %}

### ArchiveXL: Add it to the .yaml

Check the code box below — the last three lines add a preview icon.

```
Items.my_custom_shirt_redwhite:
  $base: Items.GenericInnerChestClothing
  entityName: my_custom_shirt_factory_name
  appearanceName: appearance_root_entity_white_red
  displayName: my_shirt_localization_name_white_red
  localizedDescription: my_shirt_localization_desc
  quality: Quality.Legendary
  appearanceSuffixes: []
  icon:
    atlasResourcePath: tutorial\torso\my_custom_shirt\ops\preview_icons.inkatlas
    atlasPartName: redwhite
```

Please refer to the [ArchiveXL guide](../animations/animations/archivexl-adding-photo-mode-poses) for an explanation of the other properties, as this page will only hold information about preview icons.

* `atlasResourcePath`: relative path to your .inkatlas file
* `atlasPartName`: slot name in your .inkatlas file (which you can see in the `PartsMapping` tab)

{% hint style="warning" %}
Again, please note that indent is **crucial** here, as it determines the node structure. The first line needs to have an indent of 0, the lines from `$base` to `icon` need to have two spaces, and the lines `atlasResourcePath` and `atlasPartName` need to have four.
{% endhint %}

## That's it! Time to test!

If you run into any issues with your texture's transparency, please [check the textures import/export guide!](../textures-and-luts/images-importing-editing-exporting)
