• This section will cover all features of each UI tab (Hopefully nothing has been forgoten)

  • Spawn New: The place to spawn new things from

  • Favorites and Prefabs: This is where you spawn favorites from, organize and browse them

  • Spawned: This is the core of the mod, with a split view giving you the spawned objects and properties

  • Saved: This is where you find everything you have saved, and allows you to add it to the export

  • Export: This is where the final steps happen, before importing the build into WolvenKit

What is the 3-D Editor mode

• It gives viewport style editing, similar to e.g. blender or other 3-D Editors

• While the mode is active:

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

  • Click objects to select them, and other selection methods

  • You can rotate, move and zoom the camera

  • Move objects by dragging their arrows

  • Multitude of hotkeys (Once again inspired by blender)

Activating Editor Mode

• To activate the editor mode, click the "3-D" button which is part of the toolbar of the "Spawned" tab

Camera Controls

• The camera position of editor mode is independent of the player's position

• The basic camera controls are as follows:

  • Rotate camera: Drag mouse while holding middle mouse button (MMB)

  • Move camera: Hold shift, then drag the mouse while holding MMB

  • Zoom: Hold CTRL, then drag mouse up/down while holding MMB

  • Center camera on selection: Press Tab

Selection Controls

• There are multiple ways of selecting things:

  • Select hovered: Press left mouse button (LMB)

  • Box select: Hold CTRL, then drag a box using LMB

Shift-D Menu

• In cases where the selected object is wrong, you can use the Depth Select menu instead

  • Hover over the object you wish to select

  • Hit Shift + D

  • This brings up a list of all objects underneath your cursor, sorted by distance

Changing object transforms

• Objects can be moved by dragging the axis arrows

• Additionally, hotkeys are available (Basically the same as in blender):

  • G/R/S + X/Y/Z: Enables movement/rotation/scaling along the specified axis (For scaling you can also leave out the axis, to scale uniformly)

  • LMB / RMB: Confirm / cancel 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

Spawning things

• While in edit mode, you can press CTRL-R to repeat the last spawn under your cursor

  • This is very useful for e.g. quickly building an area using outline markers

Shift-A Menu

• Besides the regular "Spawn New" tab methods such as dragging an item into the scene, you can also use the Shift-A menu

• This menu is mostly useful to quickly spawn something where you only have a few options, e.g. colliders, light or markers

  • That way, you don't have to first select the category / variant in the "Spawn New" tab

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

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

What is Object Spawner

• Object Spawner is a tool that allows you to build new structures in the game world

• It is not restrained by pre-configured lists of things you can spawn, and gives you full access to all game resources, and most node types

• It is made for building, and tries to stay close to how other map editors might work (E.g. TW3 Redkit, RedEngine editor)

How does it operate

• Building with Object Spawner is divided into two parts:

  • First, you build your creation using the tool, in-game and in real-time. This allows you to see what you are doing and how it looks in-engine, but some features will not be previewed (E.g. Device connections)

  • Then, you will convert your build into the final, native world edit, which then can take advantage of all the things that come with it being native (Better performance, easy usage, full features)

• Object Spawner operates on a "Node" level, meaning everything you spawn is a type of node

  • This can range from entity nodes (Which are used to spawn simple entities, think AMM "props"), over a range of decorative node types like lights, decals, particles and sounds, to meta-nodes used for defining NPC spawns, performance optimization and area specific actions like safe zones.

Getting Started

Core Features

• Modular UI

Use Case

• Favorites and prefabs let you alias anything you want (Single objects to whole groups)

• Things marked as favorite can be assigned a name, category and tags

• The combination of categories and tags allow for both for browsing through your library, and also highly specifc and organized searching

• The favorites system offer multiple ways of browsing and searching:

  • Simple text based search

  • Tag based filters

  • Grouping a categories contents by tags

• Categories can be easily shared and merged

Terminology

• Favorite: This is a single object

• Prefab: This is an entire group, made to be re-usable just like single objects

Creating Categories

• The main favorites view can be found on the "Spawn New" tab, specifically the Favorites subtab

• Underneath the Add Category header, you can find everything you need to make a new category

Creating Favorites / Prefabs

• There are two ways of creating them:

1. Right-Click any item in the "Spawn New" list, and choose Make Favorite

2. Right-Click any item (Group or object) in the "Spawned UI" hierarchy, and select Make Favorite / Prefab

   1. Tip: You can also simply hit CTRL-F, and make the currently selected item a favorite / prefab

• A popup will appear, allowing you to assign a name, tags and category:

Spawning Favorites / Prefabs

• To spawn a favorite, simply click it in the main favorites view

  • You can also do any of the more advanced things, such as drag and dropping a favorite into the world

  • This works the same as spawning anything from the All tab

Organizing and searching

• Clicking the icon on the right of a category will group its contents by their tags

  • This can be done recursively for each created tag category

• If you already know what to look for, you can also use the search bar, and the Search Tags selection

  • Search tags can be set to be either in AND or OR mode

Merging / Renaming Tags and Categories

Merging / Renaming Tags

• Often you might end up with multiple tags that indicate the same thing:

  • E.g. "Large", "large", "L", "big"

• To combine these tags, you can use the Rename Tags header, where you can select which tags to rename, and what the new name should be

Merging Categories

• Categories can be merged in two ways:

  • Automatic: If you ever end up having two categories with the same name (E.g. You added someone else's categories), they will be merged

  • Explicitly

• To explicitly merge a category into another, simply use the category configuration menu (Wheel button)

Exporting

Export Templates

• Since you will probably want to export your builds frequently, to make sure everything looks correct and works as expected in the native world edit, you can use export templates to save export settings

• Simply add all the groups to export as you would, setup their extents, variants, category, etc.

• Then, press "Save as Template", to save everything you setup into an easily reusable template

• Keep in mind that changing a groups name will remove it from any template in which it is used

Sections

Searching and Loading

• You can search, load and delete them from here

AMM Preset Import

• In convert an AMM decor preset, and turn it into a group, do:

  • Place the AMM decor preset .json inside Cyberpunk 2077\bin\x64\plugins\cyber_engine_tweaks\mods\entSpawner\data\AMMImport

  • Make sure you have all requirements for that decor preset installed (Custom archives)

  • Press the Import AMM Presets button

  • The import can take a while, and will lag

  • You can track the progress via the loading bar

• During the conversion, "props" (Entities) will get converted to meshes, when possible

• Guides for the topics of devices and AI / NPCs can be found here

  • Devices

  • AI and NPCs

• This section contains guides / information for:

  • Adding custom resources / props

  • Creating Sector Variants

  • Entity Instance Data

  • Creating Area Nodes

  • Creating Prefabs with Blender

Selecting Object Type

• There is a wide range of things you can spawn, so they are organized into categories

• Each category has has multiple variants, with each variant corresponding to a type of node

• By hovering over the dropdown for the Object variant you can also bring up a panel displaying some helpful information for the selected variant

Spawn Options

• Target group

  • This selector lets you choose a group which to put new objects into

  • You can also hit CTRL-N on the spawned tab to set it to the selected group

• Under the options header you can find:

  • Strip Paths: If this is enabled, resource paths will be shortened: base\object.mesh becomes object

  • Asset preview: Lets you toggle asset preview for the supported object types

  • Spawn position: See next section

Spawn position options

• There are multiple ways of controlling the position in which new objects spawn:

• Use the "Spawn position" selector to determine the position used when simply clicking a list entry to spawn

• Drag and drop a list entry into the scene to spawn it under the cursor

• In 3-D editor mode, use CTRL-R to repeat the last spawn under the cursor

  • Additionally, you can use the Shift-A spawn menu while editor mode is active

Asset Preview

• Asset preview is available for:

  • With background: Meshes, entities, decals

  • In-Place: Effects, particles, AISpots and sounds

• It gets activated simply by hovering a list entry

Searching

• At the very top you can find the main search, which supports pattern matching:

  • E.g. wall.*large will match anything that has the words "wall" followed by some characters, followed by "large" in it

Favorites

• You can make something a favorite either from the "Spawned" tab, or from the "Spawn New" tab

• In either cases, simply right-click the element you wish to make a favorite

• Further information on favorites, prefabs and tags

RHT Integration

• If you see an asset used in the gameworld, you can use RHT to send it directly to OS's search

• This is supported for: Entity, Entity Record, Device, Mesh, Decal, Particle, Effect, Static Sound, AI Spot and Reflection Probe

AMM Props

• You can also import your list of AMM props

  • AMM props will spawned as entity nodes, as they are just .ent files with an alias name

• Do this by selecting Entity -> Template (AMM) then pressing the "Generate AMM Props" button

What is it

• Entity Instance Data can be defined for any Entity type node

• It is used to override properties of the entity and its components, on a instance basis

  • This means you can make changes to once specific instance of an entity, without changing all the other ones which use the same .ent

What can it do

• It can change any component's properties, just like you would in WolvenKit

• Often this is used for:

  • Changing component size or offset

  • Changing the mesh a component uses

  • Changing behavior of e.g. Doors and other devices

  • Setting up devices such as elevators and FT points

Example

• You can see it being used in the guides for elevators, FT points and security areas

• You can right-click any property or component to reset it back to default

Custom resource list

• To permanently add any custom resource (E.g. .ent, .mesh, .mi etc.) to the list of things you can spawn via the "Spawn New" tab, you can do the following:

  • Locate the data folder, found in Cyberpunk 2077\bin\x64\plugins\cyber_engine_tweaks\mods\entSpawner\data\spawnables\...

  • Find the specific sub folder for the type of resource you wish to spawn

    • E.g. For entity templates .ent, this would be ...\spawnables\entity\templates

  • Create a new .txt file in the sub-folder

  • Add all the resource paths you want to the file, each path being on a new line

Importing AMM props

• AMM props are just entity files .ent

• To add existing AMM props (Including such from other prop packs) to the "Spawn New" list, do:

  • Select the Entity -> Template (AMM) category

  • Click the "Generate AMM props" button

Sharing custom resource packs

• If you add some spawnable custom resources to the game (Such as custom entities or meshes), and want to share those in an easy-to-use way with other builders, you can use two methods:

  • It's usually best to share them as a custom favorites' category (Or multiple categories). This allows assigning more meaningful names, and tags, for easier browsing and searching of your resources.

  • Additionally, you can share them as custom resources lists, as explained above

Cache Exclusions

• OS caches a lot of data, including the list of appearances an entity / mesh has

• This can lead to issues if you e.g. spawn a custom entity before adding custom appearances, then spawn it after you've made changes to it in WolvenKit

  • Since the list of appearances is cached, it will be empty even after adding apps to your .ent

• In order to avoid caching you can add a cache exclusion in the settings:

Summary

Created: Mar 15 2025 by Simarilius

Optimisation is a way of life

I'm too lazy to always build every thing from scratch, so I like to optimise my workflow by spending loads of time writing a script to do stuff later. Lucky for you I share them so you get to be optimised too.

Theres a script included with the Blender addon that lets us export the current selection from an imported sector to an OS group json. This can then be turned into a prefab which you can reuse and share. No more hunting for bed + pillows + duvet etc. Just find one you like in game, use RHT to get the sector names, import them to blender and steal borrow it, complete with all the little extras that make it feel polished.

Find some sectors

The first step is to export the location of your inspiration to blender, as explained in the Editing Locations in Blender guide. I use RHT to scan the location and then use the copy sectors button to just take a list of every sector in the immediate vicinity. add ot project, run the sector export script and import the project to Blender, and we're good to go.

Like Stealing Candy from a baby

And unlike Mr Burns, we're not going to struggle. Select some stuff, switch to the scripting tab. In the empty text window, click the little arrow to the right to expand out the side panel.

in the CP77 Modding tab theres a list of scripts, click the export_to_OS.py one (1 below). This will open in the text window. At the top of the script, theres a variable for the folder to save to, and the groupname (2). Set the folder, and define a group name. Currently it writes over that filename everytime you run it, so change it between selections.

When you've set them, hit the play button. (3)

You should now have a json in the folder you specified, this needs copying to the EntSpawner objects folder, which can be found at

Cyberpunk 2077\bin\x64\plugins\cyber_engine_tweaks\mods\entSpawner\data\objects

Pure Favoritism

Load the game up, bring up your CET console etc and in the object spawner window, switch to the saved tab. Your jsons should be in the list, and if you click on one you can hit load.

At this point OS loads them at the position they were defined at, which is wherever we borrowed them from.

I always move them to my location to test them and check nothings gone wrong, as its all too easy to either miss something you intended to include, or include something you didnt want. to do this switch to the spawned tab, select the top level group and in the transform bit below the group, hit the person button to bring it to your location.

If your happy with it, right click the group, and select Make Prefab

This pops up a dialog that lets you select tags and put it in a Category. You can just select any existing tags, or create new ones from the dialog. Hit the little tick at the bottom of the dialog to ok it.

Switch to the Spawn new tab, and your new prefab should be in the list under the category you selected. you can filter the list by the tags too.

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

• Object Spawner (v.0.9. or newer)

• ArchiveXL

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

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 feature

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)

Toolbar

• At the top (Underneat the search and add group options), you will find the toolbar:

• From the left to right you have:

  • 3-D Editor mode toggle

  • Save All button, saving all loaded root groups

  • Expand and collapse all, expanding / collapsing all groups

  • Hide / Show all, spawning / despawning everything

  • Undo and redo

  • Shortcut info

Scene view controls

• This is main part from which you organize your build

• It is a tree type hierarchy, similar to the one in e.g. blender, with groups and objects

Moving and selecting

• These are very similar to the ones found in most file explorers

  • LMB : Select

  • CTRL + LMB : Make a multi-selection

  • SHIFT + LMB : Make a range-selection

  • CTRL-A : Select all

  • Esc : Unselect all

• To move elements:

  • Drag selected elements onto group element, to move into group

Changing visibility

• You can change whether or not an object or group is visible by either:

  • Use the little "Eye" icon on the right of a element

  • Press H, to toggle visiblity of all selected element

Hotkeys

• Double Click : Rename double clicked element

• Delete: Delete all selected

• CTRL-C: : Copy selected

• CTRL-V : Paste selected

• CTRL-X : Cut selected

• CTRL-D : Duplicate selected

• CTRL-G : Put all selected into a new group

• CTRL-S : Save all root groups

• CTRL-E : Drop selected too floor

• CTRL-N : Set selected group as "Spawn New" target group

• CTRL-F : Make selected a favorite / prefab

• Backspace : Move all selected to root

Context menu

• Additionally you can bring up a context menu for the current selection, by right-clicking

Transform controls

• Use the controls under the "Transform" header to move and rotate your current selection

  • You can move single objects, but also groups and multi-selections

• You can also copy transforms from one object to the other, using the transforms context menu

  • You can open it by right-clicking any of the transform controls

Group properties

• When having multiple elements selected (Or a group), you can use the "Group Properties" header to control certain properties of all elements of a type

  • E.g. Visibility of all colliders inside the selection

World Node options

• Here you can give each object a NodeRef

• As already mentioned in the Exporting to WolvenKit guide, there are multiple values controlling streaming ranges

• The ranges found under the World Node header of each object control when that specifc object streams in / out

• To make setting these easier, there is a "Auto-Set" button

  • As seen in the Group properties section, you can also auto-generate the values for all your builds objects at once

Entity

• All Entity type nodes support Entity Instance Data editing (Changing any component's value)

• Related guides: Devices

Mesh

• Mesh nodes are used for most visible things, as they support scaling, and entities are overkill if nothing else but a visible mesh is needed

Deco

Collision

Lights

AI

Area

• All area type nodes work the same, requiring an outline to be defined using a group of outline markers

• None of the area nodes functionality (E.g. Restrictions) are previewed, for them to take effect the build needs to be converted to native world edit

Meta