Cyber Engine Tweaks Documentation

To enable plugin loading via an ASI loader, follow these steps:

1. Download Ultimate-ASI-Loader_x64.zip from the ASI Loader releases.
2. Place dinput8.dll into <cyberpunk install path>\bin\x64\.
3. Rename dinput8.dll to version.dll.
4. Create a global.ini file in <cyberpunk install path>\bin\x64\.
5. Add the following configuration to global.ini:

[GlobalSets]
LoadPlugins=1
LoadFromScriptsOnly=1
DontLoadFromDllMain=0
FindModule=0
UseD3D8to9=0
DisableCrashDumps=0
Direct3D8DisableMaximizedWindowedModeShim=0

To use the ImGui bindings within Cyber Engine Tweaks, you must initialize the bindings by calling sol_ImGui::InitBindings with your sol::state object. This enables the ImGui global object in Lua.

  // Call this function!
  sol_ImGui::InitBindings(lua); // lua being your sol::state

When writing code for this project, adhere to these generalities:

• Self-Explanatory Names: Avoid single-letter names. Use descriptive names like incomingPacketCount instead of a.
• Use of auto: You may use auto for long, complex names, but do not use it for primitive types to avoid implicit signed/unsigned conversion issues.
• Brace Style: Do not use Java-style blocks. The opening brace { must be placed on a new line.

To use this lightweight JSON library, drop the json.lua file into your project directory and require it in your Lua scripts.

It is implemented in pure Lua and is compatible with Lua 5.1, 5.2, 5.3, and LuaJIT.

json = require "json"

To install the built plugin, you must first configure the specific plugin directory within your Cyberpunk installation path (do not use the base directory), then run the install command.

Target path format: <cyberpunk install path>\bin\x64\plugins

xmake f --installpath=<cyberpunk install path>\bin\x64\plugins
xmake install

If you prefer using Visual Studio instead of the xmake CLI, you can generate VS project files by running the following command. This will create a vsxmake folder containing the .sln file.

xmake project -k vsxmake

To build the plugin, ensure you have the following requirements installed:

• Visual Studio 2019 (or VS2022 with MSVC 14.34+)
• xmake
• git

Follow these steps:

1. Open a command prompt and navigate to the repository.
2. Check out the desired branch or tag.
3. Initialize dependencies: git submodule update --init.
4. Build the project: xmake -y (use xmake -y -v for verbose output).

To use Cyber Engine Tweaks, you must first install RED4ext.

For detailed installation instructions, including specific guidance for using CET with Proton, refer to the official wiki:

• General Wiki Guide
• Proton Installation Guide

When developing for Cyber Engine Tweaks, use C++20 features supported by vs2019.

To maintain performance and binary size, follow these guidelines:

• Use templates responsibly to avoid excessive compilation times and binary bloat.
• Adhere to the Single Responsibility Principle (SRP) by creating small, reusable components instead of large, monolithic classes.
• Avoid using exceptions. Do not use STL code that can throw; instead, use nothrow versions or unsafe versions where available.

LuaSQLite3 provides two modules for manipulating SQLite3 databases directly from Lua 5. Choose based on how you want to link the SQLite3 library:

• lsqlite3: Links SQLite3 dynamically. You must have the SQLite3 library installed on your system (available from http://www.sqlite.org/).
• lsqlite3complete: Links SQLite3 statically. This version includes the SQLite3 amalgamation source code, so no external SQLite3 library is required.