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

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?