# AMM: Textured items and Cyberpunk Materials using Custom Props ## Summary **Published: February 11 2023 by** [mana vortex](https://app.gitbook.com/u/NfZBoxGegfUqB33J9HXuCs6PVaC3 "mention")\ **Last documented update**: Mar 18 2024 by [mana vortex](https://app.gitbook.com/u/NfZBoxGegfUqB33J9HXuCs6PVaC3 "mention") This guide will walk you through **importing 3d objects** into Cyberpunk 2077, which can then be spawned via [Appearance Menu Mod](https://www.nexusmods.com/cyberpunk2077/mods/790). **Level of difficulty:** You know how to read. ### Wait, this is not what I want! * Check [porting-3d-objects-to-cyberpunk](https://wiki.redmodding.org/cyberpunk-2077-modding/for-mod-creators-theory/3d-modelling/porting-3d-objects-to-cyberpunk "mention") for an import guide, but don't forget to come back here once you're done! * You can learn more about materials under [materials](https://wiki.redmodding.org/cyberpunk-2077-modding/for-mod-creators-theory/materials "mention"). * If you want to understand material assignment, 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")-> [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](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 "mention") * If you only want to know how to apply Cyberpunk materials to parts of your mesh, check "[Splitting off submeshes](#splitting-off-submeshes-mildly-advanced)" below. * For a guide about changing materials, check [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") * If you just want to use a textured material, check [using-a-textured-material](https://wiki.redmodding.org/cyberpunk-2077-modding/modding-guides/items-equipment/editing-existing-items/changing-materials-colors-and-textures/using-a-textured-material "mention") * If you want to dig deeper into [multilayered](https://wiki.redmodding.org/cyberpunk-2077-modding/for-mod-creators-theory/materials/multilayered "mention"), check our guide for [custom-multilayermasks](https://wiki.redmodding.org/cyberpunk-2077-modding/modding-guides/textures-and-luts/custom-multilayermasks "mention") * Find a look-up list of cool materials under [cheat-sheet-materials](https://wiki.redmodding.org/cyberpunk-2077-modding/for-mod-creators-theory/references-lists-and-overviews/cheat-sheet-materials "mention") * For a more detailed guide about prop creation, check [custom-props](https://wiki.redmodding.org/cyberpunk-2077-modding/for-mod-creators-theory/3d-modelling/custom-props "mention") * Or maybe you wonder [#where-to-find-models](https://wiki.redmodding.org/cyberpunk-2077-modding/for-mod-creators-theory/3d-modelling/custom-props#where-to-find-models "mention") ## **Requirements** * [WolvenKit](https://github.com/WolvenKit/WolvenKit-nightly-releases/releases), most recent for your game version ([stable](https://github.com/WolvenKit/Wolvenkit/releases) | [nightly](https://github.com/WolvenKit/WolvenKit-nightly-releases/releases)), guide was made using 8.8.1) * [Appearance Menu Mod](https://www.nexusmods.com/cyberpunk2077/mods/790) (> 2.0.2) ## Setting up the project This section is already covered in the guide for [custom props](https://wiki.redmodding.org/cyberpunk-2077-modding/for-mod-creators-theory/3d-modelling/custom-props#setting-up-the-project), using the source folder variant, or directly download [this archive](https://mega.nz/file/GUsSwSxY#Ast7L44g_YimuKrcbwNCLvYL_DworhpEQsaH05RNGJw) and extract it into your Wolvenkit project. Optional: Complete the [creating another prop](https://wiki.redmodding.org/cyberpunk-2077-modding/for-mod-creators-theory/3d-modelling/custom-props#creating-another-prop) section from the custom props guide, or alter one of the two existing template items. {% hint style="success" %} 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. {% endhint %} Delete obsolete files (Windows Explorer or WKit): * `amm_props\template` * `amm_props\template_no_variants\template_no_variants_multilayered.mesh` * `textures\6_layers.mlmask` * `textures\6_layers.mlsetup` ## Importing a mesh ### Step 1: Exporting > The first step to importing a mesh is exporting a mesh > > [*Rache Bartmoss, ca. 2024*](#user-content-fn-1)[^1] We can't create .mesh files from scratch, so we'll **overwrite** an existing file. Here's how: In Wolvenkit, open the [Export Tool](https://app.gitbook.com/s/-MP_ozZVx2gRZUPXkd4r/wolvenkit-app/usage/import-export) (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 1. **Optional:** Download [this archive](https://mega.nz/file/vd0X3Yaa#tcakXF6_t0k_EouthuKcJSPL3o2nI6b_zVWi528Kv5k) - I have prepared it for import.\ It contains both the original glb from sketchfab and the version I prepared for import:

File content as archive, April 8 2023

2. Use the Windows Explorer to copy these .glb files and textures into the same folder as the ones you exported in the previous step. 3. Replace the files from your export with the files from your download. The names need to be exactly the same. Use `baseball_02_d.png`, as the other one doesn't have transparency. {% hint style="info" %} The import/export process has [its own guide](https://wiki.redmodding.org/cyberpunk-2077-modding/for-mod-creators-theory/3d-modelling/exporting-and-importing-meshes). There's also a [troubleshooting page](https://wiki.redmodding.org/cyberpunk-2077-modding/modding-guides/textures-and-luts/self-made-normal-maps/troubleshooting-normal-maps) if you're stuck. {% endhint %} 4. Now that all files are in place, open the [Import Tool](https://app.gitbook.com/s/-MP_ozZVx2gRZUPXkd4r/wolvenkit-app/usage/import-export) in Wolvenkit (Tools -> Import), and re-import the files. The Wolvenkit preview should show your new imported mesh. 5. optional: You can now [install the mod](https://app.gitbook.com/s/-MP_ozZVx2gRZUPXkd4r/wolvenkit-app/menu/toolbar#install-and-launch) and spawn the prop. The next step is to [assign materials](#material-assignments) to the object. #### Wait, where did Step 2 go? {% hint style="success" %} 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. {% endhint %} ### Step 2: Processing the downloaded mesh {% hint style="info" %} All of these steps will be taking place in Blender. If this is your first time and you're lost, check out [blender-getting-started](https://wiki.redmodding.org/cyberpunk-2077-modding/for-mod-creators-theory/3d-modelling/blender-getting-started "mention") {% endhint %} 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): ``` Scene Collection ▽ submesh_00_LOD_1 ▽ submesh_01_LOD_1 ▽ submesh_02_LOD_1 ▽ submesh_03_LOD_1 ``` * LOD\_1 indicates the [level of detail](https://wiki.redmodding.org/cyberpunk-2077-modding/for-mod-creators-theory/files-and-what-they-do/level-of-detail-lod). You only care for LOD\_1. * The submesh numbers are important for [material assignment](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) in Wolvenkit. {% hint style="success" %} The easiest way to get there is by running [this python script](https://raw.githubusercontent.com/manavortex/code_snippets/master/py/cyberpunk/util/prepare_submeshes_for_export.py) (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 {% endhint %} {% hint style="danger" %} 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 with ten submeshes, make of this what you will. {% endhint %} #### Submesh by material Sketchfab meshes often use dozens of submeshes, but we want to split by cyberpunk's logic: {% hint style="info" %} 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. {% endhint %} I've always found it easiest to join all meshes into a single one: * In **Object Mode**, select all meshes but one (Hotkey: `A` , then `Ctrl+`click a mesh to deselect it) * Select the last mesh (hold `Shift` or `Ctrl`) * Press `Ctrl+J` to merge everything into that last mesh * Switch to Edit Mode * Select everything (Shortcut: `A`) * Separate (Shortcut: `P`) and select "By Material"\ ![](https://1427525421-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4gzcGtLrr90pVjAWVdTc%2Fuploads%2Fgit-blob-b0f231783afa0e4694025c42f6a12d16c3bd1f4b%2Fseparate_by_material.png?alt=media) * **Optional**, but recommended: run the script again to get properly numbered submeshes. This will let us assign one material per "section" of your mesh. {% hint style="info" %} 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. {% endhint %} #### 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 [baseball example](https://mega.nz/file/vd0X3Yaa#tcakXF6_t0k_EouthuKcJSPL3o2nI6b_zVWi528Kv5k): 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). {% hint style="info" %} You can duplicate your selection first (`Shift+D`, `ESC`) {% endhint %} Now, switch back to Object mode and select your new mesh before going back to Edit Mode. Make sure to [**scale**](https://wiki.redmodding.org/cyberpunk-2077-modding/modding-guides/self-made-normal-maps#step-0-preparing-the-viewport) 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 [correctly name your new submesh](#step-2-processing-the-downloaded-mesh), or run [the script](https://raw.githubusercontent.com/manavortex/code_snippets/master/py/cyberpunk/util/prepare_submeshes_for_export.py) again. #### Unparent {% hint style="success" %} You can complete unparent + apply transformations via [Blender script](https://github.com/manavortex/code_snippets/blob/master/py/cyberpunk/util/prepare_submeshes_for_export.py): Switch to the Blender "Scripting" perspective, create a new file, paste the code from mana's github, and click the play button. {% endhint %} 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 [apply transformations](#applying-transformations) afterwards. Alternatively, you can scale the vertices in edit mode. {% hint style="info" %} 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. {% endhint %} {% hint style="success" %} If you need a reference object, you can use this [lightsaber](https://mega.nz/file/aJkXxTaT#3hCUT_qULkYu4VfL3QVXYE8NJ77sTPCftZiTPRs_6a0) from my [props](https://www.nexusmods.com/cyberpunk2077/mods/7391). {% endhint %} #### Origin Keep in mind that your prop will rotate around the world origin, and position it accordingly.

AMM will rotate your object around the point 0,0,0.

{% hint style="success" %} Once you are done, import the glb file over your original mesh (you can consult the [troubleshooting section ](#troubleshooting)below). Your import has been successful when the preview in Wolvenkit changes (you might have to select another file first). {% endhint %} ## Material assignments {% hint style="info" %} For an overview of materials that you might want to use for something, check [here](https://wiki.redmodding.org/cyberpunk-2077-modding/for-mod-creators-theory/references-lists-and-overviews/cheat-sheet-materials). 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. {% endhint %} ### Setting up our materials {% hint style="info" %} You can find explanation and documentation about materials [here](https://wiki.redmodding.org/cyberpunk-2077-modding/for-mod-creators-theory/materials). {% endhint %} #### Add a new material entry 1. Select the entry "texture" inside the array `materialEntries` 2. Duplicate it 3. Select the new entry 4. Change the name to `mlsetup` 5. Change the index to `1` #### 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 ``` 0 mlsetup 1 textured ``` #### Transfer the material 1. Open `baseball_textured.mesh` 2. Find the CMaterialInstance "texture" inside `localMaterialBuffer.materials`. 3. Select it, then copy it via right-click (Copy (Selection) from Array/Buffer) 4. Switch to `baseball_tml.mesh` 5. Select `localMaterialBuffer.materials` 6. Paste the textured material (Right click, Paste (Selection in) to Array/Buffer) 7. You can now delete the second mesh, as you don't need it anymore. #### Change the material parameters Let's update paths and values. Still inside of `localMaterialBuffer.materials`, change the following properties: | Material | name of KeyValuePair | value | | -------- | -------------------- | --------------------------------------------------------------------------------------------------------- | | textured | Normal | `your_name\your_prop_pack\baseball\baseball_n01.xbm` | | | BaseColor | `your_name\your_prop_pack\baseball\baseball_d01.xbm` | | mlsetup | GlobalNormal | `your_name\your_prop_pack\baseball\baseball_n01.xbm` | | | MultilayerMask | delete it | | | MultilayerSetup | `base\characters\garment\gang_nomad\legs\l1_021_pants__cargo_computer\textures\leather_red_basic.mlsetup` | 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 [here](https://wiki.redmodding.org/cyberpunk-2077-modding/items-equipment/editing-existing-items/changing-materials-colors-and-textures#exporting-the-.mlsetup). {% hint style="success" %} 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! {% endhint %} ### Let's set up our entity file 1. Open the baseball's entity file (`your_name\your_prop_pack\baseball\baseball.ent`). 2. Open the `components` array. 3. Select the second component (`amm_prop_slot1`) 4. Change the mesh -> depotPath to the path of your baseball mesh (`your_name\your_prop_pack\baseball\baseball_ml.mesh`). 5. Leave `meshAppearance` on `default`, unless your mesh has multiple appearances: This is where you select which entry in the mesh's appearance array will be used. 6. **D**elete the other **`amm_prop_slot`** components. (These are where you would add more mesh files to your prop - but keeping them makes your prop be full of glowing cubes). 7. Save the entity file. {% hint style="warning" %} 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. {% endhint %} ### 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: ```lua return { modder = "your_name", unique_identifier = "your_prop_pack", props = { { name = "Baseball", path = "your_name\\your_prop_pack\\baseball\\baseball.ent", category = "Misc", distanceFromGround = 1, }, } } ``` {% hint style="warning" %} The "path" parameter is the relative path to your entity file, but every backslash has to be doubled. {% endhint %} "name" is what you'll search for in AMM. "distanceFromGround" is pretty self-explanatory, but I prefer it if my objects are floating. {% hint style="success" %} Save the lua file, install your mod, and launch the game. Time to test! {% endhint %}

Not a moon

## Material assignments For an explanation how materials are assigned to a mesh, check [this page](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) - this guide will just tell you what to do. {% hint style="info" %} You can copy entire materials between meshes: select one, right-click, and pick one of the "copy from…" entries. {% endhint %} {% hint style="success" %} Open template\_no\_variants\_textured.mesh in WKit. All of the following operations will take place in that file. {% endhint %} ### 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 [material entries](#material-entries). #### 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`: {% hint style="info" %} 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 **in the same order** as your submeshes — if you're uncertain, check the "Mesh Preview" tab * The names should be lower case without spaces and special characters. Numbers are fine! {% endhint %} ### Material entries 1. Find the array `materialEntries` at the root level of the mesh and open it. It will have two entries:\\
2. 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 [here](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#chunkmaterials) for an explanation). You can have **local** or **external** materials or a mix of both; check [this page](https://wiki.redmodding.org/cyberpunk-2077-modding/for-mod-creators-theory/files-and-what-they-do/file-formats/materials/re-using-materials-.mi#maximally-lazy-external-materials) for an explanation. {% hint style="success" %} 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 [here.](https://wiki.redmodding.org/cyberpunk-2077-modding/modding-guides/items-equipment/editing-existing-items/changing-materials-colors-and-textures) {% endhint %} ### Setting up the materials Find the array `localMaterialBuffer/materials` and open it. It contains two materials. Wolvenkit will display the names corresponding to the [material entries](#material-entries) so you can see which is which. {% hint style="info" %} For an explanation of material parameters, see [this page](https://wiki.redmodding.org/cyberpunk-2077-modding/for-mod-creators-theory/materials). {% endhint %} 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 [here](https://wiki.redmodding.org/cyberpunk-2077-modding/items-equipment/editing-existing-items/changing-materials-colors-and-textures#exporting-the-.mlsetup). * Select `mat_ingame` * Expand the material and its `values` array * Delete the parameter `MultilayerMask` * GlobalNormal: Re-use the same as your textured material (by default: `tutorial\amm_props\template\textures\template_01_n.xbm`) * **MultilayerSetup**: Set it to `base\characters\garment\gang_nomad\legs\l1_021_pants__cargo_computer\textures\leather_red_basic.mlsetup`

Not a moon

#### 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` * ```

Also not a moon

``` The possibilities are basically endless, so go and explore them already! For a nifty list with materials to get you started, check [here](https://wiki.redmodding.org/cyberpunk-2077-modding/for-mod-creators-theory/references-lists-and-overviews/cheat-sheet-materials).\ For a guide on creating AMM props, see [here](https://wiki.redmodding.org/cyberpunk-2077-modding/for-mod-creators-theory/3d-modelling/custom-props). ## Troubleshooting This section will only cover troubleshooting steps for this guide. For general 3d model troubleshooting (including import errors), see [here](https://wiki.redmodding.org/cyberpunk-2077-modding/for-mod-creators-theory/3d-modelling/troubleshooting-your-mesh-edits). ### 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`) * Check your mesh's **face orientation** in Blender — inside-facing meshes are usually transparent. * Check your mesh's chunkmasks in the .ent file: maybe you have accidentally hidden a submesh? 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 [scaling](#scale-it) in Blender and make sure that you have [applied transformations](#applying-transformations). ### 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. [^1]: What? He never said that. Did he? Who can keep track?