Cyber Engine Tweaks is a framework that allows modders to interact with the game's internal functions using Lua. 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.

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

🔒 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?

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

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 official instructions.

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 Lutris, Minigalaxy or GameHub, 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 Winetricks 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

• @bundyo

• @okamidash (Author)

Install CET Mods?

You can find a very detailed step-by-step guide here for first-time users.

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

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

Create my own mod?

Checkout the Modding Introduction page for your first steps:

General troubleshooting

Before trying anything else, please make sure that your Windows and your graphics driver are up-to-date – this actually helps in around 50% of all cases. If you need instructions, you can find them in the red box under the general troubleshooting guide's section.

Step 0: Go to your install directory

Go to your Cyberpunk 2077 game directory, since all paths given in this guide will be relative to that folder.

Example:

Step 0.5: Update your game and the mod

For that reason, the Redmodding Discord can only support you the most recent version.

If there's a mismatch, then you can find a warning in the following file:

bin\x64\plugins\cyber_engine_tweaks\cyber_engine_tweaks.log

If you don't have that file, proceed to Step 2.

Step 1: Check the install folder

bin\x64\plugins

It should have at least the following files:

If you do not have these folders, then CET isn't installed correctly. Head to #reinstall-cetand start with step 3.

Step 2: Check for a log file

If everything looks okay in step 1, check if you have a file cyber_engine_tweaks.log inside the cyber_engine_tweaks folder from the previous screenshot.

You don't have a log file

No log file means that CET isn't starting up.

• The easiest fix is to #reinstall-cet.

• If you did that and it didn't help, check your antivirus. Most likely, it is protecting you from scary things like Cyber Engine Tweaks. Disable it.

• If that didn't help either, update everything - Windows, your drivers, etc. You can find links and instructions in the red box on the general troubleshooting page.

You have a log file

• If you do have it, you can open it and try to make sense of the error message. You can find more information on that here, or find help in the #cet-suppport channel on our Discord.

Reinstall CET

1. If you are using Vortex, turn it off (it will get angry otherwise)

2. • rename bin/x6/plugins to plugins_ or

   • delete the file bin/x6/plugins/cyber_engine_tweaks.asi

   • move the folder bin/x6/plugins/cyber_engine_tweaks out of plugins (e.g. your Desktop). Do not delete it yet.

3. Download the most recent CET from Nexus

4. Extract the downloaded archive to your game directory (the bin folder will merge with the one that is already there)

5. Start the game: CET should now ask you to bind a key. If it doesn't:

   1. Update both the game and the mod (double-check if you're sure)

   2. Head to the troubleshooting guide and follow the steps in the red box at the top

6. Optional: Restore your mods and/or settings Now that CET works, find the old directory from step 2. Move the following files/folders:

   1. Mods: the directory mods from the old cyber_engine_tweaks folder

   2. Settings: The .json files directly inside cyber_engine_tweaks

7. Optional: delete the old folder (or leave it, it's your diskspace)

8. That's it! You're good to go!

Reset your keybind

1. Find the file \bin\x64\plugins\cyber_engine_tweaks\bindings.json and delete it.

2. Start the game.

3. You should now see a popup asking you to bind a key. Otherwise, read on.

I can't bind a key

Click into the "Binding..." field.

If that doesn't help, make sure to turn off all your overlays (Discord, Steam, Microsoft Game Bar, Random Useless Bloatware) or start Cyberpunk in the Windowed Borderless mode.

Microstutters and Performance

If you're experiencing performance issues with CET, first make sure to #reinstall-cet as per the instructions to rule out side effects from old files.

If that doesn't make the problems go away, make sure to update Windows and your graphics driver as per the red box under Troubleshooting's section.

If that doesn't help, you can find us in #cet-support on the REDmodding Discord. Please note that people there will first suggest everything else from this guide, so you might as well get it out of the way first.

Crash to Desktop on Alt+Tab

Make sure to update Windows and your graphics driver as per the red box under Troubleshooting's section, as this is the only chance you have of getting rid of your crashes.

This is a known issue with AMD cards, and it's not something the CET developers can fix. Everyone who could fix it is informed, but such things take time. If you're on an AMD card, you can try running your game in Windowed Borderless mode. Otherwise, you just have to live with the crashes.

Frequent Issues and Solutions

I receive an error saying 'Unknown Version'

Please ensure the following:

1. If you have modified your game's .exe file yourself, the mod will not work - to undo this, delete the file and verify your game through GOG, Steam or Epic to download a fresh copy of the newest exe.

2. Update your game. You are using a patch that is not supported. Only current versions are supported. (current version is 1.6)

3. You used the old version of the mod and still have the old files installed. Delete bin/x64/plugins/ and reinstall the mod.

4. Do a repair on your installation with no other mod files installed (redscript, cet, et cetera) then install CET as you normally would and check the log file. If it still isn't working, uninstall cyberpunk 2077 and do a complete wipe of the install folder.

No log file appears in bin/x64/plugins/cyber_engine_tweaks/

Install this - if nothing happens, please make sure all of your overlays and monitoring programs are disabled. There is a list of known programs that cause issues below. If you find one not on the list, contact Arsenic_Touch via the discord.

I don't have a config file in bin/x64/plugins/cyber_engine_tweaks/

Cyber Engine Tweaks no longer comes with a config file, one is generated when you first launch the mod.

The CET window will not close.

When first launching cyber engine tweaks, it will prompt you to pick a keybind. Tilde is no longer the default. Keyboard input is blocked until a keybind is chosen. If you do not see the pop up, look below for further troubleshooting steps.

When I press the key to show the console, I only see the cursor!

Certain programs conflict with the hook that Cyber Engine Tweaks use to display the console - to avoid this, disable any software with overlays that may impact the mod (some examples below). This includes crashing the game or not launching at all. OBS graphics-hook32.dll and graphics-hook64.dll can also interfere. Do a search of your windows files to see if you have a program running them. For rivatuner, you can also open the Global file with notepad++, which is located in RivaTuner Statistics Server\ProfileTemplates and add cyber_engine_tweaks.asi to the end of the decimal in the line: InjectionDelayTriggers

1. AMD Radeon

2. Discord

3. Geforce Experience

4. Steam

5. XBOX Game Bar

6. MSI Afterburner

7. Rivatuner

8. GoG Galaxy

9. Epic

10. NZXT Cam

11. Ubisoft Connect

Cyberpunk crashes after the intro video when using CET 1.14

1. Open Windows Security

2. Go to Apps & Browser control on the left tabs

3. Click Exploit protection settings Under the Exploit Protection section

4. In the Systems Settings tab locate Randomize memory allocations (Button-up ASLR) and High-entropy ASLR and change their settings to Use default (On).

5. Restart your computer.

Credit to discord user @rachmanov1c @OrBy

The mod isn't working with my version of the game!

Please verify that:

1. Your version of Cyberpunk is compatible with the newest release on GitHub or Nexus (this can be seen in the menu, underneath "Quit Game")

2. You have the most recent version of the mod from GitHub or Nexus.

3. The installation guide has been followed correctly

4. You have verified that the log found in bin/x64/plugins/cyber_engine_tweaks/cyber_engine_tweaks.log is 'last modified' at the same time and date as your most recent attempt to launch the game

5. Remove all previous mods in the mods folder and try to launch the game. If it works, add your mods back one by one until you find the one that breaks CET. Some mods can break CET completely or change the overlay colour if they are not up to date.

If installed through vortex and your game won't launch.

1. Make sure cyber engine tweaks and your mods are installed with hardlink deployment If hardlink doesn't show up under vortex, make sure the Vortex Mods folder is on the same partition as the game mods folder. This explains it more.

2. Make sure you're using the most up to date vortex plugin for cyberpunk 2077. Check the #vortex-support channel on the discord for the latest information.

The prompt to choose a keybind doesn't appear and or pressing the chosen keybind does not bring up the mod.

There are six possible solutions to this:

1. Ensure your game is in Windowed Borderless mode - Cyberpunk will usually make itself the topmost application on your screen if in fullscreen.

2. Ensure you don't have any overlay or monitoring software running such as Rivatuner, Fraps, etc.

3. Make sure your game is up to date and you are using the latest version of Cyber Engine Tweaks and that you installed it properly. (do a clean install by deleting the plugins folder, LICENSE, global.ini, version.dll files if you are running into a problem)

4. Run the game as administrator. (this works for some people where other methods have failed)

5. Check to make sure your antivirus software is not removing or blocking cyber engine tweaks.

6. Do a complete reinstall of cyberpunk 2077.

I forgot the keybind to bring up the overlay for CET.

1. Delete the bindings.json file located inbin/x64/plugins/cyber_engine_tweaks/ and start your game, the overlay will to choose a new keybind should come up. If it doesn't, check the known list of programs that can interfere.

I can bring up the CET overlay but my image is frozen on intro videos

If you see in your log that your game is freezing on CRender and you have problem like this you should try steps provided below.

1. If you are using mod manager disable CET temporarily, if you are not using mod manager then follow uninstallation guide. 2. Launch the game without CET and disable FSR/DLSS 3. Install/Enable Cyber Engine Tweaks and launch the game, the problem should be gone.

Submitting an issue

Please ensure you attempt deleting and reinstalling the mod before submitting an issue! Alternatively, consider asking in the Discord server. Additionally, please check to ensure your issue has not already been reported!

If you cannot find your problem listed, submit an issue on GitHub with the following:

• Your configuration file

• Your Cyber Engine Tweaks version and your Cyberpunk 2077 version

• Your log file

• Your OS version

• A description of your issue

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.

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

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:

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("Items.money", 10000) -- Gives 10,000 eurodollars
Game.AddToInventory("Items.SQ031_Samurai_Jacket", 1) -- Gives you the Replica of Johnny's Samurai Jacket 

Game.AddToInventory("Ammo.HandgunAmmo", 500)
Game.AddToInventory("Ammo.RifleAmmo", 700)
Game.AddToInventory("Ammo.ShotgunAmmo", 100)
Game.AddToInventory("Ammo.SniperRifleAmmo", 100)

Game.AddToInventory("Items.CommonMaterial1", 1000)
Game.AddToInventory("Items.UncommonMaterial1", 1000)
Game.AddToInventory("Items.RareMaterial1", 1000)
Game.AddToInventory("Items.EpicMaterial1", 1000)
Game.AddToInventory("Items.LegendaryMaterial1", 1000)

Game.AddToInventory("Items.QuickHackUncommonMaterial1", 1000)
Game.AddToInventory("Items.QuickHackRareMaterial1", 1000)
Game.AddToInventory("Items.QuickHackEpicMaterial1", 1000)
Game.AddToInventory("Items.QuickHackLegendaryMaterial1", 1000)

Level

Game.SetLevel("Level", 60, 1) -- Sets character level to 60

Attributes

PlayerDevelopmentSystem.GetInstance(Game.GetPlayer()):GetDevelopmentData(Game.GetPlayer()):SetAttribute("Strength", 15) -- Sets Body to 15

Perk and Skill Points

PlayerDevelopmentSystem.GetInstance(Game.GetPlayer()):GetDevelopmentData(Game.GetPlayer()):AddDevelopmentPoints(5, gamedataDevelopmentPointType.Attribute) -- Attribute (skill) points
PlayerDevelopmentSystem.GetInstance(Game.GetPlayer()):GetDevelopmentData(Game.GetPlayer()):AddDevelopmentPoints(3, gamedataDevelopmentPointType.Primary) -- Perk points

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:

print(Game.GetPlayer():GetWorldPosition())

Go somewhere else

Game.GetTeleportationFacility():Teleport(GetPlayer(), ToVector4{x=X, y=Y, z=Z, w=1}, ToEulerAngles{roll=0, pitch=0, yaw=0})

Facts

Game.GetQuestsSystem():SetFactStr("sq032_johnny_friend", 1)

Game.GetQuestsSystem():SetFactStr("mq007_skippy_aim_at_head", 1)

Game.GetQuestsSystem():SetFactStr("mq007_skippy_goes_emo", 0)

Game.GetQuestsSystem():SetFactStr("q005_jackie_to_hospital", 0)
Game.GetQuestsSystem():SetFactStr("q005_jackie_to_mama", 0)
Game.GetQuestsSystem():SetFactStr("q005_jackie_stay_notell", 1)

Game.GetQuestsSystem():SetFactStr("q112_takemura_dead", 1)

How do I stop my character from being a "never-nude"?

This gets rid of the character always wearing underwear in the world. Courtesy of Alacrity#5065 on Discord.

1. Open archive/basegame_4_gamedata.archive in your favorite HexEditor.

2. Do a Find & Replace All for underwear and replace with underw_ar.

3. Save archive file.

4. Enjoy not being a never-nude.

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.

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

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

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

Click here for the ultimate guide.

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

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

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"

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)

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

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.

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

Developer

Font

Patches

Deprecated Patches

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

Change font & language setting

A guide on how to change the font and font size for Cyber Engine Tweaks and mods based on Cyber Engine Tweaks. And how to display non-English characters.

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 github repo.

Setting up the folder

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

Cyberpunk 2077/
├─ bin/
│  ├─ x64/
│  │  ├─ plugins/
│  │  │  ├─ cyber_engine_tweaks/
│  │  │  │  ├─ mods/
│  │  │  │  │  ├─ mod_1/
│  │  │  │  │  ├─ mod_2/
│  │  │  │  │  ├─ mod_3/
│  │  │  │  │  ├─ my_mod/ <- here

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.

../
├─ cyber_engine_tweaks/
│  ├─ mods/
│  │  ├─ my_mod/
│  │  │  ├─ init.lua

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 CET Console using the print() function. Then register a listener on the onInit event, and print something else.

-- mod info
mod = {
    ready = false
}

-- print on load
print('My Mod is loaded!')

-- onInit event
registerForEvent('onInit', function() 
    
    -- set as ready
    mod.ready = true
    
    -- print on initialize
    print('My Mod is initialized!')
    
end)

-- return mod info 
-- for communication between mods
return mod

Launch the game, and open the CET Console. 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 Scripting API 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

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

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

// my_script.reds
LogChannel(n"DEBUG", "My Custom Log");

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.

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, 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 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

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. • The lib files linked above is not the newest version.
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

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.

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)

Opposing to onInit, 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 CET Overlay.

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

Usage Example

registerForEvent('onShutdown', function()

    -- cleanup code
    
end)

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 Observers, as well as do any one-off actions needed for your mod.

Usage Example

registerForEvent('onInit', function()

    print('Game is loaded')
    
end)

This event works similarly to onUpdate, 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:

registerForEvent('onDraw', function()

    if ImGui.Begin('Window Title', ImGuiWindowFlags.AlwaysAutoResize) then
        ImGui.Text('Hello World!')
    end
    
    ImGui.End()
    
end)

Advanced Example

Render an ImGui window when the player is sprinting:

-- set initial switch
isSprinting = false

-- onInit
registerForEvent('onInit', function()
    
    -- observe Sprint OnEnter state
    Observe('SprintEvents', 'OnEnter', function(stateContext, scriptInterface)
        isSprinting = true
    end)
    
    -- observe Sprint OnExit state
    Observe('SprintEvents', 'OnExit', function(stateContext, scriptInterface)
        isSprinting = false -- reset switch
    end)

end)

-- onDraw
registerForEvent('onDraw', function()
    
    -- bail early if not sprinting
    if not isSprinting then
        return
    end
    
    -- draw window
    if ImGui.Begin('Notification', ImGuiWindowFlags.AlwaysAutoResize) then
        ImGui.Text('Nice sprint!')
    end
    
    ImGui.End()
    
end)

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.

Introduction

Cyber Engine Tweaks allow mods to register hotkeys that can be assigned by the player in the , and execute custom code once pressed. There are two kinds of hotkeys:

• are triggered on key release

• are triggered on key press and release

Hotkeys and Inputs, while having similar functionalities, are displayed in two separated groups.

General Notes

Available Functions

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

registerHotkey(slug, label, callback)

--
-- registerHotkey()
--
-- @param  string    slug      The internal slug (must be unique in your mod scope)
-- @param  string    label     The label displayed in CET Bindings
-- @param  function  callback  The callback function
--
registerHotkey('slug', 'label', function()
    
    -- hotkey is released
    
end)

Usage Example

Give money with a hotkey:

registerHotkey('give_money', 'Give Money', function()
    
    Game.AddToInventory('Items.money', 1000)
    
end)

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

registerInput(slug, label, callback)

--
-- registerInput()
--
-- @param  string    slug      The internal slug (must be unique in your mod scope)
-- @param  string    label     The label displayed in CET Bindings
-- @param  function  callback  The callback function
--
registerInput('slug', 'label', function(keypress)
    
    if keypress then
        -- key is pressed
    else
        -- key is released
    end
    
end)

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.

registerInput('slug', 'label', function(keypress)
    
    -- bail early on key release
    if not keypress then
        return
    end
    
    -- key is pressed
    
end)

Usage Note

registerInput('slug', 'label', function(keypress)
    
    -- this will be called 2 times!
    
end)

Usage Example

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

-- register input
registerInput('slow_motion', 'Slow Motion', function(keypress)
    
    -- get time system
    local timeSystem = Game.GetTimeSystem()
    
    -- bail early if time system doesn't exists
    if not timeSystem then
        return
    end
    
    -- key is pressed
    if keypress then
        timeSystem:SetTimeDilation('MySlowMo', 0.3)
        
    -- key is released
    else
        timeSystem:UnsetTimeDilation('MySlowMo')
    end


end)

Advanced Example

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

-- set initial switch state
keep_giving = false

-- register input
registerInput('give_continuous_money', 'Give Continuous Money', function(keypress)

    -- input pressed
    if keypress then
        keep_giving = true -- switch on

    -- input released
    else
        keep_giving = false -- switch off
    end

end)

-- onUpdate
-- this event is triggered continuously
registerForEvent('onUpdate', function()
    
    -- check switch state
    if keep_giving then
        Game.AddToInventory('Items.money', 20)
    end

end)

Observers are builtin CET functions that allow developers to detect when a function/method is executed by the game. They must be registered inside the onInit event, in the init.lua file.

There are two kinds observers:

• ObserveBefore() which is triggered right at the moment the function/method is called

• ObserveAfter() which is triggered once the game finished to execute the function/method

The provided callback is always filled as follow:

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

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

Definition

Observe(className, method, callback) -- alias of ObserveBefore()

ObserveBefore(className, method, callback)

ObserveAfter(className, method, callback)

--
-- ObserveBefore()
--
-- @param  string    className  The parent class name
-- @param  string    method     The method name to target
-- @param  function  callback   The callback function
--
ObserveBefore('className', 'method', function(self [, arg1, arg2, ...])
    
    -- method() has just been called
    
end)

--
-- ObserveAfter()
--
-- @param  string    className  The parent class name
-- @param  string    method     The method name to target
-- @param  function  callback   The callback function
--
ObserveAfter('className', 'method', function(self [, arg1, arg2, ...])
    
    -- method() has been called and fully executed
    
end)

Representation

Here is a visual representation showing where observers are executed in the game's script:

public class AimingStateEvents extends UpperBodyEventsTransition {

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

}

In this representation, the observer callback would be filled with the following arguments:

Observe('AimingStateEvents', 'OnEnter', function(self, stateContext, scriptInterface)
    
    -- self             the 'AimingStateEvents' class
    -- stateContext     the original method argument
    -- scriptInterface  the original method argument
    
end)

In the code above, the observer listens to AimingStateEvents:OnEnter(), which is triggered everytime the player enters in ADS state.

Additionally, the OnEnter() method is responsible to apply different effects, like the camera zoom, the initial stamina drain etc... Following this logic, this means:

• Using ObserveBefore() allows to hook in before these effects are applied

• Using ObserveAfter() guarantees the method finished to apply all the effects

Usage Examples

Give money each time the player crouches:

-- onInit
registerForEvent('onInit', function()
    
    -- observe crouch OnEnter state
    Observe('CrouchEvents', 'OnEnter', function(self, stateContext, scriptInterface)
        
        Game.AddToInventory('Items.money', 1000)
        
    end)
    
end)

Give money as long as the player is crouched:

-- onInit
registerForEvent('onInit', function()
    
    -- observe crouch OnUpdate state
    -- this is triggered continuously, as long as the player is crouched
    Observe('CrouchEvents', 'OnUpdate', function(self, timeDelta, stateContext, scriptInterface)
        
        Game.AddToInventory('Items.money', 20)
        
    end)
    
end)

Observe event send to an AnimationControllerComponent (click on function's name in NativeDB to copy the full name in your clipboard):

-- init.lua

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

  -- NativeDB will copy 'entAnimationControllerComponent::PushEvent;GameObjectCName'
  -- We can ignore the left part to only keep:
  Observe('AnimationControllerComponent', 'PushEvent;GameObjectCName', function(gameObject, eventName)
    print('GameObject:', gameObject:GetClassName())
    print('Event:', eventName)
  end)

end)

Advanced Example

Give money when the player is crouched and in ADS:

-- set initial vars
isADS = false
isCrouch = false

-- decide to give money
-- this function can be defined outside of onInit
-- as it is only called within observers
shouldGiveMoney = function()
    
    -- is in ADS and is crouched
    if isADS and isCrouch then
        Game.AddToInventory('Items.money', 1000)
    end

end

-- onInit
registerForEvent('onInit', function()
    
    -- observe ADS OnEnter state
    Observe('AimingStateEvents', 'OnEnter', function(self, stateContext, scriptInterface)
        
        isADS = true
        shouldGiveMoney()
        
    end)
    
    -- observe ADS OnExit state
    Observe('AimingStateEvents', 'OnExit', function(self, stateContext, scriptInterface)
        isADS = false -- reset condition
    end)
    
    -- observe Crouch OnEnter state
    Observe('CrouchEvents', 'OnEnter', function(self, stateContext, scriptInterface)
        
        isCrouch = true
        shouldGiveMoney()
        
    end)
    
    -- observe Crouch OnExit state
    Observe('CrouchEvents', 'OnExit', function(self, stateContext, scriptInterface)
        isCrouch = false -- reset condition
    end)

end)

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)

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

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

print()

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

Definition

print(obj: object, [obj2: object, [...]]) -> nil

Usage example

print('Hey', 'there', 1, 2, true)

> Hey there 1 2 true

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

spdlog.info(string: string) -> nil

Usage example

spdlog.info('Custom log')

> [02:31:08] Cutom log

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

Dump(obj: GameDataType, detailed: bool) -> string

Usage example

print(Dump(Game.GetPlayer(), false))

{
    name: PlayerPuppet,
    functions: {
        IsPlayer() => (Bool),
        IsReplacer() => (Bool),
        IsVRReplacer() => (Bool),
        IsJohnnyReplacer() => (Bool),
        IsReplicable() => (Bool),
        GetReplicatedStateClass() => (CName),
        IsCoverModifierAdded() => (Bool),
        IsWorkspotDamageReductionAdded() => (Bool),
        IsWorkspotVisibilityReductionActive() => (Bool),
        GetOverlappedSecurityZones() => (array:gamePersistentID),
        ...
}

GameDump()

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

Definition

GameDump(obj: GameDataType) -> string

Usage example

print(GameDump(Game.GetPlayer()))

> PlayerPuppet[ customCameraTarget:ECCTV_OnlyOnscreen, renderSceneLayerMask:<Default;Cyberspace>, persistentState:, playerSocket:gamePlayerSocket[ ], ...]

DumpType()

Definition

DumpType(typeName: string, detailed: boolean) -> string

Usage example

print(DumpType('PlayerPuppet', false))

{
    name: PlayerPuppet,
    functions: {
        IsPlayer() => (Bool),
        IsReplacer() => (Bool),
        IsVRReplacer() => (Bool),
        IsJohnnyReplacer() => (Bool),
        IsReplicable() => (Bool),
        GetReplicatedStateClass() => (CName),
        IsCoverModifierAdded() => (Bool),
        IsWorkspotDamageReductionAdded() => (Bool),
        IsWorkspotVisibilityReductionActive() => (Bool),
        GetOverlappedSecurityZones() => (array:gamePersistentID),
        ...
}

DumpAllTypeNames()

Definition

DumpAllTypeNames() -> nil

Usage example

DumpAllTypeNames()

> Dumped 26811 types

[operator ()] [4416] handle:gamedataUICharacterCreationAttribute_Record
[operator ()] [4416] DamageTypeIndicator
[operator ()] [4416] worldAIDirectorSpawnNode
[operator ()] [4416] UI_DEV_ScriptableSystemUseNewTooltips
[operator ()] [4416] array:SDocumentThumbnailWidgetPackage
[operator ()] [4416] gameIPersistencySystem
[operator ()] [4416] DelayedComDeviceClose
[operator ()] [4416] inkSettingsSelectorController
[operator ()] [4416] array:handle:AICombatSquadScriptInterface
[operator ()] [4416] animAnimNode_LocomotionAdjusterOnEvent
[operator ()] [4416] whandle:gamedataLightPreset_Record
[operator ()] [4416] handle:C4ControllerPS
...

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.

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.

⚠️ 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}.

local adjustRequest = AdjustTransformWithDurations.new();

-- Setting any duration to 0 or lower means "do not change"
-- Slide = change player position
-- Rotation = change player rotation / trajectory / viewing angles

adjustRequest:SetSlideDuration(-1.0); -- Disabling position adjustion
adjustRequest:SetRotationDuration(1); -- Rotation show be smooth and should happen in 1 second (presumably, second!)
adjustRequest:SetUseParabolicMotion(true); -- Do not just interpolate movement/rotation, use parabolic formula
adjustRequest:SetCurve(CName.new("None")); -- Setting curve to "None", no other curves were found in the sources
adjustRequest:SetRotation(ToEulerAngles {0, 0, 0}:ToQuat()); -- Setting target player's rotation

stateContext:SetTemporaryScriptableParameter("adjustTransform", adjustRequest, true);

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.

local adjustRequest = AdjustTransformWithDurations.new();
   
adjustRequest:SetSlideDuration(-1.0); -- Disabling position adjustion
adjustRequest:SetRotationDuration(1.0); -- Rotation show be smooth and should happen in ~1 second (presumably, seconds!)
adjustRequest:SetUseParabolicMotion(true); -- Do not just interpolate movement/rotation, use parabolic formula
adjustRequest:SetCurve(CName.new("None")); -- Setting curve to "None", no other curves were found in the sources
-- In this case aimAt is a GameObject
adjustRequest:SetTarget(aimAt); -- Setting target player's rotation

stateContext:SetTemporaryScriptableParameter("adjustTransform", adjustRequest, true);

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

Moving player

local adjustRequest = AdjustTransformWithDurations.new();
        
adjustRequest:SetSlideDuration(1.0); -- Setting duration of position change.
adjustRequest:SetRotationDuration(-1.0); -- Disabling rotation adjustion
adjustRequest:SetUseParabolicMotion(true); -- Do not just interpolate movement/rotation, use parabolic formula
adjustRequest:SetCurve(CName.new("None")); -- Setting curve to "None", no other curves were found in the sources

-- Getting player's position
local playerPosition = Game.GetPlayer():GetWorldPosition();
-- Adding 10 on the vertical axis
playerPosition.z = playerPosition.z + 10;

adjustRequest:SetPosition(playerPosition);

stateContext:SetTemporaryScriptableParameter("adjustTransform", adjustRequest, true);

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.

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