Remove the following folders/files:

• <cyberpunk install path>/bin/x64/plugins/

• <cyberpunk install path>/bin/x64/global.ini

• <cyberpunk install path>/bin/x64/LICENSE

• <cyberpunk install path>/bin/x64/version.dll

Notes

• Removing Cyber Engine Tweaks will not undo any edits made to your character and your save files.

• If you have added items to your inventory, you will not be able to remove them once you have removed this mod. Please ensure you have done so using the appropriate commands first.

• Saves made with the patch should be completely fine without it, thought that might change once proper mods start coming out

Console UI

The console tab is where you type commands to use cheats and other useful functions.

Console Buttons

What the buttons and checkboxes do in the Console tab:

Console Commands

The console uses Lua script language, you may want to look up how to use it before proceeding. There are some guides here to get you started:

Preface

In the early days of Cyberpunk 2077 modding, we noticed a lack of discipline and proper use of the SDK provided by CET. So we strongly recommend you read the documentation and understand what is expected of you and your mods.

Getting Started

• Before you start, it is highly recommended to check out the Modding Resources page

• If you are using VSCode, make sure to also pick up the CET VSCode extension

• Next, it is recommended to read through the Scripts and Mod Structure page, which gives an overview on how to create a mod / run a single script. It also covers the basic elements of a mod

• After that, you might want to check out the Scripting API page, which explains how you interact with the games systems and code.

• Once you've made yourself familiar with how a general mod is structured and how to interact with the game, you might want to read up on the different functions offered by CET itself, such as Events, Keybinds, Overrides and more.

• Check out the Examples section for a collection of small example mods and useful code snippets

Hotkeys

The Hotkeys tab is where you manage all the hotkeys of the mods you installed.

• Binding hotkeys for a mod is the same as how you bind the hotkey for the CET Overlay.

• You can unbind a hotkey by pressing the UNBIND button behind it.

• To save the changes, press the Save button.

• Undefined hotkeys appear in red text. Unsaved changes appear in yellow text.

If you have encountered troubles when using a mod, please read this FAQ page:

I've installed this mod but nothing happens.

1. Make sure that CET works fine without any mods installed.

2. Make sure the mod that you are installing is compatible with the latest CET.

I've made sure the above are true but the mod still won't function.

You need to bind a hotkey in the Hotkeys tab of the CET overlay. Check how-to .

I've bound the hotkeys but the hotkeys do nothing when I press it.

The hotkeys only work when the CET overlay is closed.

I've bound the hotkey and I've closed the CET overlay but still, nothing happens.

You need to press the hotkey combination in the right order. For example Ctrl + Shift + S is different from Shift + Ctrl + S

I bound the hotkeys and the interface opens but I can't do anything there. There's no cursor in the window.

You need to open the CET overlay to interact with anything using your mouse.

This mod supports different languages, but when I change the language every character becomes a ? (question mark).

You need to change the default font of CET in order for the characters to show properly. You can follow this guide .

How do I open .7z .rar .zip files?

Click for the ultimate guide.

What is the Overlay?

The Cyber Engine Tweaks Overlay is the interface that is used to display and set various settings, and configure mods hotkeys.

Additionally, the most advanced mods will also display their own settings window in this overlay. It contains different tabs:

How to open the Overlay?

Upon the installation of CET, the overlay will appear automatically when you launch the game. You need to assign a hotkey to it before you can move on:

1. Press the Hotkey button next to the Overlay Key.

2. Press a key or a key combination on your keyboard after the button becomes BINDING... to bind it.

3. Now the hotkey has been bound, you can press that key anytime to open/close the Overlay.

On onInit gets triggered once, when CET loads in all the mods. This event ensures that CET has fully loaded, and you have access to the Scripting API. There can be only one onInit event per mod.

Use it to register any , as well as do any one-off actions needed for your mod.

Usage Example

Install CET Mods?

You can find a for first-time users.

Add Perk, Level Up, Add Money...?

For a list of console commands for beginners, check out the page:

Create my own mod?

Checkout the page for your first steps:

Cyber Engine Tweaks is a framework that allows modders to interact with the game's internal functions using . It also provides a user-interface with a console and additional tools to assist developers.

GETTING STARTED

For information on how to install Cyber Engine Tweaks, check out the link below.

USAGE

Learn how to use each Cyber Engine Tweaks tabs.

MODDING

Everything you need to know to create your own mod for Cyber Engine Tweaks.

CONTRIBUTING

If you wish to contribute to the main repo, try to follow the coding style in the code, otherwise not much to say, don't use code that is not yours unless the license is compatible with MIT.

This event gets triggered on every frame that the game runs, thus is framerate dependent. The callback function gets the deltaTime passed along with it, which measures the frametime in ms, useful for making e.g. timers.

In here you can put any code that you want to run every frame, although it is best practice to only run your code when needed, e.g. using .

Usage Example

Settings UI

The Settings tab is where you change the Overlay open/close hotkey, and toggle the tweaks to Cyberpunk2077's game engine.

Generated Config file

See the following section for more information about the configuration file generated using this UI.

Game Log UI

• This window shows any output done using Redscript's Log/LogChannel function, either coming from the games scripts themselves or from a Redscript mod.

Writing Logs

• Decompiled game scripts: These are the game's scripts decompiled to redscript. Extremely useful for understanding how functions work under the hood, game systems and classes interact with each other and what classes and functions are available. For more information on how to transpile redscript code to .lua code, read up on the Scripting API. Works best if downloaded and opened in some IDE like VSCode that lets you search across all files at once.

• cp2077-cet-kit: psiberx's github repository with helper functions and scripts

• NativeDB: This is a database containing all the classes and their functions, their relation to each other, their functions, attributes and all the Enum's. Very useful for quickly looking up what functions a class offers and what parameters it takes. Also helpful for understanding which classes inherit from which. Nativedb has more types than decompiled scripts.

• CET translation helper: A utility that helps you translating your CET mods, by lgomes_gvizstudio on github

• CET Kit: A collection of utility scripts, for tracking game states (In Game etc.), setting up timers and timed actions, storing data per game save and more.

• Official CET Examples: A collection of small example mods, such as controlling NPC AI, working with map pins, reading player inputs and more.

• Cyberpunk 2077 Explorer: Visual overview of the game's classes and structure. Very helpful for understanding the higher level structure.

• Cyberpunk 2077 Modding Community: Discord server with multiple CET related channels, lots of more resources and snippets (Discord search is your best friend)

• Simple Gameplay Mod Tutorial: An extensive tutorial covering how to work with the TweakDB, create a CET mod, override and observe functions and use redscript.

• LUA code playground: An online sandbox to familiarize yourself with LUA and test some code without having to launch Cyberpunk with CET. Note that any CET/Game functions won't work in it.

This event get triggered when the CET Overlay gets shown.

Use this to keep track of the overlays state, and e.g. to only draw your own UI when CETs overlay is visible. Use it in conjunction with onOverlayClose to get a proper on/off switch case.

Usage Example

Display a warning message when the CET Overlay is opened:

-- onOverlayOpen
registerForEvent('onOverlayOpen', function()
    
    -- get player
    local player = Game.GetPlayer()
    
    -- bail early if player doesn't exists
    if not player then
        return
    end
    
    -- display warning message
    player:SetWarningMessage('Overlay is open')

end)

Advanced Example

Render an ImGui window when the CET Overlay is opened:

-- set initial var
local isOverlayVisible = false

-- onOverlayOpen
registerForEvent('onOverlayOpen', function()
    isOverlayVisible = true
end)

-- onOverlayClose
registerForEvent('onOverlayClose', function()
    isOverlayVisible = false
end)

-- onDraw
-- this event is triggered continuously
registerForEvent('onDraw', function()
    
    -- bail early if overlay is not open
    if not isOverlayVisible then
        return
    end
    
    -- draw ImGui window
    if ImGui.Begin('Window Title', ImGuiWindowFlags.AlwaysAutoResize) then
        ImGui.Text('Hello World!')
    end
    
    ImGui.End()
    
end)

Individual Mod Logs

On game launch, Cyber Engine Tweaks generates individual logs files in each mod folder, using their name. eg, <cet_path>/mods/my_mod/my_mod.log.

../
├─ cyber_engine_tweaks/
│  ├─ mods/
│  │  ├─ my_mod/
│  │  │  ├─ init.lua
│  │  │  ├─ my_mod.log <- automatically generated

What it contains

This file contains all notices, errors and logs generated by the mod.

Write the file

You can write the log file using the spdlog functions.

Watch the file

You can use Tailblazer App to watch files in live with a GUI, or use the following command line in the Windows Command shell:

tail -f "C:/path/to/Cyberpunk 2077/bin/x64/plugins/cyber_engine_tweaks/mods/my_mod/my_mod.log"

CET Console Logs

Cyber Engine Tweaks has a global log file located in <cet_path>/scripting.log.

../
├─ cyber_engine_tweaks/
│  ├─ scripting.log

What it contains

This file contains all logs from the CET Console.

Write the file

You can write the log file by using the print() function.

Watch the file

You can use Tailblazer App to watch files in live with a GUI, or use the following command line in the Windows Command shell:

tail -f "C:/path/to/Cyberpunk 2077/bin/x64/plugins/cyber_engine_tweaks/scripting.log"

Summary

This page tells you how to install Cyber Engine Tweaks - or you can check the 📺 Video Guide.

🔒 Prerequisites

1. Make sure Cyberpunk 2077 is updated to the latest version

2. Make sure you installed the latest Microsoft Visual C++ Redistributable

3. Make sure you run the game in Windowed Borderless

4. Ensure all apps overlays are disabled as the console may not open: Steam, Discord, GOG, Geforce Experience, Windows 10 Game Bar, Rivatuner, Fraps, Afterburner etc...

📋 Installation

1. Download the latest cet_x_xx_x.zip file. (Do not download the source code)

   • If using Windows, you should right click on the zip file, and check under Properties for a security notice saying "This file came from another computer and might be blocked to help protect this computer" - if that security notice is present, click the checkbox to unblock the contents of the zip file.

2. You can now either

   • Unzip the download directly into your Cyberpunk 2077 game directory or

   • Unzip to anywhere on your desktop. After unzipping the file, you will see a bin folder.

     • Drag the bin folder to your Cyberpunk 2077 game directory

3. If installed properly, the Cyber Engine Tweaks files will be in the <cyberpunk install path>/bin/x64 folder. As follow:

Cyberpunk 2077/
├─ bin/
│  ├─ x64/
│  │  ├─ global.ini
│  │  ├─ LICENSE
│  │  ├─ version.dll
│  │  ├─ plugins/
│  │  │  ├─ cyber_engine_tweaks.asi
│  │  │  ├─ cyber_engine_tweaks/
│  │  │  │  ├─ fonts/
│  │  │  │  ├─ scripts/
│  │  │  │  ├─ tweakdb/
│  │  │  │  ├─ ThirdParty_LICENSES

🎮 Launch the Game

When you first start the game, a window will appear prompting you to choose a keybind to bring up the Overlay. Pick any key and save it. It will open with that key from now on.

• (Optional) To check that everything works you can look at the logs in <cyberpunk install path>/bin/x64/plugins/cyber_engine_tweaks/cyber_engine_tweaks.log

• (Optional) When installing through Nexus Vortex, make sure to use hardlink deployment.

📺 Video Guide

What's next?

Cyber Engine Tweaks has builtin events which can be listened using the registerForEvent() function. These listeners must be registered inside the init.lua file.

Keep in mind that CET events are not game events. For example, onInit doesn't mean the game the initializing, but rather that CET loaded mods and the game's Scripting API.

If you need to listen for game events, take a look at the Observers functions.

Definition

registerForEvent(event, callback)

--
-- registerForEvent()
--
-- @param  string    event     The event name
-- @param  function  callback  The callback function
--
registerForEvent('event', function()
    
    -- event is triggered
    
end)

Events Trigger Sequence

Here is a video showing when events are triggered in real-time:

Available Events

Summary

This page documents CET's in-game Tweak Editor.

Wait, this is not what I want!

• To learn what the TweakDB is, read the page on

• For an introduction on TweakDB modding with CET, check the Simple Gameplay Mod guide

• For further information, refer to the TweakDB section on this wiki

What is the TweakDB editor?

After opening CET with the key that you bound during the installation, you can find it in the "TweakDB Editor" tab. Here you can browse and update the TweakDatabase in real time.

This event works similarly to , except that it is used for drawing custom ImGui UI. It gets triggered on every frame that the game runs, thus is framerate dependent.

Usage Example

Render an ImGui window at anytime:

Advanced Example

Render an ImGui window when the player is sprinting:

This event get triggered when the gets hidden.

Use this to keep track of the overlays state, and e.g. to only draw your own UI when CETs overlay is visible. Use it in conjunction with to get a proper on/off switch case.

Usage Example

Display a warning message when the is closed:

Advanced Example

Render an ImGui window when the is opened:

Use a text editor to open the config file at <cet install path>/config.json to adjust the settings.

In this page, we use this example JSON snippet to guide you through adjusting the settings:

{
    // other lines
    "font": {
        "base_size": 16.0,
        "language": "Default",
        "oversample_horizontal": 3,
        "oversample_vertical": 1,
        "path": ""
    },
    // other lines
}

Change font

Locate this line under the "font" curly brace:

"path": ""

Add the path of the font you want to change to between the double-quotes. For example, if you want to change the font to Comic Sans, just change this line into:

"path": "C:/Windows/Fonts/comic.ttf"

Note: You should use slash (/) instead of backslash (\) for the path.

How to display non-English characters

Some mods may have implemented multilingual support. But the non-English characters will display as a question mark "?". This is because the default font only contains ASCII printable characters.

To display a language that only uses ASCII characters (such as French, German), all you need to do is to change the font to one with a wider range (Literally any font).

To display a language that uses non-ASCII characters (such as Chinese, Russian), besides changing the font, you also need to change this line in the config file under the "font" curly brace:

"language": "",

Here is a table of the "language" options and their descriptions.

For example, to display Chinese all you need to do is:

{
    // other lines
    "font": {
        "base_size": 16.0,
        "language": "ChineseFull",
        "oversample_horizontal": 3,
        "oversample_vertical": 1,
        "path": "C:/Windows/Fonts/simhei.ttf"
    },
    // other lines
}

The result (using the Sim Hei / 黑体 font):

Features

• Code completion for built-in Cyber Engine Tweaks, Dear ImGui and Cyberpunk 2077 types and functions (except sqlite)

• Type resolving for Game.GetScriptableSystemsContainer():Get("Type"), NewObject("Type"), and GetSingleton("Type")

• Contextual suggestions for default values and predefined sets

Installation

CET typedef

1. Download and extract the Cyber Engine Tweaks Lua Lib.

   • The lib files linked above is not the newest version.

   • You can join the Cyberpunk 2077 Modding Community discord server and then visit this message to download the newest version (CET 1.27 / Patch 2.01 Typedefs).

   • You can alos check the pinned messages in the #cet-lua-scripting channel for any future update.

2. Install the Lua by sumneko extension.

3. Locate settings.json in VS code

   • Ctrl + Shift + P

   • C: > Users > (yourname) > AppData > Roaming > Code > User > {} settings.json

1. Add next settings to the .vscode\settings.json or in the Settings GUI:

   • NOTE: ensure commas occur after every line

     "Lua.runtime.version": "LuaJIT",
     "Lua.workspace.preloadFileSize": 15360,
     "Lua.workspace.library": [
         "c:\\path\\to\\cet-lua-lib",
     ], 

1. On first use it takes a couple of minutes to parse and cache all definitions. Unfortunately there is no visual indication of this process. When it's done the code assistance will be more responsive.

Dear ImGui typedef

To install the typedefs for Dear ImGui, you can manually download the files from GitHub repository Nats-ji/CET_ImGui_lua_type_defines and then follow the same installation process in CET typedef to install them in VSCode.

Annotations

Callback parameters

You can specify the type of the parameters with @param annotation. It's very handy for Observe and Override:

---@param request PerformFastTravelRequest
Observe("FastTravelSystem", "OnPerformFastTravelRequest", function(request)
    -- Now request object has type and suitable for code completion
end)

Unresolved type

If type of some variable cannot be resolved or ambiguous you can force the type with @type annotation:

---@type ScriptedPuppet
local puppet

Generic functions

The type of the result of some functions depends on the parameters passed to the function. If a valid type name is passed as a parameter, then the resulting type must be resolved without custom annotations.

Special Types

Helper functions which let you construct internal data types.

TweakDB

Methods for interacting with TweakDB, the game's internal data store.

Misc

Miscellaneous functions useful for debugging (print to console, dump type information) and getting special objects and info.

Introduction

Cyber Engine Tweaks allow mods to listen or overwrite game's script functions/methods. There are three kinds of functions:

• Observe allows to listen for function/method execution

• Override allows to overwrite a function/method

• NewProxy allows to trigger a function/method callback using game's script system

Available Functions

First Launch

After installing CET, you can open the console overlay with the .

Open the Console tab to run Lua scripts or engine functions. To find out what you can do here, keep reading.

Spreadsheets

To find all the codes you can enter, check

• (source: #cet-support on )

For the most common commands, see below.

If you want to find a specific item, look for how to find the hash code for the .

Items

Use Game.AddToInventory

Level

Use Game.SetLevel

Attributes

Formerly Game.SetAttribute

Perk and Skill Points

Formerly Game.GiveDevPoints

Vehicles

All vehicle commands are documented on the VehicleSystem page linked below.

Teleportation

Get your coordinates

You can print V's current coordinates to the CET console with the following command:

Go somewhere else

You will need to know the coordinates of where you want to go in the game world, some popular . Replace X, Y, and Z with your coordinates. Coordinates can also be found in the nodeData of .streamingsector files.

Facts

For a more cohesive list of quest facts, check the .

This is a basic guide to using the mod within Proton (aka Linux).

Please make sure your game works in proton first, before installing this mod.

Enabling proton Experimental (Optional)

While this isn't a required step, it's useful for performance.

Right click the game in Steam and select 'Properties'. Go to the 'Compatibility' tab and tick 'Force the use of a specific Steam Play compatibility tool'.

In the dropdown, select 'Proton Experimental'.

Setting up the mod with ProtonTricks

Please note - this method requires the use of Steam. For other options, see below.

First, follow the steps to install the mod. These are in the .

Run protontricks 1091500 --gui, you may get an error saying "You are using a 64 bit WINEPREFIX", you can ignore this. Press 'Ok' when this error appears.

Choose the option 'Select the default wineprefix', then 'Run winecfg'. In the window that opens, select the 'Libraries' tab. In the dropdown on 'New override for library', select version. Click Add, then Apply and Ok.

You can now exit out of Protontricks and start your game. Check to see if the log exists after you run the game. If it's there, you've successfully installed the mod.

If you have issues with the mod still not working or the game just crashing, you can try this: re-open Protontricks like you did before, choose the option 'Select the default wineprefix', then 'Install a Windows DLL or component'. Tick vcrun2022 and press Ok. If a window pops up, then go through the steps to install that runtime (just click next really), otherwise just wait until the Protontricks screen comes back. Now exit out of Protontricks and try launching the game. DON'T do this without first checking if the mod works without this step, since installing vcrun2022 has been observed breaking game installs before, preventing the game from ever launching again and requiring a re-install.

NOTES: You will also need to install d3dcompiler_47 with winetricks to get it to work now, contribution on how to do this would be much appreciated!

If vcrun2019 breaks your install, it's been reported it can be fixed without reinstalling by deleting the contents of/steamapps/compatdata/1091500.

Setting up the mod with proton as non-Steam Game

Please note, this method still requires the use of Steam. You must install Cyberpunk 2077 and then add it to your Steam library by following the .

Search for the game APPID with: $ protontricks -s name_of_the_game_on_your_steam_lib

like:

$ protontricks -s Cyberpunk 2077

copy the APPID from the terminal then run:

$ protontricks "APPID" --gui

From now on, you can follow the Setting up the mod with ProtonTricks instructions.

Setting up the mod without Steam by using Winetricks

For users running on the GOG version of the game, via launcher like , or , those running from the direct GOG Galaxy Windows application through Wine, or those directly using the Game libraries, Protontricks won´t be helpful in your case, as Protontricks will notice that you don´t have the game on Steam.

Instead, use Winetricks in which Protontricks is derivated from. Please note that you may need to install first, either through the official website or through your distribution's app store.

Lutris users may perform the following steps to activate the mod:

Authenticate with GOG Galaxy by clicking on the small profile icon to the right of the GOG entry. You will then be presented with a list of your owned games. Select Cyberpunk and install it - this will install the base version of the game with no other options selected. You may right click on the game icon after installation and choose the option to install the Phantom Liberty DLC if desired. Once installation is complete, select Cyberpunk 2077 and click on the Winetricks 'wine flute' icon along the bottom of the Lutris window. In the expanded menu, select 'Winetricks'.

Choose the option 'Select the default wineprefix', then 'Run winecfg'. In the window that opens, select the 'Libraries' tab. In the dropdown on 'New override for library', select version. Click Add, then Apply and Ok.

Alternatively, you may run Winetricks in itself if you use your default prefix, or from your custom prefix via: WINEPREFIX=<Location of your WinePrefix directory> winetricks --gui via the terminal.

From now on, you can follow the Setting up the mod with ProtonTricks instructions. If you want to verify in Winetricks has correctly taken in account your custom Wine directory, click on Browse files to see if it brings you to the designated folder.

Thanks to

Summary

This page will tell you how the CET mod folder structure works. To download a ready-to-go example project, check the wiki's .

Setting up the folder

Create a new folder in the <cet_path>/mods/ folder to get started, e.g. my_mod (snake case recommended)

Setting up init.lua file

CET will be looking for an init.lua file inside your mod folder. This is the entry point of your mod, and gets executed when the game is launched.

Firing up the code

The init.lua file is the only file that gets automatically loaded, thus should contain all your initialization code.

Start by printing simple info into the using the function. Then register a listener on the event, and print something else.

Launch the game, and open the . You should see your printed text.

Creating mods

• To now actually create a complex mod, you'll want to interact with the game's system, modify and create instances of game classes and modify the game's code. For that, head to the section

• Additionally read up on the CET Functions, for information on how to create custom keybinds, Observer and Override game functions, spawn objects and more

Opposing to , this event gets triggered whenever CET unloads all the mods, either due to the game shutting down, or when pressing the "Reload all mods" button in the .

Use this to do any clean-up work for your mod, e.g. despawning objects or removing status effects.

Usage Example

CET Overlay Window Builder Tool:

FellowImGui (online tool):

LUA

Gain performance: Early Return

You're probably used to coding like this:

local function myMethod()
  if condition then 
    -- do a little dance, make a little love…
  end
end

In LUA, you can skim a few processing cycles by using the early return style:

local function myMethod()
  if not condition then return end
  -- do a little dance, make a little love…
end

You can gain a significant amount of performance this way, especially when doing this in a loop.

Fixing/preventing nil access

LUA throws an exception if it encounters nil in unexpected places. The corresponding error will look like this:

attempt to access local '<variable name>' (a nil value)
stack traceback: 
  my_example.lua:1234 in function 'MyFunctionName

Open the corresponding file, find the correct line, and check what is being accessed there. It will look like variable.property, or perhaps something will be concatenated to a string ("something something text" .. variable).

You can assign a default value to the property in question:

myString = <original string assignment> or ""
myNumber = <original number assignment> or 0
myEverythingElse = <original object assignment> or {}

Switch in LUA: Lookup Tables

Who doesn't know the problem? You want to know if your string is A, B, or C, but not D — and LUA doesn't have a switch statement.

Fortunately, there is a built-in and performant way to

Performance killers: strings

String concatenation and comparison can be the difference between a brief stutter and a complete freeze or even crash to desktop. This is not a joke — see here for more detail.

Comparing/Searching

Lua internalizes strings. That means these two strings will share a single representation in memory:

local string1 = "This is the same object!"
local string2 = "This is the same object!"

The comparison between those two strings will be almost-instant.

This becomes a problem when comparing strings in a loop (see Scopes):

for (_, mystring) in ipairs(mytable) do
    if mystring == "This is the same object!" then
        -- do something
    end
end

Every single pass of the loop will create a memory representation of "This is the same object!" and then discard it again.

local myCompareString = "This is the same object!"
for (_, mystring) in ipairs(mytable) do
    if mystring == myCompareString then
        -- do something
    end
end

Finding in strings

Lua's regex implementation is very limited. There is a limitation for pipes. For example, the following example will actually iterate twice after creating internal string representations:

if string.find("catastrophe",  "dog|cat") then 
  -- do something
end

It is faster to just do this:

if string.find("catastrophe",  "dog") or string.find("catastrophe",  "cat") then 
  -- do something
end

On top of that, string.match will return the entire string if no match is found:

local match = string.match("catastrophe",  "dog")
if match ~= "catastrophe" then
  -- do something
end

The alternative:

if string.find("catastrophe",  "dog")
  -- do something
end

Concatenation

Scopes

function foo(x)
    for i = 1, 1000000 do
        x = x + math.sin(i)
    end
    return x
end

local sin = math.sin
function foo(x)
    for i = 1, 1000000 do
        x = x + sin(i)
    end
    return x
end

Overview

• What is this, what can you do with it, how does it work, redscript note

Helpers

• Helpers make it easy, some listed below

Game

• Where can we use it, difference to redscript thing

GetPlayer

• What is it in reds, dont store it etc.

IsDefined

• Description

From/ToVariant

Classes

• What names to use

Creating Instances

• .new, as constructor

Member Functions

• When to use, how to use

Static Functions

• When to use, how to use, use on member functions

Enums

• How to use, nativeDB link, enumInt

CName

• Function to add CNames, string to cname

Observe and Override

• Note on how powerful it is etc, link to seperate doc

Blackboard System

Blackboard is a kind of shared data storage and a framework to access/notify/listen to the data in the storage. Similar to a real blackboard, game objects put their data on the board that then other objects can observe, react to or update the data. E.g. various game state values.

Handle functions

They require a handle (more on that later). Assuming you have a player handle:

print(player:IsNaked())
print(player:IsMoving())
player:OnDied()

Handles

Handles are a way to pass an object to the function. For example IsNaked makes no sense without telling the engine for which object we want to know this information.

Singleton

These handles are static, there is only one in the game, for example the gameTimeSystem is a singleton so there is no need to tell the script engine which one you want. That being said you need a singleton handle so it knows you want to call a function on that system.

Sample:

gameTime = GetSingleton("gameTimeSystem")
print(gameTime:GetGameTime())
gameTime:SetGameTimeByHMS(12,0,0) -- 12h0m0s

Regular handles

These handles are not unique, for example, the game contains multiple NPCs so there are as many handles as NPCs. Currently as far as I know we can only get the handle of the player by calling the global function Game.GetPlayer().

Sample:

player = Game.GetPlayer()
if player:IsNaked() then
    player:OnDied() -- kill the player if it's naked
end

player = Game.GetPlayer()
ts = Game.GetTransactionSystem()

tid = TweakDBID.new("Items.money")
itemid = ItemID.new(tid)

result = ts:GiveItem(player, itemid, 100000)
if result then
    print("We added " .. tostring(itemid) .. " to the inventory!")
else
    print("Failed to add " .. tostring(itemid))
end

Helpers

player = Game.GetPlayer()
dmp = Dump(player, false)
print(dmp)

type = DumpType("gameItemID", false)
print(type)

Global functions

They do not need a handle and are all located in the Game object. Sample:

Game.PrintHealth()
-- or
Game.AddToInventory("Items.money", 500)

Documentation

You can find Codeware's existing documentation at the wiki on psiberx's github

Known problems (and solutions)

Accessing references

As of Mar 2024, you can't access rRef or raRef natively via CET:

-- this does not work
ComponentParser.GetMeshComponent(Game.GetPlayer(), 't0_000_pwa_fpp__torso')

This will most likely return nil or crash the game.

Even if it does not, no reference is kept in memory: you're effectively working on a copy and there is currently no way to pass your changes back to the game.

Currently, the only way to access resources is via Codeware, which will do its best to sync your changes with the actually-existing object.

Reflexes

Strength

Cool

Intelligence

TechnicalAbility

ColdBlood

Hacking

Stealth

Gunslinger

Kenjutsu

Assault

Crafting

Engineering

Hacking

CombatHacking

Athletics

Demolition

Brawling

StreetCred

Level

Hotkeys are buttons events triggered on key release. They must be registered using registerHotkey() at root level, outside of any event, in the init.lua file.

Definition

Usage Example

Give money with a hotkey:

NewProxy is a built-in CET feature you can use to declare callback functions. You can use it to bind a Lua function as a callback with game's script system.

Definition

listener = NewProxy({
  CallbackName = {
    args = ["ArgType1", "ArgType2", ...],
    callback = function([arg1, arg2, ...]) end
  },
  ...
})

CallbackName is an arbitrary name you define. A callback name can be formatted as follow On[Action] (e.g. OnDamaged or also OnPlayerDamaged).

CallbackDefinition is the signature of the script function (args) and the Lua function (callback) you want to be executed when the callback is triggered.

The list of arguments must indicate the name of the types to expect. For example with a callback function which receives a String, an Int32 and a reference to a GameObject, it should be defined like this:

args = {"String", "Int32", "handle:GameObject"}

In this case, you can define your function callback like this:

callback = function(arg1, arg2, arg3)
  -- print("arg1: " .. arg1)
  -- print("arg2: " .. tostring(arg2))
  -- print("arg3: " .. NameToString(arg3:GetClassName()))
end

Find the signature of a function

The signature of the function depends on the game's script function you want to register a callback for.

You can use NativeDB to know the types of arguments to declare. By default, the syntax will be written in Redscript. You can change the option Code syntax in the settings and select Pseudocode · Legacy instead. Basically, it will show you handle:GameObject instead of ref<GameObject> (among other things).

Use a proxy

Lets create a proxy:

listener = NewProxy({
  OnHit = {
    args = {"handle:GameObject", "Uint32"},
    callback = function(shooter, damage)
      print("Hit by " .. NameToString(shooter:GetClassName()) .. "!")
      print("You lost " .. tostring(damage) .. " HP.")
    end
  }
})

After creating the proxy, you can use it to pass the target and function you want to callback. Lets say a game's script is defined as:

// redscript syntax
public class AwesomePlayer extends PlayerPuppet {
  public func RegisterHit(target: ref<IScriptable>, fn: CName) -> Void;
  public func RegisterShoot(target: ref<IScriptable>, fn: CName) -> Void;
}

We can call the function RegisterHit to register our callback with our proxy like this:

local awesome = AwesomePlayer.new() -- for example only

awesome:RegisterHit(listener:Target(), listener:Function("OnHit"))

Note that the value, when calling listener:Function("OnHit"), is the same we declared in the proxy.

This way, you can create multiple callback in a proxy and you just need to call listener:Function with the name of the callback you want to use. For example:

listener = NewProxy({
  OnHit = {...},
  OnShoot = {
    args = {"handle:GameObject", "Uint32"},
    callback = function(enemy, damage)
      print("You hit " .. NameToString(enemy:GetClassName()) .. "!")
      print("He/She lost " .. tostring(damage) .. " HP.")
    end
  }
})

-- ...

awesome:RegisterShoot(listener:Target(), listener:Function("OnShoot"))

Usage Examples

This example will be using Codeware and its system to listen for game events. It will listen for the event Session/Ready and print a message in CET logs.

local mod = {
  listener = nil
}

-- Define our function to callback
function OnReady(event)
  local isMenu = event:IsPreGame()
  
  print("Event \"Session/Ready\" triggered!")
  if isMenu then
    print("Player is in the pre-game menu")
  else
    print("Player is in the game")
  end
end

registerForEvent('onInit', function()
  -- Create our proxy
  mod.listener = NewProxy({
    OnSessionReady = {
      -- Type is defined in the wiki of Codeware
      args = {"handle:GameSessionEvent"},
      callback = function(event) OnReady(event) end
    }
  })

  -- Register our callback to listen for event "Session/Ready".
  local callbackSystem = Game.GetCallbackSystem()
  local target = mod.listener:Target()
  local fn = mod.listener:Function("OnSessionReady")

  callbackSystem:RegisterCallback("Session/Ready", target, fn)
end)

registerForEvent('onShutdown', function()
  -- Unregister our callback before our mod is "removed".
  local target = mod.listener:Target()
  local fn = mod.listener:Function("OnSessionReady")

  callbackSystem:UnregisterCallback("Session/Ready", target, fn)
end)

Summary

Published: Feb 18 2024 by Last documented edit: Feb 18 2024 by

Where to get cron

You can get Cron.lua from psiberx's cp2077-cet-kit on github. Add it to your sources, and then define it as a global:

-- don't overwrite it if it's already defined in the global scope. Or do, up to you.
Cron = Cron or require('External/Cron.lua')

How to use cron

Cron offers a bunch of functions for executing code later. The code you want to execute has to be inside a function (=> callback) and is passed among the arguments.

For periodically running functions, you need to include logic when to stop the execution.

Performance impact

To save processor load, it is best practice to define your callback outside of the function call. This can have a noticable performance impact, so you're gonna want to do this.

Good example:

local callback = function()
    -- do a little dance, make a little love
end
Cron.Every(0.1, callback)

The callback is defined once.

Bad example:

Cron.Every(0.1, function()
    -- do a little dance, make a little love
end)

The callback is defined every time cron runs.

Passing function arguments

To pass arguments to your callback function, you pass them as arguments to cron:

local callback = function(timer)
    timer.tick = timer.tick +1
    -- do a little dance, make a little love
end
Cron.Every(0.1, { tick = 1 }, callback)

Cron functions

Delay

Execute the callback after X seconds

local callback = function() --[[ do a little dance, make a little love ]] end
Cron.After(0.2, callback)

Timer

Executes a function every X seconds.

local callback = function(timer)
    timer.tick = timer.tick +1
    spdlog.info("Timer is running: " .. tostring(timer.tick))
    -- do a little dance, make a little love
    if timer.tick > 150 then
        Cron.Halt(timer)
    end
end

-- define outside of function scope to re-use this in Cron.Pause example below
local timerArg = { tick = 1 }

-- start timer
Cron.Every(0.2, timerArg, callback)

Pausing and resuming a timer

You can pause a timer by passing its reference to cron:

-- callback and timer have been defined in the example above
-- the timer is running

Cron.Pause(timerArg)
spdlog.info("Timer is paused after " .. tostring(timerArg.tick) .. " ticks")

-- wait 20 seconds, then resume our function
Cron.After(20, function () Cron.Resume(timerArg) end)

⚠️ All examples in this Observe/Override method ShootEvents.OnEnter to gain access to stateContext.

AdjustTransform

Base class for AdjustTransformWithDurations. Seems to do nothing if passed to adjustTransform scriptable parameter. Do not use: your movement will be blocked indefinitely until you reset adjustTransform.

AdjustTransformWithDurations

Discovered by void*

Request to change player trajectory (view angles) and/or player position.

This code has to be executed in the context where you have access to StateContext for example:

Function has 3 types of behavior: set trajectory, set position or set both.

Changing player's trajectory to custom angles

This code will smoothly point your camera towards {0, 0, 0}.

Targeting an GameObject for trajectory

1. Does not change player's pitch.

2. Seems to target "nearest" targeting component (aka hitbox).

3. SetRotation is ignored if target is set.

4. Will freeze player in place/in air while it's aiming (same behavior as )

This function seem to use TargetingSystem to find the "best component" and then calls a LookAt.

(Look at function and one)

Moving player

GetDisplayResolution()

Returns the width and height (respectively) of the game window in pixels.

Definition

GetDisplayResolution() -> float, float

Usage example

width, height = GetDisplayResolution()
print(width, height)

> 1920 1080

GetMod()

Returns the return value of the mod with the given name.

Definition

GetMod(modName: string) -> object

Usage example

mod = GetMod('MyMod')

-- any data returned by the mod

GetSingleton()

Returns the singleton for the given type name if it exists, otherwisenil.

Definition

GetSingleton(singletonTypeName: string) -> SingletonReference | nil

Usage example

gameTime = GetSingleton("gameTimeSystem")

-- get time
gameTime:GetGameTime()

-- set time
gameTime:SetGameTimeByHMS(12, 0, 0) -- 12h0m0s

GameTime[ seconds:734466 ]

GetVersion()

Returns the current CET build's commit hash.

Definition

GetVersion() -> string

Usage example

version = GetVersion()

print(version)

> v1.27.1

ModArchiveExists()

Returns whether the specified .archive file is present in the archive/pc/mod folder

Definition

ModArchiveExists(archiveName: string) -> bool

Usage example

print(ModArchiveExists('myModFiles.archive'))

> true

Detect a Redscript mod

This technique can be used to detect whether your Redscript mod is present, from CET side. It can be useful if you are writing a mod with both languages for some reason.

You can declare a static method without a body. It will do nothing:

// Redscript side
public static func IsDetected_NameOfYourMod() -> Void {}

You can now test whether this method is defined from CET side using this:

-- CET side
function IsRedscriptDetected()
  return Game["IsDetected_NameOfYourMod"] ~= nil
end

You can call IsRedscriptDetected() and it will return true when your Redscript method is detected (meaning your Redscript mod is loaded) or false otherwise.

If you're using redscript modules, and your IsDetected function is inside a module, the name will be mangled to include the full module name and a dot separating it:

// Redscript side
module Module.Name
public static func IsDetected() -> Void {}

-- CET side
function IsRedscriptDetected()
  return Module_Name_IsDetected ~= nil
  -- equivalent syntax without conversion:
  -- return Game["Module.Name.IsDetected"] ~= nil
end

TweakDB is like the game’s database for gameplay features. It’s not actually code itself, but very large amounts of data structures, many of which link together, to make coherent gameplay elements.

TweakDB has two main elements: Flats, and Records Flats are just like a single piece of data, like a number, a string, a pointer to a record, etc. Records are like a collection of flats. Records have possible types, like a character record or a clothing record. The type of record determines what set of flats the record has.

An example of these gameplay features nearly entirely contained in TweakDB, would be the damaging quickhacks like Overheat, Contagion, and Short Circuit. The quickhack item to unlock them is in tweakdb, as well as the process of unlocking, making them show up on enemies, the uploading process, the status effect applied, all the special effects possible, as well as the stats to customize all of these things. Almost anything about these quickhacks can be changed in TweakDB.

DebugStats

Print info about the TweakDB. Displays the number of flats, records, and queries, the size in bytes of flatDataBuffer, and the number of created records.

Definition

TweakDB:DebugStats() -> nil

Usage example

TweakDB:DebugStats()

GetRecord

Get a TweakDB record by name or ID.

Definitions

TweakDB:GetRecord(recordName: string) -> TweakDBRecord

TweakDB:GetRecord(recordID: TweakDBID) -> TweakDBRecord

Usage example

sticky_frag = TweakDB:GetRecord("Items.GrenadeFragSticky")

GetRecords

Get a table of all TweakDB records under a given type.

Definition

TweakDB:GetRecords(recordTypeName: string) -> table<TweakDBRecord>

Usage example

grenades = TweakDB:GetRecords("gamedataGrenade_Record")

Query

Get a TweakDB query by name or ID. Returns a table of TweakDBIDs.

Definitions

TweakDB:Query(queryName: string) -> table<TweakDBID>

TweakDB:Query(queryID: TweakDBID) -> table<TweakDBID>

Usage example

grenade_ids = TweakDB:Query("Query.GrenadeNoFaction")

GetFlat

Get a TweakDB flat by name or ID.

Definitions

TweakDB:GetFlat(flatName: string) -> object

TweakDB:GetFlat(flatID: TweakDBID) -> object

Usage example

jump_stamina_cost = TweakDB:GetFlat("player.staminaCosts.jump")

SetFlat

Set a TweakDB flat by name or ID and update it. Returns whether the flat was successfully set.

Definitions

TweakDB:SetFlat(flatName: string, newValue: object) -> boolean

TweakDB:SetFlat(flatID: TweakDBID, newValue: object) -> boolean

Usage example

success = TweakDB:SetFlat("player.staminaCosts.jump", 7.5)

SetFlatNoUpdate

Set a TweakDB flat by name or ID without updating it. Returns whether the flat was successfully set.

Definitions

TweakDB:SetFlatNoUpdate(flatName: string, newValue: object) -> boolean

TweakDB:SetFlatNoUpdate(flatName: TweakDBID, newValue: object) -> boolean

Usage example

success = TweakDB:SetFlatNoUpdate("player.staminaCosts.jump", 7.5)

Update

Update (flush data of) a TweakDB record by name, ID, or handle. Returns whether the update was successful.

Definitions

TweakDB:Update(recordName: string) -> boolean

TweakDB:Update(recordID: TweakDBID) -> boolean

TweakDB:Update(recordHandle: TweakDBRecord) -> boolean

Usage example

success = TweakDB:Update("player.staminaCosts.jump")

CreateRecord

Create a new TweakDB record. Returns whether the record was created successfully.

Definitions

TweakDB:CreateRecord(recordName: string, recordTypeName: string) -> boolean

TweakDB:CreateRecord(recordID: TweakDBID, recordTypeName: string) -> boolean

CloneRecord

Clone an existing record identified by clonedRecordName or clonedRecordID to a new record named recordName or with a TweakDBID of recordID. Returns whether the record was cloned successfully. If a record named recordName or with ID recordID already exists, this method will fail.

Definitions

TweakDB:CloneRecord(recordName: string, clonedRecordName: string) -> boolean

TweakDB:CloneRecord(recordName: string, clonedRecordID: TweakDBID) -> boolean

TweakDB:CloneRecord(recordID: TweakDBID,  clonedRecordName: string) -> boolean

TweakDB:CloneRecord(recordID: TweakDBID,  clonedRecordID: TweakDBID) -> boolean

DeleteRecord

Delete an existing TweakDB record. Returns whether the record was deleted successfully.

Definitions

TweakDB:DeleteRecord(recordName: string) -> boolean

TweakDB:DeleteRecord(recordID: TweakDBID) -> boolean

Everything you need to know about Dear ImGui can be found and .

Basic Window

Modal/Popup Window

Combo Box with Selectables

Checkbox

Button

Tooltip

Default tooltip on a button.

To customize the tooltip window use BeginTooltip and EndTooltip.

Multi-column layout

Creating a multi-column layout is a pain in the ass, but you can go about it like this:

You can probably use dynamic dimensions somehow. If you find out, please update this guide.

Inputs are buttons events that handle both key press and release states. They must be registered using registerInput() at root level, outside of any event, in the init.lua file.

The button state (press/release) is defined in the first argument passed to the callback.

Definition

Alternative Usage

You can register an Input and make it behave like a Hotkey. This method is more reactive as it triggers on key press, when a Hotkey is triggered on release.

Usage Note

Usage Example

Activate slow motion effect as long as the input key is pressed:

Advanced Example

Continuously give money as long as the input key is pressed:

Confirmed Recipes

1. Game.AddToInventory("Items.LegendaryBootsRecipe", 1)

2. Game.AddToInventory("Items.LegendaryCapRecipe", 1)

3. Game.AddToInventory("Items.LegendaryCasualShoesRecipe", 1)

4. Game.AddToInventory("Items.LegendaryFormalPantsRecipe", 1)

5. Game.AddToInventory("Items.LegendaryFormalShoesRecipe", 1)

6. Game.AddToInventory("Items.LegendaryFormalSkirtRecipe", 1)

7. Game.AddToInventory("Items.LegendaryGlassesRecipe", 1)

8. Game.AddToInventory("Items.LegendaryGogglesRecipe", 1)

9. Game.AddToInventory("Items.LegendaryHatRecipe", 1)

10. Game.AddToInventory("Items.LegendaryJacketRecipe", 1)

11. Game.AddToInventory("Items.LegendaryJumpsuitRecipe", 1)

12. Game.AddToInventory("Items.LegendaryPantsRecipe", 1)

13. Game.AddToInventory("Items.LegendaryScarfRecipe", 1)

14. Game.AddToInventory("Items.LegendaryShirtRecipe", 1)

15. Game.AddToInventory("Items.LegendaryShortsRecipe", 1)

16. Game.AddToInventory("Items.LegendaryTechRecipe", 1)

17. Game.AddToInventory("Items.LegendaryTightJumpsuitRecipe", 1)

18. Game.AddToInventory("Items.LegendaryTShirtRecipe", 1)

19. Game.AddToInventory("Items.LegendaryVestRecipe", 1)

20. Game.AddToInventory("Items.LegendaryVisorRecipe", 1)

21. Game.AddToInventory("Items.EpicBootsRecipe", 1)

22. Game.AddToInventory("Items.EpicCapRecipe", 1)

23. Game.AddToInventory("Items.EpicCasualShoesRecipe", 1)

24. Game.AddToInventory("Items.EpicCoatRecipe", 1)

25. Game.AddToInventory("Items.EpicFormalJacketRecipe", 1)

26. Game.AddToInventory("Items.EpicFormalShoesRecipe", 1)

27. Game.AddToInventory("Items.EpicFormalSkirtRecipe", 1)

28. Game.AddToInventory("Items.EpicGlassesRecipe", 1)

29. Game.AddToInventory("Items.EpicHatRecipe", 1)

30. Game.AddToInventory("Items.EpicHelmetRecipe", 1)

31. Game.AddToInventory("Items.EpicLooseShirtRecipe", 1)

32. Game.AddToInventory("Items.EpicMaskRecipe", 1)

33. Game.AddToInventory("Items.EpicPantsRecipe", 1)

34. Game.AddToInventory("Items.EpicScarfRecipe", 1)

35. Game.AddToInventory("Items.EpicShortsRecipe", 1)

36. Game.AddToInventory("Items.EpicTShirtRecipe", 1)

37. Game.AddToInventory("Items.EpicUndershirtRecipe", 1)

38. Game.AddToInventory("Items.EpicVisorRecipe", 1)

39. Game.AddToInventory("Items.RareBootsRecipe", 1)

40. Game.AddToInventory("Items.RareCasualShoesRecipe", 1)

41. Game.AddToInventory("Items.RareCoatRecipe", 1)

42. Game.AddToInventory("Items.RareFormalJacketRecipe", 1)

43. Game.AddToInventory("Items.RareFormalPantsRecipe", 1)

44. Game.AddToInventory("Items.RareFormalShoesRecipe", 1)

45. Game.AddToInventory("Items.RareGlassesRecipe", 1)

46. Game.AddToInventory("Items.RareHatRecipe", 1)

47. Game.AddToInventory("Items.RareHelmetRecipe", 1)

48. Game.AddToInventory("Items.RareJacketRecipe", 1)

49. Game.AddToInventory("Items.RareMaskRecipe", 1)

50. Game.AddToInventory("Items.RarePantsRecipe", 1)

51. Game.AddToInventory("Items.RareScarfRecipe", 1)

52. Game.AddToInventory("Items.RareShirtRecipe", 1)

53. Game.AddToInventory("Items.RareShortsRecipe", 1)

54. Game.AddToInventory("Items.RareTechRecipe", 1)

55. Game.AddToInventory("Items.RareTShirtRecipe", 1)

56. Game.AddToInventory("Items.RareUndershirtRecipe", 1)

57. Game.AddToInventory("Items.RareVestRecipe", 1)

58. Game.AddToInventory("Items.UncommonBalaclavaRecipe", 1)

59. Game.AddToInventory("Items.UncommonBootsRecipe", 1)

60. Game.AddToInventory("Items.UncommonCapRecipe", 1)

61. Game.AddToInventory("Items.UncommonCasualShoesRecipe", 1)

62. Game.AddToInventory("Items.UncommonFormalPantsRecipe", 1)

63. Game.AddToInventory("Items.UncommonFormalShoesRecipe", 1)

64. Game.AddToInventory("Items.UncommonFormalSkirtRecipe", 1)

65. Game.AddToInventory("Items.UncommonHatRecipe", 1)

66. Game.AddToInventory("Items.UncommonHelmetRecipe", 1)

67. Game.AddToInventory("Items.UncommonJacketRecipe", 1)

68. Game.AddToInventory("Items.UncommonMaskRecipe", 1)

69. Game.AddToInventory("Items.UncommonPantsRecipe", 1)

70. Game.AddToInventory("Items.UncommonShirtRecipe", 1)

71. Game.AddToInventory("Items.UncommonTechRecipe", 1)

72. Game.AddToInventory("Items.UncommonUndershirtRecipe", 1)

73. Game.AddToInventory("Items.UncommonVestRecipe", 1)

74. Game.AddToInventory("Items.UncommonVisorRecipe", 1)

Raw List

The txt file below contains a dump directly from the game files of all currently known items in the game's TweakDB.

File Exists

Definition

fileExists(path: string) -> boolean

Usage example

print(fileExists('my_file.lua'))
-- true

Source code

function fileExists(path)
    local f = io.open(path, 'r')
    return f ~= nil and io.close(f)
end

Get Files Recursively

Definition

getFilesRecursive(path: string, maxDepth: integer) -> table

--
-- getFilesRecursive()
--
-- @param  string    path      The starting path: Default: '.' (mod's root folder)
-- @param  integer   maxDepth  The maximum depth allowed. Default: -1 (unlimited)
--
getFilesRecursive('.', -1)

Usage example

local files = getFilesRecursive('.', 2)

files = {
    "./includes/module-1.lua",
    "./includes/module-2.lua",
    "./includes/sub-folder/sub-module-1.lua",
    "./init.lua",
}

Source code

function getFilesRecursive(path, maxDepth, depth, storage)

    -- vars
    path = path or '.'
    maxDepth = maxDepth or -1
    depth = depth or 0
    storage = storage or {}

    -- validate maxDepth
    if maxDepth ~= -1 and depth > maxDepth then
        return storage
    end

    -- sanitize path leading "."
    if not string.find(path, '^%.') then
        path = '.' .. path
    end

    -- sanitize path leading double "//"
    if string.find(path, '^%.//') then
        path = string.gsub(path, '^%.//', './')
    end

    -- get dir/files
    local files = dir(path)

    -- validate files
    if not files or (type(files) == 'table' and #files == 0) then
        return storage
    end

    -- loop files
    for _, file in ipairs(files) do

        -- directory
        if file.type == 'directory' then
            getFilesRecursive(path .. '/' .. file.name, maxDepth, depth + 1, storage)

        -- lua file
        elseif string.find(file.name, '%.lua$') then
            table.insert(storage, path .. '/' .. file.name)
        end

    end

    return storage

end

Get Folders Recursively

Definition

getFoldersRecursive(path: string, maxDepth: int) -> table

--
-- getFoldersRecursive()
--
-- @param  string    path      The starting path: Default: '.' (mod's root folder)
-- @param  integer   maxDepth  The maximum depth allowed. Default: -1 (unlimited)
--
getFoldersRecursive('.', -1)

Usage example

local folders = getFoldersRecursive('.', 2)

folders = {
    "./includes",
    "./includes/sub-folder",
}

Source code

function getFoldersRecursive(path, maxDepth, depth, storage)

    -- vars
    path = path or '.'
    maxDepth = maxDepth or -1
    depth = depth or 0
    storage = storage or {}

    -- validate maxDepth
    if maxDepth ~= -1 and depth > maxDepth then
        return storage
    end

    -- sanitize path leading "."
    if not string.find(path, '^%.') then
        path = '.' .. path
    end

    -- sanitize path leading double "//"
    if string.find(path, '^%.//') then
        path = string.gsub(path, '^%.//', './')
    end

    -- get dir/files
    local files = dir(path)

    -- validate files
    if not files or (type(files) == 'table' and #files == 0) then
        return storage
    end

    -- loop files
    for _, file in ipairs(files) do

        -- directory
        if file.type == 'directory' then
            table.insert(storage, path .. '/' .. file.name)
            getFoldersRecursive(path .. '/' .. file.name, maxDepth, depth + 1, storage)
        end

    end

    return storage

end

print()

Prints one or more objects to the and file. Multiple objects will be printed separated by a space.

Definition

Usage example

spdlog

Write a string in the file, eg, <cet_path>/mods/my_mod/my_mod.log.

There are several spdlog methods, all are identical and have the same output:

• spdlog.debug()

• spdlog.trace()

• spdlog.info()

• spdlog.warning()

• spdlog.error()

• spdlog.critical()

Definition

Usage example

Usage tips

It is recommended to use spdlog.info(tostring(my_var)) to make sure the variable is compatible, as boolean, interger and other types will throw an error.

Dump()

Returns a JSON-ish string with details about the members of obj:

• Type name

• Instance functions

• Static functions

• Properties

The listed functions include their signatures.

If detailed is true, function descriptions will include the function's full name hash, short name, and short name hash.

Definition

Usage example

GameDump()

Returns the game's internal debug string for the given object. This string displays the object's properties and their values.

Definition

Usage example

DumpType()

Like , but takes a type name rather than an object instance. Use to get a list of all types.

Definition

Usage example

DumpAllTypeNames()

Dump all type names to <cet_path>/cyber_engine_tweaks.log and prints to the the number of types dumped.

Definition

Usage example

This event gets triggered even before , and can be useful for making changes to the TweakDB, as some values can only be changes very early during the loading process.

Override is a built-in CET function allowing developers to rewrite a game's class method. It must be registered using the Override() function inside the onInit event, in the init.lua file.

The provided callback is always filled as follows:

• The first argument is the current object that execute the method. This argument is not present when function/method is static.

• Others arguments passed to the targeted method, if any.

• The last argument is the original callable method.

Definition

Override(className, method, callback)

--
-- Override()
--
-- @param  string    className  The parent class name
-- @param  string    method     The method name to target
-- @param  function  callback   The callback function
--
Override('className', 'method', function(self [, arg1, arg2, ...], wrappedMethod)
    
    -- rewrite method()
    
end)

Representation

Considering the following class and method:

public class AimingStateEvents extends UpperBodyEventsTransition {

    protected func OnEnter(stateContext: ref<StateContext>, scriptInterface: ref<StateGameScriptInterface>) -> Void {
        
        let aimingCost: Float;
        let focusEventUI: ref<FocusPerkTriggerd>;
        let timeDilationFocusedPerk: Float;
        let weaponType: gamedataItemType;
        let player: ref<PlayerPuppet> = scriptInterface.executionOwner as PlayerPuppet;
        // ...
        
    }

}

When applying Override(), the callback would be filled with the following arguments:

Override('AimingStateEvents', 'OnEnter', function(self, stateContext, scriptInterface, wrappedMethod)
    
    -- self             the 'AimingStateEvents' object
    -- stateContext     the original method first argument
    -- scriptInterface  the original method second argument
    -- wrappedMethod    the original 'OnEnter' callable method
    
end)

Using Wrapped Method

The last argument of the Override() function, wrappedMethod, contains the original method as a callable function. We can use it to execute the original code and/or retrieve its result (if it returns something).

It is highly recommended to know the overriden method return statement to avoid breaking the script, and use wrappedMethod accordingly.

Method -> Void

Any method declared void doesn't return a value. Overriding it follow the same logic:

public class CrouchDecisions extends LocomotionGroundDecisions {

    public func OnStatusEffectApplied(statusEffect: wref<StatusEffect_Record>) -> Void {
        // ...
    }
    
}

Override('CrouchDecisions', 'OnStatusEffectApplied', function(self, statusEffect, wrappedMethod)
    
    -- execute original code
    wrappedMethod(statusEffect)
    
    -- do something
    
end)

Method -> Bool / Int / Float etc...

The same logic is applied to methods with a specific return statement. Overriding it must return a compatible type:

public class CrouchDecisions extends LocomotionGroundDecisions {

    protected cb func OnControllingDeviceChange(value: Bool) -> Bool {
        // ...
    }
    
}

Override('CrouchDecisions', 'OnControllingDeviceChange', function(self, value, wrappedMethod)
    
    -- execute & retrieve original code
    local result = wrappedMethod(value)
    
    -- check our condition
    if condition then
        return result -- return original code
    else
        return false -- return false
    end
    
end)

Usage Example

Do not allow the player to crouch:

-- onInit
registerForEvent('onInit', function()
    
    -- observe CrouchDecisions EnterCondition state
    Override('CrouchDecisions', 'EnterCondition', function(self, stateContext, scriptInterface, wrappedMethod)
        
        return false
        
    end)
    
end)

Advanced Example

Do not allow the player to crouch if in ADS:

-- set initial vars
isADS = false

-- onInit
registerForEvent('onInit', function()

    -- observe ADS OnEnter state
    Observe('AimingStateEvents', 'OnEnter', function(self, stateContext, scriptInterface)
        isADS = true
    end)

    -- observe ADS OnExit state
    Observe('AimingStateEvents', 'OnExit', function(self, stateContext, scriptInterface)
        isADS = false -- reset condition
    end)

    -- observe CrouchDecisions EnterCondition state
    Override('CrouchDecisions', 'EnterCondition', function(self, stateContext, scriptInterface, wrappedMethod)

        -- retrieve original code result
        local result = wrappedMethod(stateContext, scriptInterface)

        -- check ADS state
        if isADS then
            return false -- disallow crouch
        end

        -- otherwise return original logic
        return result

    end)

end)

The config file can be found in: <cet install path>/config.json

The config file is structured with two JSON layers, we use the format <first level>.<second level> to represent the key.

Consider the example JSON snippet below, the key for the base size of the font is noted as font.base_size, which carries a value of 16.0.

Developer

Font

Patches

Deprecated Patches

These are the 0old Cyber Engine Tweaks config file patches for reference.