This page will introduce you to the very basic structure of the world and the necessary tools to effectively modify the surroundings to your liking.

World Structure

The world of Cyberpunk2077 consists of nodes, which can represent pretty much anything from visible meshes, collision, lights, effects to sounds, areas dictating where NPCs can spawn and more. These are grouped together into streamingsectors which are packed inside the archive files of the game - meaning not directly editable without creating massive conflicts due to how mods modifying the same resources get handled.

Tools You Will Need

• ArchiveXL (Nexus|Wiki): Is a framework mod that allows modifying and adding resources in a non exclusive, non destructive way. In this context it handles the node removal, addition of custom sectors and includes checks to ensure that the node you're trying to remove is the one present in game.

• RedHotTools (GitHub|Wiki): Allows for inspection of nodes and objects at runtime, providing you details like nodetype, nodeinstance, the sectorpath and more.

• entSpawner (GitHub): Handles the spawning of objects that can then be converted into standalone streamingsectors. It has access to all game assets and AMM prop packs installed.

• removalEditor (GitHub): Integrates with RedHotTools to allow easily creating node removal files for ArchiveXL.

• Wolvenkit (GitHub|Wiki): Comprehensive mod creator, allows finding more detailed information about nodes e.g. finding their actors. Includes scripts to remove occlusion nodes, adding custom streamingsectors from entSpawner, adding resources like custom meshes and much more.

• Blender (Site|Wiki): 3D modeling software that enables creating custom assets that aren't already in the game.

• FreeFly (Nexus|Github): Enables quick and easy traversal of the map and getting to places you normally wouldn't be able to, includes noclip.

• All mods that these mods require to function.

• It is highly recommended to join the redmodding discord to stay up to date on new techniques and tools.

Summary

Created by @Simarilius Updated 19 March 2023 ~ Updated 7 May 2023 ~ Script updated 1 June 2023 ~

The original exporter was based on some posts by @123321 in the Discord #mapeditor channel back in May, so all credit to him for working it out in the first place.

Theres a video which outlines this process Here.

Versions and requirements

This guide was initially written with game version 1.6 of Cyberpunk 2077.

• Wolvenkit >= 8.8.1 or the latest Nightly

• Blender 3.3 or newer

• Cyberpunk add-on for Blender 1.2.0

Exporting Streaming Sectors to Blender

To export a location, you need to know its files — you can either pick them from our list or go and find them (and add them to the list, please).

1. Add all sector files that you want to edit to your project by and double-clicking them.

2. Open the

3. Open Export_Sector.wscript by double-clicking on the file name

   • You may get a pop-up: "Trying to open a system file. Should a local copy be created?" If so, click Yes.

4. Optional: Check #what-else-the-script-can-do-for-you below if you want to get fancy.

5. Click "Run" (it's on the top left of the script editor)

This will export all your .streamingsector files to glb/json for the later import into Blender.

// You can add sectors to the list, or add them to the project 
// list of sector files (paths need double slashes) you can leave empty if in project
// can use just filenames if their in the _compiled\default folder
const sectors=[
    "interior_-48-31_2_0",
    "interior_-24-16_1_1",
]

Importing to Blender

1. Import your streamingsector with the Cyberpunk Blender IO Suite. For full instructions, check the corresponding wiki page - the documentation below might be outdated.

   1. Open Blender

   2. Optional: Turn on the Blender console so you can watch the pot boil (unnecessary, but psychologically reassuring). It's under Window -> Toggle System Console

   3. Select File -> Import -> Cyberpunk Streaming Sector

   4. Open the .cdmodproj file in the root of your Wolvenkit project directory

   5. Optional: Check the "With Materials" box in the side panel This will make the process take four times longer!

   6. Wait (see the orange warning box below)

2. Optional: As the meshes will be scaled and positioned according to the map coordinates, they're probably off-screen. You can center the camera by completing the following steps:

   1. One or more meshes should still be selected. If not, do that now.

   2. Move the cursor to your selection (Hotkey: SHIFT+S)

   3. Select View → Align View → Center View to Cursor

Importing back into Cyberpunk

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)

• The latest stable release of ArchiveXL (thanks Psiberx!)

Resources

• Example mod project, including template .XL file, .streamingsector and .streamingblock - 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)

  • This will open a window which allows you to browse to the export folder of Object Spawner. this will be something like Cyberpunk 2077\bin\x64\plugins\cyber_engine_tweaks\mods\entSpawner\export You will find a JSON file named after the main group you created and exported in this folder folder

  • Select that file and Wolvenkit will create the necessary nodes, in the streaming sector, adding them to the location you selected.

  • Delete the node which was included as an example and update the index of your node to 0 if it is not already.

  • Rename the file to something unique for your mod.

  • Open the new_mod.streamingblock file in the project

  • Under the "descriptors" tab, edit the 1st entry so that the depot path points to your .streamingsector file

  • Now you need to set the streaming box for your new sector. The easiest way to figure this out is to just take the coordinates from a central object in your mod (you can find these in your .streamingsector file on each node) and add 300 units to each number for the max, subtract 300 for the min. This will need to be adjusted based on how far away you want your objects to be visible in the world.

  • rename this streamingblock file to something unique to your mod

  • Now all that's left is to edit the .xl file included in the resources section of the example so that it points to your streamingblock file. All you need to do is replace "mod\new_mod.streamingblock" with the relative path to your streamingblock.

  Once you've done the above steps, install your new mod and launch the game, if you've completed all the steps, your new objects, structure or location will spawn just like the rest of the world

• If you run into any troubles, double check the guides and then pop over to #world-editing on the cyberpunk discord server

Finding and Removing Occlusion

Author: spirit

Last update: September 24th 2024

Introduction

If you ever tried to build a structure outside of the usual game bounds and encountered textures popping in and out seemingly at random you have encountered occlusion mesh nodes. This article will explain how to find and remove them, touch on their purpose and provide starting points for optimization.

Occlusion Mesh Example:

Required Tools

• Wolvenkit 8.14.0+

• HotRedTools 1.1.4+

• ArchiveXL 1.16.9+

Instructions

In the Game

1. Navigate to the location where you want to remove the occlusion mesh nodes

2. Open the CET Menu and find World Inspector

   1. Switch to the Scan Tab

   2. Click on Scan world nodes

   3. Make sure the Group is set to All, Distance to 50m or more depending on your area, and Filter to "Occl"

3. Expand each item in the list to reveal the detailed information

[!NOTE] World Inspector cannot find all occlusion mesh nodes, so trying to remove them using Removal Editor will not remove all actual occlusion mesh nodes from the area.

In Wolvenkit

1. Create and open a new project in Wolvenkit

   1. Search and Right Click > Add selected items to project for each world sector you found in the World Inspector to your project in Wolvenkit

   2. Click on Tools > Script Manager at the top

      1. Find the "RemoveOcclusionFromSectors" script and run it

   3. An .xl file that removes the occlusion mesh nodes has now been created in your "resources" folder in Wolvenkit

   4. Open the resources directory in file explorer

   5. Move the file to {GameDirectory}\archive\pc\mod

Back in the Game

1. In the "Hot Reload" tool go to the Archives tab and click on reload extensions, now you need load a game save and the occlusion mesh nodes should be removed.

Troubleshooting

If you followed the steps but not all of the occlusion has been removed you can try:

• restarting your game fully

• increasing the "Distance" in "World Inspector" and redo the steps from that point on

• adding world sectors that World Inspector doesn't find occlusion mesh nodes in

Lastly if none of these worked you can join the Discord where we can troubleshoot the issue together.

The Purpose of Occlusion Mesh Nodes

[!NOTE] This section, but especially the optimization part needs further testing and documentation.

They are a performance optimization method that selectively blocks textures that are behind it from being rendered therefore improving fps. But since most other objects also do that the performance loss from removing them in a select few world sectors is almost negligible (assuming there are no holes in the world or they are filled with other props).

Optimization

The simple approach to optimize performance is to add each world sector separately and test which ones remove only the occlusion that is in your way. Another more advanced option is to add new occlusion mesh nodes that consider your structure.

Summary

Published: February 04 by Last documented edit: February 04 by

Other guides on this

You can also check out .

Step 0: Create a Wolvenkit project

1. Create a for your mod.

2. Download the Wolvenkit template project from . Download the zip file to your computer:

1. The zip file you downloaded contains a folder named source. Extract it into the root directopry of your Wolvenkit project from step 1 so that it merges with the existing folder.

Step 1: Edit the .png files

Step 2: Delete those files you don't want

Step 3: Publishing

If you want to post your mod on Nexus, you might want to do two things:

• link back to this guide

Happy modding, choom!

NodeRefs are kinda like bookmarks for nodes their defined in a section of the streaming sector and used to point things at each other. So for instance an elevator control panel uses a nodeRef to point to the elevator itself.

Following is pretty much a straight copy and paste of some of Psiberxs posts from the discord explaining stuff

About NodeRefs

at runtime NodeRef is a compound hash calculated from a path.

Ffirst you have to register NodeRef using an absolute path that starts with $/ you should've seen such path in sectors, something like $/03_night_city/c_watson/little_china/loc_megabuilding_a_prefab4KCU2IQ/loc_megabuilding_a_env_prefab7JTEUXY/megabuilding_a_environment_main_vs_mb_prefabZZTIINY/vs_apartment_floor_prefabW6EJ43Y/deco_prefabFKU4HJQ/megabuilding_vs_apartment1_prefab4ZYKDLY/mb_vs_apartment_env_arch_prefabT73KCQY/ceiling_fan_a_spinning_prefabIQCQMLQ the hash is calculated for every part of the path and registered in the lookup table, it's not just a single hash function call you can always use the absolute path as a reference, but there's a more convenient way using # you can register a global alias, that can be used as a reference without knowing the original path for example, if you register $/03_night_city/c_watson/little_china/#my_new_node, then you can use just #my_new_node alias to refer this node the hash of the alias depends on the original path for example, $/aaa/#my_new_node and $/bbb/#my_new_node will register different hashes if you'll use the same global alias twice, the later instance will take precedence, i.e. will overwrite the previous alias in the lookup table so it's impossible to calculate NodeRef just from alias like #my_new_node, it can be done only knowing the absolute path used for registration

How to register NodeRefs

every time engine parses any absolute path it registers a NodeRef in the lookup table on this screenshot entry 6 will create a new NodeRef that can be used later entry 7 won't do anything

How to link NodeRef to node instance

first of all you have to register NodeRef by adding it to nodeRefs then you have to fill the hash in QuestPrefabRefHash property, which is actually globalNodeId containing NodeRef hash (surprisingly it can be found in metadata.json from redmod, but not in runtime RTTI)

Summary

Created by @Krat0es Published October 10 2022

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

Requirements

• the most recent Wolvenkit (stable | Nightly), at least

1. Add your sector file to the Wolvenkit project

2. Open it by double-clicking

3. Click on Sector Preview again

4. Click into the preview to highlight an object. This will print the object's node name and -index to the log.

5. In the list on the right, find the object that you want to delete. You can toggle the red checkmark(s) to show/hide objects in the preview

1. Go back to the WorldStreamingSector tab

2. Click on expand nodeData to find the object in the list. It is easiest to go by index, which should have been printed to the log when you selected the object in step 4.

3. Expand the node and find Position, Orientation and Scale:

You can now

• change the object's coordinates or scale

• delete the object from the world by right-clicking the node and deleting it (see screenshot deletus)

Troubleshooting

My deleted object is low-resolution now!

That means that it has a proxy mesh, which you also need to delete.

1. Search the game for your sector file's name without the last digit Example: You're editing interior_-23_15_0_1 You're searching interior_-23_15_0_

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)

Summary

Published: January 20, 2024 by Last documented update: January 25, 2024 by

This guide shows you how to enable an object's embedded collision for entities without (items that you can walk through).

It's a direct follow-up to .

Wait, this is not what I want!

• If you want to create for AMM, check the corresponding guide. Note that this mechanism applies for them as well!

Requirements

• (screenshots say 1.4, but it's the mod title that wasn't updated in 1.5 )

• You know how to

• and updated file created by KeanuWheeze - this will help us to edit new ent files with embedded collisions.

• You need a

Find an eligible object

Not every object contains an embedded collision, so we first need to check if your desired mesh has one.

• Once in-game, search for the item you want to spawn; I'll be using base\meshes\base_environment_decoration_furniture_industrial_industrial_table_industrial_table_g.ent

• In the Spawned menu, click on Copy Path to clipboard to get the current .ent path.

• • If the selected entity is from allmeshes (starts with base\meshes\ ), then there is probably only 1 entPhysicalMeshComponent called custom_mesh

  • If not, it means your entity is from the vanilla game; in this case, search for the component that has Mesh in its type (entPhysicalMeshComponent, entMeshComponent, etc...)

• In the mesh, click on the blue arrow to open the mesh in a new tab (we don't need to add the file)

• Decisive moment: Open parameters and look for a meshMeshParamPhysics

Activate mesh collisions

Turning it on is pretty simple; we only have 2 things to change, all in the .ent file previously added:

• Update the filterData and change the values like in the screenshot. Those values determine which entities can collide with, and how to simulate the collision.

• Change the navigationImpact setting to Blocking. (Other values exist; they haven't been documented, but you may have fun with them.)

• Optional: depending on the item, you may want to enable (or not) lighting-based shadows. You can do so by setting these 3 properties to Always.

In our test case, I renamed the file as mod\embedded_collision_test\decoration\industrial_table_g.ent.

• If the path of your ent changed, don't forget to add it to the allPaths.txt file used by Object Spawner.

Summary

Created by @manavortex Published in October 2023 Last (documented) update: December 2023

This guide will show you how to remove items from the world via ArchiveXL.

Difficulty: You know how to read. Everything else will hopefully become clear !

Requirements

>= 1.8.0

If you want to do it in Blender: >= 1.5.0

Otherwise:

RedHotTools and ArchiveXL

This section will walk you through the process of creating an .xl file to remove objects from the game world.

This guide will feature the manual process, which can get tedious if you want to remove at scale. There are two ways to automate the process:

• Wheeze's Removal Editor ()

• Generating the .xl file via Blender (see

Although you can also work directly in your archive/pc/mod directory, you should , so that you can easily pack your mod for Nexus deployment.

Video guide

Visual learners, celebrate: OUiJIXOU and Proxima Dust made video guides for this!

2. Create an .xl file in your Wolvenkit Project's resources folder and name it after your world deletion (e.g. delete_pacifica_fast_travel_terminal.xl).

We'll fill in the information in Step 3, this is how it will look:

1. Paste the following code into your .xl file:

1. Adjust the .xl file. Mind the leading spaces!

   1. for path, put the full path to your world sector as seen in RedHotTools (1., yellow on screenshot - base\worlds\03_night_city_compiled\default\exterior_-35_-35_0_0.streamingsector)

   2. for expectedNodes, put the number of nodes in this sector (2., pink, 503 in the screenshot)

   3. For each node that you want to delete, add an entry under nodeDeletions: - index (the - is important): the node index (3., violet in the screenshot) type: the type of the node (4., turquoise in the screenshot)

Testing

2. Save the .xl file

If everything worked, your object should now be gone.

Packing your mod for Nexus

If you have been working directly in your archive/pc/mod directory, do not right-click on your .xl file and pack it. You have to create the following folder structure and then pack the archive folder:

If you don't do that, you will drown in comments from confused users who don't know how to install your mod.

Blender and ArchiveXL

Prerequisites: Deleting the objects

2. Optiona, but recommended: Save the blend file. There's no real way to undo stuff right now other than deleting them from the list by hand, and re-importing is tedious. If you save the file, you can use File -> Revert to undo all your changes.

3. Select and delete the objects that you want to get rid of.

Now it's time to get exporting.

Adjust the sector collections' properties

1. In the Scene Collection (usually at the top right of your Blender viewport), select a sector collection.

First, you need to find out the number of nodes in your sector. We will do that in Wolvenkit.

1. Find the correct sector file and open it in Wolvenkit. (You can copy the name from the filepath field in Custom Properties — the file should be in your project from your earlier export.)

2. In the CR2W editor, find the nodes property and look at the count. That number needs to go into your new property in Blender.
3. Click New to add a new property. It will be called prop and have a value of 1.000.

4. Click the gear and add the property's properties: Type should be Integer Property Name shoudld be expectedNodes Default Value, Min, and Max should be the number of nodes from your sector file. After you have made those changes, click OK.\

1. The value of your new property will probably still be 1 until you click in the field - then it will be updated with the only value possible.

2. Repeat this step for every sector file.

Generating an .xl file

1. Switch to Blender's Scripting perspective and create a new file.

3. Edit the value of output_filename — it has to be a valid path (and can even be your Cyberpunk mod directory).

1. When you're done, click the ▶ button in the toolbar to run the script.

Removing potential false positives

This step is optional, but recommended, as the script might add nodes to the deletion list that you want to keep.

2. Search for worldEntityNode Keyboard shortcuts to find all in document in Notepad++: Ctrl+F - Alt+D

3. Check the comment on top of a block to find out what it is.

4. If you want to keep something, remove the entire block from the .xl file (see screenshot).

1. Put the .xl file into archive/pc/mod and start the game. (Don't put your Wolvenkit project, you don't need all that sector garbage!)

That's it! You changed the world - literally! Happy modding, choomba!

Packing a Wolvenkit project

To add the .xl file to a Wolvenkit project, simply put it into the source/resources folder and pack. Your mod will include only text files and be really tiny - ArchiveXL does all the heavy lifting.

If your zip for Nexus contains an .archive file, you've done something wrong here!

Converting older node removals

You need:

• a Wolvenkit project with the sectors exported to .json

• an .xl file

Change the following lines in the script:

While you can write directly to your output file, you really should not.

Troubleshooting

My edits aren't showing up!

Check the ArchiveXL log (you can find it in Cyberpunk 2077\red4ext\plugins\ArchiveXL\ArchiveXL.log). For every block in your .xl file, you should see an entry like this:

If you don't see those entries:

• Make sure that your file

  • has the extension .xl

  • is located in archive/pc/mod or loaded as part of a REDmod (why are you doing this to yourself? You're testing. Put it in archive/pc/mod!)

• Make sure that ArchiveXL is up-to-date and working

If you see "failed to patch" entries instead:

Summary

Published: Nov 10 by Last documented update: Nov 24 by

This page will explain the actual names and details of worldNodeDataBuffer in .streamingsector files

Wait, this is not what I want!

• If you want to learn about , please check the corresponding section.

• explained.

You can find some info in <Cyberpunk 2077>\tools\redmod\metadata.json

The actual class name of worldNodeData is worldCompiledNodeInstanceSetupInfo

The actual fields names are:

• QuestPrefabRefHashis globalNodeId (it can be created in nodeRefs block or reused already existing)

• MaxStreamingDistance is secondaryRefPointDistance

• UkFloat1 is streamingDistance

• Pivot is secondaryRefPointPosition

• Bounds.Min is streamingRefPoint

• Bounds.Max is not listed, looks like there's no Box/Bounds, but two different vectors

(c) psiberx

Summary

Created by @Krat0es Last documented update: March 21, 2023 by Doctor Presto

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

Wait, this is not what I want!

• If you want to learn how to How to open garage doors, please check the corresponding guide.

Requirements

• Wolvenkit 8.8.1+

• Object Spawner

Recommended

• allmeshes.archive and updated allpaths 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.

• Use the tools in the "Spawned" tab to move and position your objects. It is a good practice to give each object a unique and recognizable label. Try to proceed slowly and always keep in mind that you may want to move/change or otherwise edit these components later on so a few extra moments to keep them organized and labelled can save you a lot of frustration later on.

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, fake them, or enable 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. You can use Object Spawner's export function to create a .JSON file which you can use to add these objects permanently to the world. (The Export button can be enabled in Object Spawner's 'Settings' tab)

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.