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

ArchiveXL >= 1.8.0

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

Otherwise: RedHotTools >= 0.5.2

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 (Link on GitHub, also has documentation there)

• Generating the .xl file via Blender (see Blender and ArchiveXL

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!

1. Find the node information in the Inspect tab of RedHotTools (see Finding Locationsfor a detailed guide)

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

   • You can edit this file in Wolvenkit or in a text editor like Notepad++

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

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

streaming:
  sectors:
    - path: your\path\from\red_hot_tools\ex_in_terior_99_99_0_0-streamingsector
      expectedNodes: 999
      nodeDeletions:
        # this is a comment
        - index: 0
          type: worldNodeType

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

1. Optional, but recommended: Run your XL file through yamllint

2. Save the .xl file

If everything worked, your object should now be gone.

Otherwise, check the Troubleshooting section.

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:

- archive
  - pc
    - mod
      - your_mod_name.xl

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

1. Hit up Editing locations in Blender and follow the instructions to import your sectors into Blender.

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.

1. Below the viewport in the right side panel, switch to the Collections tab and expand the Custom Properties header. You need a property with the name of expectedNodes (green box). If you have one, you can proceed to Generating an .xl file. If you don't have one, keep reading.

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.

2. Open this link (mana's github) and copy the contents into Blender's editor.

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.

You now have an .xl file. If you put it into archive/pc/mod, the game should load it. Otherwise, check the Troubleshooting section of this guide.

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.

1. Open the generated .xl file in a text editor such as Notepad++.

2. Search for worldEntityNode &#xNAN;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 can convert node removal scripts from ArchiveXL 1.8 format to 1.9 format by running this Python script on the file.

You need:

• a Wolvenkit project with the sectors exported to .json

• an .xl file

Change the following lines in the script:

# the wolvenkit project with your sector json files
wolvenkit_project="F:\\CyberpunkFiles\\world_editing\\apartment_glen_cleaned_up"

# the file that you want to convert
original_file="C:\\Games\\Cyberpunk 2077\\archive\\pc\\mod\\apartment_glen_cleaned_up.archive.xl"

# the file that you want to write to
output_file="C:\\Games\\Cyberpunk 2077\\archive\\pc\\mod\\apartment_glen_cleaned_up.converted.archive.xl"

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:

[info] |Streaming| Patching "base\worlds\03_night_city\_compiled\default\quest_2467054678ccf8f6.streamingsector"...

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!)

• Check if the syntax is valid by running it through yamllint

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

If you see "failed to patch" entries instead:

Check the expectedNodes entry inside your .xl file against the sector files inside Wolvenkit as per Adjust the sector collections' properties.

Usage

• AISpot Nodes define workspots that NPCs created via communities can use

• A workspot is simply a location at which a NPC will play a set of animations

Requirements

Tools

• (v.0.91 or newer)

• (1.15.0 or newer)

• (With latest version of Object Spawner import script)

Knowledge

• You need to have a basic understanding of:

  • Working with WolvenKit

  • Using Object Spawner (Spawning things and into WolvenKit)

Spawning AISpots

• In order to spawn a new AISpot, select the corresponding spawn category in Object Spawner:

  • AI -> AI Spot

• When you spawn an AISpot, it will by default use Judy to preview the animation

  • This may not always work (Judy will just stand there), since not all workspots support all body rigs

  • For more information on this, see below

Previewing Options

• To know what rigs a workspot supports, take a look at the AI Spot -> Previewing Options -> Supported Rigs header

• Here you can also change whether you want a NPC to preview the spot, and also which NPC should do so

  • A list of all NPC records can be found in Object Spawner Entity -> Record (Search for Character.)

• Additionally, you can change the speed of the animation during the preview

  • This is helpful since each time you move the spot, the animation will restart

Spot Options

• Is Infinite: If set to false, the NPC will try and go to the next AISpot defined in its community entry, once it is done with the current one

• As mentioned above, you must assign a unique NodeRef to your AISpot, in order for it to be useable

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 .

Versions and requirements

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

• >= 8.8.1 or the latest

• or newer

Exporting Streaming Sectors to Blender

To export a location, you need to know its files — you can either pick them from or (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 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. 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

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.

• VolumetricSelection2077 (GitHub): Quickly and easily remove parts of the world using an in game selection box.

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

Requirements

Tools

• Object Spawner (v.0.8. or newer)

• ArchiveXL

• Codeware (1.14.1 or newer)

• TweakXL

• WolvenKit (With latest version of Object Spawner import script)

Knowledge

• You need to have a basic understanding of:

  • Working with WolvenKit

  • Creating tweaks using TweakXL (.yamlfiles)

  • Using Object Spawner (Spawning things and importing into WolvenKit)

TweakXL Setup

• In order to define the name and the district of your fast travel point, it needs to point to a FastTravelPoints record

• This means you will need to create a custom record using TweakXL

• The below snippet contains the definition for a new one:

FastTravelPoints.customPoint:
  $base: FastTravelPoints.bls_nth_dataterm_01
  displayName: "LocKey#123" # Here goes the name of the FT Point, is a LocKey
  district: Districts.Watson # Can be any District record

• Place it in a new .yamlfile inside Cyberpunk 2077\r6\tweaks

• Modify the snippet for your custom FT point (Especially change the name of the record to something unique, e.g. FastTravelPoints.NAMEOFTHELOCATION)

Spawning Nodes

• In order to have a working FT point you need two nodes:

  • worldEntityNode, the terminal itself

  • worldStaticMarkerNode, location where the player gets teleported to (Any other type of node technically works too)

FT Point

• We will use base\gameplay\devices\fast_travel\data_term_1.ent, you can find it under Entity -> Entity Templatein Object Spawner

• Optionally choose a appearance

Static Marker

• Spawn a static marker, you can find it under Meta -> Static Markerin Object Spawner

• Place it in a fitting spot in front of the terminal

• Assign a custom NodeRef to the static marker:

  • In the properties section, inside the World Nodeheader

  • Make sure the NodeRef is unique

  • E.g. $/ft/custom/marker

Setting up instance data

• In order to tell the FT Point what marker to use, and what record to use, we will use entity instance data

• Open the Entity Instance Dataheader of the FT Terminal

• Expand the entry DataTerm | Entity

  • Locate and expand the linkedFastTravelPointheader

  • Set markerRefto the NodeRef of the marker ($/ft/custom/marker)

  • Set pointRecordto the custom FastTravelPointsrecord (FastTravelPoints.customPoint)

Finishing up

• You should now have the following:

  • A .yamltweak file containing the custom FastTravelPointsrecord

• An Object Spawner group containing:

  • The fast travel terminal entity node, with entity instance data linking it to the marker and the custom record

  • The marker node, with a custom NodeRef assigned

• Now simply export your group from Object Spawner, and import into WKit using the Object Spawner import .wscript

Requirements

Tools

• Object Spawner (v.0.8. or newer)

• ArchiveXL (1.20 or newer)

• Codeware (1.14.1 or newer)

• WolvenKit (With latest version of Object Spawner import script)

Knowledge

• You need to have a basic understanding of:

  • Working with WolvenKit

  • Using Object Spawner (Spawning things and importing into WolvenKit)

Spawning nodes

Overview

• In this guide, we will build a simple elevator with 2 floors

• For this we will need 3 device nodes:

  • An elevator object

  • Two elevator terminals

• Additionally, we will need two markers:

  • One per floor

  • These determine the position to which the elevator drives

Spawning Devices

• For the elevator, we will use base\gameplay\devices\elevators\megabuilding_elevator\megabuilding_lift_1.ent

  • Spawn it as Device, and place it somewhere

• For the terminals we will use base\gameplay\devices\elevators\terminals\elevator_floor_terminal_1.ent

  • Spawn two of them as Device, and place one per stop

Spawning Markers

• For the markers, select Meta -> Static Markerin Object Spawner

• Spawn two markers

• In order to properly position them, do as follows for each marker / floor:

  • Move the elevator device spawned earlier to the position you want it to stop in

  • Right-Click the position (Under the Transform header) of the elevator device, and select Copy position and rotation

  • Select one marker, right click its position field, and select `Paste position and rotation`

  • Now you will have moved the marker into the same spot as the elevator

  • Repeat for each marker / floor

Assigning NodeRef's

• In order to link and reference all the spawned object, each one will need its own, unique NodeRef

• Expand the World Nodeheader and fill the NodeRef field with a unique string

• In the end, we will have assigned 5 NodeRef's

• For example:

  • $/terminal_top, $/terminal_bottom, $/marker_top, $/marker_bottom, $/elevator

Linking Devices

• Next we need to tell the elevator which floors it can use

• To do this, we will go to the Device -> Device Connections header of the elevator

• Add one entry for each floor / terminal

  • Fill the device class name field (On the left), with the device class name of the terminal

    • In our case this would be ElevatorFloorTerminalControllerPS, which can also be found under the device header of the terminals

  • Fill the NodeRef field with the NodeRef of the terminal that you are linking

  • Keep in mind that the elevator will see the floors in the order in which you add them, so the first one in the list should be the lowest floor

Setting up persistency

• In order for the elevator to be fully functional, the terminals must be set to be persistent

• Do this by checking the Persistentcheckbox of each terminal

Setting up instance data

• In order for each terminal to know which floor marker to use, and what its name is supposed to be, we will use entity instance data

• For each terminal, navigate to:

  • Entity Instance Data / ElevatorFloorTerminalController / persistentState / elevatorFloorSetup

  • In there, set floorDisplayNameto the LocKey that you want to be used as name (E.g. LocKey#49237

  • Set floorMarkerto the NodeRef of the floor's static marker (E.g. $/marker_bottom)

  • Optionally, use the checkboxes under doorShouldOpenFrontLeftRightto determine which doors of the elevator should open on this floor
• Optionally change the elevator speed and inital starting floor by modifying:

  • Entity Instance Data / LiftController / persistentState / liftSetup

Finishing up

• Let's recap what you should have now:

  • A elevator, spawned as Device, with its own NodeRef, and linked to both terminals (Make sure you use the terminals NodeRefs, not the markers)

  • Two terminals, spawned as Device, set to be persistent, with their own NodeRefs, and properly setup instance data (Linking them to the floor markers and with names)

  • Two static markers, each with their own NodeRef, positioned correctly

• Once you have all this, you are ready to export

• Import into WKit using the Object Spawner import script

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

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

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 geometry that is 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

Created: Feb 04 2025 by Last documented edit: Feb 04 2025 by

This page tells you about Cyberpunk 2077 world editor mod.

Wait, that's not what I want!

For more information on , check the wiki's page tree or use the "next" and "previous" buttons at the end of the page.

Witcher3 has an official tool, why doesn't Cyberpunk?

Because the ways of the CDPR are inscrutable. Keep in mind that the modding tools dropped 10 years after the initial release of Witcher 3.

Although we don't have access to privileged information, it is the general consensus in the modding community that we will see official modding tools for Cyberpunk2077 by 2030. It is a running joke that we will not need them by then.

What is entSpawner?

EntSpawner (developed by ) is the continuation of the discontinued mod .

Where can I get it?

As of February 2025, it is still in open beta and thus not published on Nexus. You can download the latest release .

Controls

Editor mode:

• Can be activated using the "3-D" icon in the toolbar

  • Snaps the main window to the right, width is changeable by dragging the left edge

  • Enables multiple things:

• Viewport camera controls:

  • All the controls are available by hovering the I-Icon in the toolbar, here the most basic ones

    • MMB (Mouse wheel button) + Drag: Rotate camera around pivot

    • MMB + Drag + Shift: Move camera

    • MMB + Ctrl: Up / Down -> Zooms in / out

    • Tab: Center camera on selected

    • LMB: Selectes the item under the mouse cursor

    • RMB: Opens the context menu (Same as before, but now also avaiable while hovering the viewport)

Viewport editing:

• Objects can be moved by dragging the axis arrows

• Additionally hotkeys are available:

  • G/R/S + X/Y/Z: Enables movement/rotation/scaling along the specified axis

  • LMB / RMB: Confirm / cancle edit

• Holding Shift while pressing the axis key will lock the editing on the specified axis. E.g. G + Shift + Z will enable movement locked to the horizontal plane

• Numeric input: After enabling editing (Rotate / Scale), input numeric values (Supports decimal and negative) to rotate / scale by that amount (Scale is applied as multiplier, rotation is relative)

  • E.g. R + Z + 90 + LMB / Enter will rotate the object by 90 on the Z axis and confirm the edit

Shift-A spawn menu:

• Can be used while edit mode is active

  • Will spawn the selected object under the mouse cursor, unless specified otherwise

  • Additionally, it is possible to drag and drop an item from the regular "Spawn new" tab into the scene, to spawn them in a specific place

Shift-D depth select popup:

• For the rare case that clicking on an object selects the wrong object, this popup can be used instead

  • Available while in edit mode and hovering the viewport

  • Gives a list of all the objects under the cursor, sorted by distance

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!

Summary

Created by Misoru

This guide will teach you how to turn a world object into a lootable container.

Requirements

• Working .streamingsector with the object you want to make lootable (if you haven't done this yet, )

Step 1: Create your loot table

Before making your object lootable, we first need to create the lootTable that we'll later reference in our .streamingsector, and add it to our Tweak .yaml. Below is an example:

LootTables.Loot_misoru_ronin_case: # Loot table identifier
  $type: gamedataLootTable_Record
  lootGenerationType: dropChance
  lootItems:
  - $type: gamedataLootItem_Record # Append a separate entry for each item you want added to your container
    dropChance: 1 # Value from 0 to 1 determining % drop chance
    dropCountMax: 1 # Max quantiy of this item
    dropCountMin: 1 # Min quantity of this item
    itemID: Items.Preset_Satara_Ronin # The item added to your loot table
  maxItemsToLoot: 1 # If more than 1 lootItems, change this number accordingly
  minItemsToLoot: 1 # ditto

Step 2: Verify your object's components

Open the .ent for the object you want to make lootable and verify its components include entries like gameInventory, gameinteractionsComponent, and GameplayRoleComponent. These components are all commonly included in .ent files for base game containers and may be a requirement.

Step 3: Identify your object in your .streamingsector

Open the .streamingsector containing your object and find its nodes entry.

Under instanceData, create handles for LootContainerObjectAnimatedByTransform, then add the lootTable we created in Step 1 and define the persistentState to LootContainerObjectAnimatedByTransformPS. Leave everything else default.

You're done!

Your object should now be a lootable container. Load up your mod and test it out. If it's not working, verify you defined your lootTable correctly (or use a base game lootTable for testing) and edited the correct .streamingsector nodes.

Usage

• When building something using Object Spawner, it will use an intermediary format optimized for editing

• In order to go from that editing focused format to the final native world edit, Object Spawner provides a workflow to make this as easy as possible

Requirements

Tools

• (1.15.0 or newer)

• (With latest version of Object Spawner import script)

Knowledge

• You need to have a basic understanding of:

  • Working with WolvenKit

  • Common sense

Sectors and Groups

• While building in Object Spawner, you are able to save things on a root-group level

  • This means you can save any group that is not contained within another group

• The game operates on sectors, which objects are assigned to what sector is an automatic process there

  • For the Object Spawner workflow, each group you saved can get turned into a sector

• A finished mod can consist of multiple root-groups / sectors

Streaming Ranges

• There are different streaming ranges, determining when objects and sectors get streamed in / out

• Object Based Range:

  • These determine when each individual object gets streamed in / out

  • It is usually dependent on the size of the object

  • Can be found under each object's "World Node" header
• Sector Range:

  • This determines when then entire sector gets streamed in / out

  • This over-rules the object based ranges, meaning when the sector streams out all objects within also stream out, even if their individual range is larger

  • Can be found in the export tab, under each groups header

Exporting

Step 1: Export from Object Spawner

1. Start by going to the "Saved" tab, and adding all the groups you want to be part of your finished mod, by using the "Add to export" button of those groups

2. Next, head over to the "Export" tab

3. Enter a project name, this will be used for the folder and file names in WolvenKit

4. Now you can specify sector specific settings:

   1. Sector Category, usually just use interior or exterior
5. Hit "Export"

Step 2: Importing into WolvenKit

1. Open your WolvenKit project (Make a new one if you do not have one yet)

2. In the top menu bar, navigate to

   1. File -> Import -> Object Spawner .json
3. In the file dialog, choose the previously exported file, named projectName_exported.json

4. Multiple files should have been generated (At least one .streamingsector, and one .streamingblock)

5. Click the "Install" button, in the top menu bar

Usage

• Communities are used to spawn almost all NPCs that aren't crowd NPCs

• As the name suggests, communities can be used to add large amounts of NPCs to the world while retaining a lot of control over:

  • What NPCs to spawn

  • Where those NPCs should be, what workspots they should use

  • What they should do during what time of day

Requirements

Tools

• (v.0.91 or newer)

• (1.15.0 or newer)

• (With latest version of Object Spawner import script)

Knowledge

• You need to have a basic understanding of:

  • Working with WolvenKit

  • Using Object Spawner (Spawning things and into WolvenKit)

  • Know how to place AISpot's, see the

General Setup

• Each community can serve a large area

  • How many NPCs and how much of an area you serve with a single community is up to you, but it is generally recommended to have one community per location

• Start by spawning a community, found under AI -> Community

  • The community should be placed in the rough area of where the AISpots that you want to use are

• In general, a community consists of the following hierarchical data:

  • Entries:

    • Each entry corresponds to one NPC template, e.g. Judy or some generic NPC

    • Phases:

      • Phases are used by quests, to switch between different setups

      • They are not of interest if you just want to place some NPCs without quests involved

      • Periods:

        • Periods define how many NPCs should be placed where, per time period

Setting up an entry

• Let's start by making our community spawn a NPC, do this by adding a new entry under the Entries header

• Here you can define a name for the entry, make sure it is unique

• Here you can also define what NPC template should be used

• Initial Phase Name and Active On Start are only of interest for quest modding, so ignore those for now

Setting up a phase

• For our example, we will only need one phase, named default

• As before, use the + [Phase] button to create a new phase for our entry

• Here you can also define what appearances the NPCs of that entry should use

  • Do this by adding more names under the appearances header

  • This is totally optional, and the default will do

Setting up periods

• This defines how many of the specified NPC should be spawned, where they should be spawned, and when they should be spawned

• As before, use the + [Period] button to create a new period for our phase

• For this example, let's create two periods

• Each period has the following options:

  • Hour: This controls when the period is active

    • E.g. If you have two periods, 8:00 PM and Day, then from 8:00 PM until 9:00 AM (That's the start of Day), the 8:00 PM period will be active, from 9:00 AM until 8:00 PM, the Dayperiod will be active

  • Is Sequence: Only relevant if the AISpots are not set to be infinite. If checked, the NPCs will cycle through the specified spots in the same order as they are listed

  • Quantity: How many of the specified NPC should be spawned

  • Markings and Spot NodeRefs: This is where you actually define what AISpot's should be used, will be explained in the following section

Markings and Spot NodeRef's

Spot NodeRef's

• This list defines what AISpot's the NPCs from that time period can use

• Make sure that you have enough spots for the amount of NPCs

• Simply add the NodeRefs of the AISpots that you want to be used during this time period

Markings

• Markings allow you to simply tell the NPCs "Use any of the AISpots that have this marking"

  • You can think of a marking as a Tag that you assign to AISpots

• This makes it very easy to assign many NPCs to a large amount of AISpots, randomly

• E.g.

  • Assign the marking test_marking to all AISpots that you want to be used

  • Add that same test_marking name to the list of markings of the period

  Full example with SpotNodeRef's

• This is a full example of having either one or two Judy's spawn in specified spots, depending on the time

Full example using markings

• Using markings is especially worth it for larger amounts of NPCs and spots

Usage

• Sector variants allow you to assign different parts of a sector to a variant

• You can then toggle those variants on / off, while the game is running

• This can be used to e.g. offer different variations of a build, within a single mod download, and allow the user to toggle different parts / layers at will

• Unlike the name "Variants" may suggest, you can have multiple ones active at the same time, allowing you to mix and match

Requirements

Tools

• Object Spawner

• ArchiveXL

• Codeware (1.15.0 or newer)

• WolvenKit (With latest version of Object Spawner import script)

Knowledge

• You need to have a basic understanding of:

  • Working with WolvenKit

  • Using Object Spawner (Spawning things and importing into WolvenKit)

General Setup

• Variants are something you should keep in mind during the building process, if you want to use them

• You will be able to assign each group, which sits directly within in main group, to a variant

• In the above example, you will be able to assign each of the three groups to a variant

  • All objects placed directly within the root group (The group that you saved and export), will be part of the default variant

Assigning variants

• Once you have added your group(s) to the export, you can start assigning variants

• Variant settings can be found under the same named header (One per group)

• By default, each group will be assigned to the default variant, meaning they will be always active

• Variant Node Ref:

  • This MUST be set to some unique NodeRef, in order for the variants to be controllable

• Below you can assign a variant to each group

  • You can assign multiple groups to the same variant

  • Optionally change whether the variant should be active by default

Testing variants

• In order to quickly toggle variants on and off, during development and testing, you can use the following commands in the CET-Console:

Game.GetWorldStateSystem():TogglePrefabVariant(CreateNodeRef("$/yourRefName"), "variantName", true) -- Toggle variant on
Game.GetWorldStateSystem():TogglePrefabVariant(CreateNodeRef("$/yourRefName"), "variantName", false) -- Toggle Variant off

User Configurable Variants

• In order for mod users to quickly and conveniently toggle variants, one could e.g. hook up the above code to some UI

• To make it easier, below there will be a ready to use Native Settings UI based menu, that allows toggling variants

• In order to configure it, simply change the values at the top of the init.lua file:

  • settingsMainName/settingsSubName : Controls the names displayed for the category, in Native Settings UI

  • defaultMutuallyExclusiveVariants: Here you define string selectors for variants which should be mutually exclusive (Only one active at a time)

    • ref: This is the variant node ref

    • displayName: This is a more human-readable string, gets actually shown in the UI

    • currentIndex: This is the default state (Will override what is defined during export)

    • variants: This array contains the variants which should be mutually exclusive, with a display name

  • defaultAdditiveVariants: Here you define simple switches for variants which can be mixed and matched

    • ref: This is the variant node ref

    • variant: The name of the variant, as defined during export

    • displayName: This is a more human-readable string, gets actually shown in the UI

    • defaultState: The default state of the variant (Overrides what is set during export)

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 Adding Objects to the World.

Wait, this is not what I want!

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

Requirements

• Wolvenkit 8.12.0+

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

• You know how to Archived: Merging World Additions via ArchiveXL

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

• Open the .ent file and look for the mesh component in its components array.

  • 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 @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 8.7

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: Feb 24, 2025 by Last update: Feb 24, 2025 by Credits: @keanuWheeze for creating 90% of the scripts shared in this pages.

This page and its subpages contain ressources to guides about making scriped interactions for the player, for Cyberpunk 2077.

For the following, we can distinguish 2 types of interactions : devices and workspots.

Device like interaction will trigger a more-or-less simple code, eg : Open the wardrobe menu, Toggle a streamingsector variant, Open the Appearance menu, etc...

Workspot interaction involve animations and/or props, eg : Sleep on a bed, Sit on a chair, Smoke a cigarette, Drink a beer, etc...

Wait, this is not what I want!

• You want to add workspots for NPCs ? Check this guide : Placing AISpot Nodes

• You want to change V's animations ? Check this section : Animations -> Editing V's Actual In Game Animations

Get into scripting

The next tutorials will show you how to get interactions to work without Lua or CET knowledge, but if you want to understand more about it, you can find a dedicated wiki about Cyber Engine Teaks here.

Download the template

For the following tutorials, you will need this template. It provides a bunch of utilities to make diverses things, beyond just interaction scripts. You will probably not use all those files, but they can be usefull depending on your needs.

Thanks to @keanuWheeze for making most of the scripts.

Here is a breakdown of the its content:

archive
 └── base
      └── gameplay
           └── devices
                └── arcade_machines // Contains entities used to play workspot animations
resources
 └── bin
      └── x64
           └── plugins
                └── cyber_engine_tweaks
                     └── mods
                          └── {YourModName}
                               └── init.lua                    // Your main file
                               └── tween                       // Library used to ease transitions between animations (https://github.com/kikito/tween.lua)
                               └── modules
                                    └── devices                // Device interactions "ready-to-use"
                                         └── template          // Device template that can be extended
                                    └── external               // Game related utilities maintained in external repositories
                                    └── utils                  // Lua/CET utilities
                                    └── workspots              // Workspot interactions "ready-to-use"
                                         └── template          // Workspot template that can be extended
                                    └── interactions.lua       // List of interactions you add to the world
                                    └── variants.lua           // Variants and settings logic
                                    └── variantSettings.lua    // List of settings and variants

Interactions available

Device interactions :

• Apprearance

• Wardrobe

• Mesh swap (template)

  • Custom door

Workspot interactions :

• Sit (template)

  • Bench

  • Couch

  • Lean (rail)

• Sleep

• Coffee

• Drink

• Shower

External resources

• Lua kit for CET : Cron, GameUI and more by @psiberx

• Tween library for smooth transitions by @kikito

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

Summary

Published: Jan 07 2025 by Last documented edit: Jan 08 2025 by

This page will show you how to switch sector states.

Wait, this is not what I want!

• To learn more about .streamingsector files, check

• To learn about .streamingblocks, check

• For a list of node types, check

• check -> if that's what you'd rather do

World state variants

Here is an overview of file relations between .streamingsector and -block:

Streamingblock

The game contains only 3 streamingblocks that gather more than 26300 sectors. We will focus on the main one and take a look at the first sector inside (exterior_-18_3_-12_0).

This sector has 10 variants, in this case, each one is related to a quest state.

numNodeRanges indicate the number of node ranges the sector contains; it always corresponds to the number of variant + sector's default range (so here 10 variants + 1 default).

When opening a variant definition, we can find the range index (to find the right range inside the sector file). rangeIndex cannot be 0, 0 is used as sector's default range.

Variant's name is only used to identify the variant within the streamingblock.

Defining a new variant

How to trigger a switch

To trigger a switch between sector states, you can use

• .questphase files

Usage

• Area nodes are used for a wide variety of things, for example:

  • Soundscapes (E.g. Muffling of outdoor sounds while indoor)

  • Locations (For location notifications)

  • Vehicle Forbidden (Prevents you from driving cars into the area)

  • Prevention (E.g. Removing wanted level)

  • Interior (E.g. For applying gameplay restrictions like no weapons)

  • Death areas

  • Quest Notifiers

  • And more...

Requirements

Tools

• (v.0.9. or newer)

• (1.14.1 or newer)

• (With latest version of Object Spawner import script)

Knowledge

• You need to have a basic understanding of:

  • Working with WolvenKit

General setup

• In order to have an area node that functions, you need:

  • An area node

  • An outline, defined as a group containing multiple outline markers

• It is generally recommended to create a new group for each outline, which only contains the markers for that specific outline

• Additionally, it is good practice to have one group containing all the outline groups

Creating outline

• An outline consists of a group containing at least 3 Outline Markers

  • Ideally, the group contains only the markers and nothing else

  • The outline is only useable within the same root group

• Select Area -> Outline Markerin Object Spawner, as the spawn category

• Spawn the markers, one by one (Make sure you put them in the correct group, e.g. by selecting the group in the "Spawn New" tab)

• The markers will connect in the order in which they are within the group

• To insert a marker in the middle, simply duplicate the closest marker (CTRL-D)

Linking outline to area node

• In order to make an area node use the outline, select the path of the outline group from the Outline Pathdropdown of the area node

  • Note that only groups containing at least 3 markers, and located within the same root group (In our case the common root group is Some Mod) are valid outlines

Finishing up

• Now simply export your group from Object Spawner, and import into WKit using the Object Spawner import .wscript

Published: Feb 24, 2025 by Last update: Feb 24, 2025 by Credits: @keanuWheeze for creating 90% of the scripts shared in this pages.

This page is a subsection of the Scripted interactions guide. It will teach you how to add an interaction to open the wardrobe menu.

The logic shown here also applies to other device like interactions.

Requirements

Knowledges required :

• You know how to create a mod using Wolvenkit.

• You know how to spawn objects using entSpawner

• You downloaded the template that contains all the necessary files

Define the position

1. Find the place where you want to add the interaction, this can be anything, an existing wardrobe, a new mesh you add, a secret compartment in the wall, or even in the middle of nowhere.

2. Using entSpawner, add and position a Meta > Static Marker where the Wardrobe icon will be displayed.

   1. Copy the X Y Z position of the marker

   2. (Optional) You can save the marker in a group to more easily change the position later if you're not happy with where the icon appears. But we won't need to export it.

Add the interaction

In the interactions.lua file, add your new device interaction inside the interactions.setupInteractions() function :

local wardrobe = require("modules/devices/wardrobeDevice"):new(1, Vector4.new(1779.53, 2257.57, 183.47, 0.0))
wardrobe:init()

The require contains the path to the device. Its instantiation takes 2 parameters: an ID which must be unique, and the location. Paste the X Y Z copied before into the Vector4, the fourth parameter must be ignored and set to 0.0.

Test the result

If you're working with hot reload, you can change the interactions.lua file from within your game folder and then directly press Reload all mods in the CET menu to see the result, without having to restart your game. Otherwise, redeploy you mod.

Fine tune the interaction

Not happy with the interaction range? or the icon visibility range? or the text label? Each interaction device comes with options that you can change to your will.

Default wardrobe parameters :

self.detectionAngle = 80
self.iconRange = 5
self.interactionRange = 1.5
self.iconRecord = "ChoiceIcons.OpenWardrobeIcon"
self.iconColor = HDRColor.new({ Red = 0.15829999744892, Green = 1.3033000230789, Blue = 1.4141999483109, Alpha = 1.0 })
self.name = GetLocalizedText("LocKey#35138")

To change these, you can set their value before initializing the interaction, like so :

local wardrobe = require("modules/devices/wardrobeDevice"):new(1, Vector4.new(1779.53, 2257.57, 183.47, 0.0))
wardrobe.iconRange = 1
wardrobe.interactionRange = 0.5
wardrobe:init()

Looking for something?