> For the complete documentation index, see [llms.txt](https://solaartw.gitbook.io/developer/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://solaartw.gitbook.io/developer/documentation/utilities/cyberpunk-engine-tweaks/guides/installing.md).

# Installing

## ​📋Installation <a href="#installation" id="installation"></a>

{% hint style="warning" %}
Before installing, make sure you're running the game in Windowed Borderless. The console will not work properly in fullscreen mode and can cause the game to freeze or not function.
{% endhint %}

1. 1.**Download** the latest [cet\_x\_xx\_x.zip](https://github.com/yamashi/PerformanceOverhaulCyberpunk/releases/latest) file. (Do not download the source code)
2. 2.**Unzip** to anywhere on your desktop. After unzipping the file, you will see a bin folder.
3. 3.**Drag** the bin folder to your Cyberpunk install directory. Example:`C:\Program Files (x86)\Steam\steamapps\common\Cyberpunk 2077`
4. 4.If installed properly, the Cyber Engine Tweaks files (plugins folder, LICENSE, global.ini, version.dll) will be in the x64 folder of your install directory.
5. 5.Ensure all apps that add overlays to the game (Rivatuner, Fraps, Afterburner, Discord, Steam, Gog, Windows 10 Game Bar, Geforce Experience, et cetera) are disabled as the console may not open with overlays active.
6. 6.Launch the game!
7. 7.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. Now it will open with that key from now on.
8. 8.**(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`
9. 9.**(Optional)** `When installing through nexus, make sure to use hardlink deployment.`

## 🗃️ Configuration <a href="#configuration-1" id="configuration-1"></a>

### **TweakDB Editor**

In the TweakDB Editor entries such as weapons, effects, consumables, etc. use a hash: `<TDBID:EAB61494:1D>.` This can be cumbersome to read and remember. Loading the dictionary will allow for displaying more human-friendly definitions such as `gamedataStatusEffect_Record` of type `BaseStatusEffect.BreathingLow`.

1. 1.**Download** [tweakdb.str.zip](https://discord.com/channels/717692382849663036/1016766213755523213/1030967050593652736) from Discord and [usedhashes.kark](https://github.com/WolvenKit/WolvenKit/blob/main/WolvenKit.Common/Resources/usedhashes.kark) from GitHub
2. 2.**Unzip** [tweakdb.str.zip](https://discord.com/channels/717692382849663036/1016766213755523213/1030967050593652736) anywhere on your desktop
3. 3.**Move** both files to the CET folder within the game installation e.g. `Cyberpunk 2077/bin/x64/plugins/cyber_engine_tweaks`
4. 4.Launch the game!
5. 5.Open Cyber Engine Tweaks overlay (using the key you bound before, see **Installation** above)
6. 6.Navigate to **TweakDB Editor** then to the **Advanced** tab, and follow the instructions.

## ​📺Video Guide <a href="#video-guide" id="video-guide"></a>

{% embed url="<https://www.youtube.com/watch?v=g_yt1uPR-lc>" %}

### 🆘Troubleshooting <a href="#troubleshooting" id="troubleshooting"></a>

If you run into problems with installation, **please check the troubleshooting page before asking in Discord:**

{% embed url="<https://wiki.redmodding.org/cyber-engine-tweaks/getting-started/installing/troubleshooting>" %}

## ❔How do I \_\_\_\_\_? <a href="#how-do-i-_____" id="how-do-i-_____"></a>

For a list of console commands for beginners, check out the **"How do I \_\_\_\_?"** page:

{% embed url="<https://wiki.redmodding.org/cyber-engine-tweaks/console/how-do-i>" %}

### ​⚙ Configuration <a href="#configuration" id="configuration"></a>

If the installation was successful and you can see the log files, the next step is to **configure** the mod:

{% embed url="<https://wiki.redmodding.org/cyber-engine-tweaks/getting-started/configuration>" %}

### ​🐧Linux (Proton) Instructions <a href="#linux-proton-instructions" id="linux-proton-instructions"></a>

Alternative installation instructions for **Linux** (Proton) can be found here:

{% embed url="<https://wiki.redmodding.org/cyber-engine-tweaks/getting-started/installing/untitled>" %}

### ​📘Learn More <a href="#learn-more" id="learn-more"></a>

For a more comprehensive list of commands and global functions, check the following pages:

{% embed url="<https://wiki.redmodding.org/cyber-engine-tweaks/functions/player>" %}

{% embed url="<https://wiki.redmodding.org/cyber-engine-tweaks/functions/global>" %}

{% embed url="<https://wiki.redmodding.org/cyber-engine-tweaks/functions/systems>" %}