🔒 Prerequisites

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

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

🎮 Launch the Game

• (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?

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.

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.

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

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

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

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.

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

• 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

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.

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.

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

Introduction

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

Available Functions

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");

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.

Usage Example

registerForEvent('onUpdate', function(deltaTime)

    print('It has been ' .. deltaTime .. ' ms since the last call')
    
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.

Usage Example

registerForEvent('onInit', function()

    print('Game is loaded')
    
end)

Install CET Mods?

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

Create my own mod?

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)

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.

What it contains

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

Write the file

Watch the file

CET Console Logs

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

What it contains

Write the file

Watch the file

Introduction

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

General Notes

Available Functions

Usage Example

Advanced Example

Documentation

Known problems (and solutions)

Accessing references

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

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.

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.

Summary

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

Wait, this is not what I want!

What is the TweakDB editor?

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:

Reflexes

Strength

Cool

Intelligence

TechnicalAbility

ColdBlood

Hacking

Stealth

Gunslinger

Kenjutsu

Assault

Crafting

Engineering

Hacking

CombatHacking

Athletics

Demolition

Brawling

StreetCred

Level

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)

Usage Example

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

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

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

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

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:

Unresolved type

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

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.

Summary

Where to get cron

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:

The callback is defined once.

Bad example:

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:

Cron functions

Delay

Execute the callback after X seconds

Timer

Executes a function every X seconds.

Pausing and resuming a timer

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

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)

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.

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

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.

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

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

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

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:

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:

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:

Helpers

Global functions

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

Summary

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.

Creating mods

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

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:

Change font

Locate this line under the "font" curly brace:

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:

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

How to display non-English 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:

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

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

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

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

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:

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

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.

Use a proxy

Lets create a proxy:

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:

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

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:

Usage Examples

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.

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

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.

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

Moving player

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

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

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.

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

Basic Window

ImGui.SetNextWindowPos(100, 500, ImGuiCond.FirstUseEver) -- set window position x, y
ImGui.SetNextWindowSize(300, 600, ImGuiCond.Appearing) -- set window size w, h

if ImGui.Begin("Unique Window Name") then
    ImGui.Text("Hello World")
    -- more window contents here
end
ImGui.End()

Modal/Popup Window

if ImGui.Button("Pop Button", 120, 0) then
      ImGui.OpenPopup("Delete?")
end

if ImGui.BeginPopupModal("Delete?", true, ImGuiWindowFlags.AlwaysAutoResize) then
    ImGui.Text("This is a popup")
    
    if ImGui.Button("Close") then ImGui.CloseCurrentPopup() end
    ImGui.EndPopup()
end

Combo Box with Selectables

local DropdownOptions = {"1", "2", "3", "4", "5"}
local DropdownSelected = "1"

if ImGui.BeginCombo("##My Combo Box", DropdownSelected) then -- Remove the ## if you'd like for the title to display above combo box

    for _, option in ipairs(DropdownOptions) do

        if ImGui.Selectable(option, (option == DropdownSelected)) then
            DropdownSelected = option
            ImGui.SetItemDefaultFocus()
        end

    end

    ImGui.EndCombo()
end

Checkbox

MyMod.myValue = ImGui.Checkbox("Check me", MyMod.myValue)

Button

if ImGui.Button("Click Me!", 100, 20) then -- Label, width, height - Use -1 as width for button to span available horizontal space
    -- do stuff here when button is clicked
end

local pressed

registerForEvent("onUpdate", function()
    if pressed then
        print("You pressed me!")
    end
end)

registerForEvent("onDraw", function()
    pressed = ImGui.Button("Click me I'm a Sexy Button", 250, 25)
end)

Tooltip

Default tooltip on a button.

local pressed = ImGui.Button("button text")
if ImGui.IsItemHovered() then
  ImGui.SetTooltip("tooltip text")
else
  ImGui.SetTooltip(nil)
end

To customize the tooltip window use BeginTooltip and EndTooltip.

local pressed = ImGui.Button("button text")
if ImGui.IsItemHovered() then
  ImGui.BeginTooltip()
  ImGui.PushTextWrapPos(50)
  ImGui.TextWrapped("tooltip text")
  ImGui.EndTooltip()
else
  ImGui.SetTooltip(nil)
end

Multi-column layout

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

ImGui.BeginChild("Column 1", 300, 400) -- this will not display a label
    ImGui.Text('Column 1')
ImGui.EndChild()

ImGui.BeginChild("Column 2", 300, 400) -- this will not display a label
    ImGui.Text('Column 2')
ImGui.EndChild()

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

First Launch

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

For the most common commands, see below.

Items

Use Game.AddToInventory

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

Use Game.SetLevel

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

Attributes

Formerly Game.SetAttribute

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

Perk and Skill Points

Formerly Game.GiveDevPoints

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)

File Exists

Definition

Usage example

Source code

Get Files Recursively

Definition

Usage example