Created & Published: October 19 2023 by Game Version 2.01

This tutorial will show you how to use REDmod to edit an NPC's TweakDB record, changing their info when scanning them with your Kiroshis. In this tutorial we will edit Panam

If you want to learn more about the Tweak database, check TweakDB: Game database.

Prerequisites

• the free REDMod DLC (you can get it here)

• An IDE to edit .json files. I prefer Visual Studio Code, but you can also use Notepad++

Preparation

Since we are using REDmod, we need to structure our project accordingly.

1. Open your Cyberpunk 2077 game directory in the Windows Explorer.

2. Find the folder mods. If it doesn't exist, create it.

3. Inside mods, create a folder for your custom mod — call it however you want. For this tutorial, we will name ours "example mod"

4. Inside your mod folder, create an empty text file with the name of info.json. This file will tell Cyberpunk how to load your mod.

5. Copy the following template and paste it into your empty file:

{
  "name": "YOURMODNAME",
  "version": "1.0",
  "customSounds": []
}

1. Inside your mod folder, create the following nested folders: tweaks\base\gameplay\static_data\database\characters\npcs\records\quest\main_characters

2. Copy the following file to the folder main_characters inside your mod directory: Cyberpunk 2077\tools\redmod\tweaks\base\gameplay\static_data\database\characters\npcs\records\quest\main_characters\primarycharacters.tweak

Your mod folder should now look like this:

- example mod
    info.json
  - tweaks
    - base
      - gameplay
        - static_data
          - database
            - characters
              - npcs
                - records
                  - quest
                    - main_characters
                        primarycharacters.tweak

Editing the .tweak file

Open primarycharacters.tweak in your IDE and search for "Panam". You will find the following record:

Panam : aldecaldos_grunt2_sniper2_sor22_wa_elite
{
	priority = "SpawnableObjectPriority.Quest";
	tags += 
	[
		"Invulnerable"
	];
	entityTemplatePath = "base\quest\primary_characters\panam.ent";
	reactionPreset = "ReactionPresets.NoReaction";
	isBumpable = false;
	displayName = "LocKey#34412";
	fullDisplayName = "LocKey#34413";
	CName voiceTag = "panam";
	baseAttitudeGroup = "panam";
	archetypeData = "ArchetypeData.SniperT2";
	sensePreset = "Senses.panam_sniper_relaxed";
	relaxedSensesPreset = "panam_sniper_relaxed";
	alertedSensesPreset = "panam_sniper_alerted";
	combatSensesPreset = "panam_sniper_combat";
	skipDisplayArchetype = true;
	fk< StatModifier >[] statModifiers = 
	[
		{
			statType = "BaseStats.BurningImmunity";
			modifierType = "Additive";
			value = 1;
		} : ConstantStatModifier
	];
	primaryEquipment = 
	{
		equipmentItems = 
		[
			{
				item = "Items.Preset_Grad_Panam";
				equipSlot = "AttachmentSlots.WeaponRight";
				onBodySlot = "AttachmentSlots.ItemSlotGenericRanged";
				equipCondition = 
				[
					"WeaponConditions.SniperPrimaryWeaponSniperEquipCondition"
				];
				unequipCondition = 
				[
					"WeaponConditions.SniperPrimaryWeaponSniperUnequipCondition"
				];
			} : NPCEquipmentItem, 
			{
				item = "Items.Preset_Base_Copperhead";
				equipSlot = "AttachmentSlots.WeaponRight";
				onBodySlot = "AttachmentSlots.ItemSlotGenericRanged";
				equipCondition = 
				[
					"WeaponConditions.SniperPrimaryWeaponRangedEquipCondition"
				];
				unequipCondition = 
				[
					"WeaponConditions.SniperPrimaryWeaponRangedUnequipCondition"
				];
			} : NPCEquipmentItem
		];
	};
	statModifierGroups += 
	[
		"NPCStatPreset.VeryHighHealth", "NPCStatPreset.PanamSniperDamage", "NPCStatPreset.FollowerDamageAgainstBosses"
	];
	savable = true;
	bountyDrawTable = 
	{
		bountyChoices = 
		[
			{
				bountySetter = "Factions.NCPD";
				transgressions = 
				[
					{
						localizedDescription = "LocKey#48952";
					}
				];
				reward = "BountyReward.bounty_panam";
			}
		];
	};
}

Properties

We will take a look at some of the properties.

Changing an NPC's faction

All existing factions are defined in the following file:

Cyberpunk 2077\tools\redmod\tweaks\base\gameplay\static_data\database\factions\factions.tweak

To change an NPC's affiliation, you will need to add the following line to their template:

fk< Affiliation > affiliation = "Factions.FACTION_NAME_HERE"

Results

That's, save your work, deploy your mod and hop in the game to see the results.

If you have any questions, you're welcome to join us on discord.

Summary

Published: ??? by Last documented update: Jan 28 2024 by

How to do this:

Your mod will be one or multiple .yaml files under r6/tweaks. If you want to release your mod on Nexus, we recommend using and creating the files under the folder.

Adding items to vendors

Courtesy of Neurolinked and psiberx. For more context, .

Create the following tweak file (a yaml in r6/tweaks/your_optional_subfolder:

Summary

Created: Aug 01 2024 by Last documented edit: Aug 01 2024 by

This guide will teach you how to create your own blueprint by extending a base game record. At the end, you will have an assault rifle with muzzle, scope, and four mod slots.

Requirements:

A text editor like

What is a Blueprint?

A Blueprint is a record of type gamedataItemBlueprint_Record with the following flat:

rootElement is a record of type gamedataItemBlueprintElement_Record. It has the following flats (properties):

slot is a record of type gamedataAttachmentSlot_Record.

They have the following properties:

childElements is an array of records of type gamedataItemBlueprintElement_Record

prereqID is a record of type gamedataStatPrereq_Record

A blueprint can have 1 rootElement and each of the gamedataItemBlueprintElement_Record can have multiple other gamedataItemBlueprintElement_Record as children

How to make a custom Blueprint?

We are going to make a custom blueprint that has 4 weapon mod slots for the Power Assault Rifles

At first make a new .yaml file and name it Items.Base_Power_AR_SMG_LMG_4Mod_Blueprint (the naming is not important and you can name it whatever you want).

Inside the yaml file, put the following content:

Now we need to define Items.Base_Power_AR_SMG_LMG_4Mod_Blueprint_rootElement we are going to use Items.Base_Power_AR_SMG_LMG_Blueprint_inline0 as a base for our rootElement and append two records for our 2 new Mod slots

The 2 new Weapon Mod Element records should be of type gamedataItemBlueprintElement_Record

Here we have to create 2 new prereqIDs

Adding attachment slots

And we will need to create our custom AttachmentSlots

We are going to create 2 attachmentSlots named

• AttachmentSlots.Power_AR_SMG_LMG_WeaponMod3

• AttachmentSlots.Power_AR_SMG_LMG_WeaponMod4

Now that all the necessary records are defined, we are going to add this Blueprint to the Weapon record

Items.Base_Power_Assault_Rifle as its name suggest is the base for power assault rifles so by doing this all the power assault rifles should now have this blueprint

The tweak part of making the blueprint is now over and we can jump in the game and check the records

We are going to use Preset_Ajax_Pimp as you can see the modSlots are not being shown in the game

For this, we are going to need to do some scripting lets create a new .reds file in the script folder and name it AR_SMG_LMG_4Slot.reds

We need to wrap multiple functions to make this work, so at first we are going to add a function that has our AttachmentSlots in it

And another function that checks for these slots

Now we wrap these 3 functions and add our slots to their return value

If we check the game now we can see that our slots are added but they are not shown correctly

We need to fix the slot Icons the tooltip names and the slot name

For the icons we wrap these 2 methods you can also use custom icon paths

For the tooltip names we are going to wrap this method

And for slot name

Now the UI is almost complete now we have to register these 2 slots to all the mods that can be equipped on the other 2

And now its done all of our power assault rifles now have 4 mod slots

Summary

Last documented edit: Feb 09 2024 by

Changing item stats happens by making changes via TweakXL or REDmod in the .

Guides about this:

How to edit tweaks?

You can change tweaks with

• REDMod (see )

• Cyber Engine Tweaks (see Scissor's tutorial ())

• TweakXL (see )

Removing properties

If you want to safely delete a record property, set its value to None.

For this tutorial, you need:

• (or , but the tutorial will show you VSCode)

• A bookmark for (you can check your YAML files for indentation errors)

• Patience, lots of patience. Please, read this guide completely and re-read if needed.

After downloading and installing all the requirements (and yes, SAVE that bookmark, trust me), let's start with the basics.

Understanding YAML Tweaks

YAML tweaks are like a decompiled version of the .tweaks files that you can find inside the REDmod folder. YAML format is easier to read and understand, but have some differences with REDmod syntax. You can also try and make tweaks using the , but personally I have no experience with that yet.

There are some concepts you need to understand before starting:

Indentation

Indentation organizes code using blank spaces, as shown below:

In the past, using indentation wasn't mandatory and mostly used by pro coders to order their files as a good practice. However, for YAML files, indentation is MANDATORY. If you indent wrong, your mod won't work, simple as.

The best way to indent, in my opinion, is using 2 blank spaces (pressing space bar twice) to make indentations.

"But what about just using tab?" you may think. DON'T. DON'T USE TAB FOR INDENTATION. Using tab for indentation could cause issues, because not all text editors interpret tab in the same way.

Using double space will guarantee your file will keep the same structure everywhere. It even feels natural and VSCode will put nice and useful lines to show your indentation.

Records

Flats

Inlines

This is where most new modders make mistakes.

Inline is a way to create records without nesting them under a record name, but coded and nested directly in the property of another record. Yeah, I know, it's hard to understand. Let's do some examples.

• This example is a named record with other named records nested on it:

• This is the same as above but with inline coding:

When to use inlines or whole named records? That depends on your project. Sometimes creating a record with a UNIQUE name will save you more space and work than creating it on inlines every single time. Sometimes it's the other way around. It's ok to even not using inlines at all if you aren't comfortable with them.

Later in this tutorial, you'll see that some records are named to something like this RecordName_inline0, RecordName_inline1, etc. Those inlineX names are created automatically for easier reading and the number can change without ANY warning on every single game update. The number generated will be dependent on the position of the inline record inside another record. Inline means literally "this is IN LINE X".

Let me explain it better with more examples:

• In this example, this a record using inlines in update 2.1

• In this example, is the same record, but on update 2.2

In this example, MyBigRecord_inline0 will have a completely different value depending on the update.

In update 2.1 the value1 and related to BaseStats.ExampleBaseStat1, but then in update 2.2 the value will be 8 and related to BaseStats.ExampleBaseStat3.

If you used MyBigRecord_inline0 in your item code, your item would stop working as intended. It doesn't matter that popular modders do this, DON'T USE INLINES AS BASE FOR YOUR RECORDS.

Prereqs

Effector

TweakDB

Tweaks and Scripts are 2 sides of the same coin.

On its own, a tweak does nothing — the engine makes use of the records via scripts.

How to make a research for your YAML Tweak mod

Having clarified some very basic concepts, let's start this guide:

1: Find the thing you want to do

Let's say you want to do a new item that have the Thrusters mechanics from Rogue Boots that you use in certain endings.

What's the best approach to this? Using those Thrusters boots logic in your item.

Internally, that item is called q115_thrusters. Now that we know that, we can search the item in Wolvenkit Tweak Broswer.

2: Using Wolvenkit Tweak Browser

Open the Tweak Browser tab and pin it. It should look like this:

Paste q115_thrusters into the search bar and click on Filter... and activate Show inline records. This should look like this:

Do a right click into the first item and select Add TweakXL Override. Do the same for the inline0 and inline1, but ignore the rogue and weyland versions, we don't need that, just the first 3 results shown in this image:

Those tweaks should be stored in the left panel inside these folders in the image:

Put the cursor above the YAML files and click on the yellow folder to open the folder containing those tweaks in Windows Explorer:

3: Working with the YAML files

Open the 3 YAML files in VSCode:

Now, from the latest inline (inline1 in this example), copy the whole contents and paste it below the anterior record (in this case, inline0):

Now, copy the mixed contents and paste them into the base record (the item on this case). This is how it should look:

Those records below the main item record (inline0 and inline1) are the ones that manages the Thrusters logic/mechanics.

You can add them to almost any item, but you'll have to research on your own how to do it on each case. Not all items needs the effects nested in the same places, and not all effects needs to be nested like this.

Now, the importance of VSCode in this tutorial. VSCode has an incredibly powerful and useful highlighting system for text by just doing double click on ANY WORD. With this system, you'll understand how things are nested on ANY item you find. Look at this example:

If you pay attention to the miniature code on the right side and the scroll bar, there is a highlight that will point you exactly where things are nested:

If you move over that highlight, you will finally have your answer.

Final thoughts

This tutorial logic can be applied to ANYTHING that can be found in TweaksDB, how many inline records you are going to find will depend on each particular case. I picked a simple example to not extend this too much, but some items have more than 30 inlines... You are warned.

I've tested this method with many users, and all of them have been able to create their mods. This is not a way to do all items you have in mind, because is extremely inefficient, but once you understand how things are nested and how records are structured, you'll have a better time creating items afterwards.

I hope this will be helpful for you.

Thank you for reading, and good luck in your projects!

What is TweakXL?

For a detailed guide with many explanations of properties, check the second half of

TweakXL ( | ) is a mod by psiberx. It lets you alter Cyberpunk's , changing properties of NPCs and items or even adding new entries.

How do I use it?

By placing .yaml or .tweak files in Cyberpunk 2077/r6/tweaks, or .xl files in Cyberpunk 2077/archive/pc/mod.

Where are the guides?

Theory

• Explanation of the database:

• Additional information: TweakXL

Praxis

Summary

Created: Aug 01 2024 by Last documented edit: Aug 01 2024 by

This guide will teach you how to create your own attachment slots to use them e.g. in a blueprint.