HomeDiscordGitHub
Edit

Creating Cyberware using TweakXL

Note: this list is not exhaustive and should be expanded as needed:

  • Needs additional information about Arms Item Records

  • Needs information about Sandevistan & Berserk OS Item Records

Item Record Attributes

There many attributes in the primary item record that are universal (or near universal) across multiple cyberware types. With few exceptions, these entries can be drawn from a base record and reused across multiple items.

$type: gamedataItem_Record
animFeatureName: ItemData
animName: ui_garment_pose
animSetResource: ''
blueprint: Items.GenericShardableCyberwareBlueprint
canDrop: True
crosshair: Crosshairs.None
deprecated: False
enableNpcRPGData: False
friendlyName: ''
garmentOffset: 0
icon: UIIcon.ItemIcon
isCached: False
isCoreCW: True
isCustomizable: False
isGarment: False
isPart: False
isSingleInstance: False
itemCategory: ItemCategory.Cyberware
itemType: ItemType.Cyberware
localizedName: ''
mass: 1 
minigameInstance: minigame_v2.DefaultItemMinigame
powerLevelDeterminedByParent: False
qualityRestrictedByParent: False
replicateWhenNotActive: False
useHeadgearGarmentAggregator: False
useNewSpawnMethod: False
usesVariants: True
savable: False
buyPrice:
  - Price.BaseCyberwarePrice
  - Price.ItemQualityMultiplier
  - Price.PlusTierMultiplier
  - Price.CyberwareMultiplier
  - Price.BuyPrice_StreetCred_Discount
cameraForward: {x: 0, y: 0, z: 0}
cameraUp: {x: 0, y: 0, z: 0}
gameplayRestrictions:
  - GameplayRestriction.VehicleCombatNoInterruptions
sellPrice:
  - Price.BaseCyberwarePrice
  - Price.ItemQualityMultiplier
  - Price.PlusTierMultiplier
  - Price.CyberwareMultiplier
  - Price.CyberwareSellMultiplier
slotPartListPreset:
  - Items.GenericItemRootPreset
statModifiers:
  - Items.ItemArmorToArmor
tags:
  - Cyberware
  - HideInBackpackUI

Notes:

  • icon: The base value is sufficient if you want to use an existing UI element. Otherwise, use an appropriate icon entry for your mod.

Item-Specific Entries

These attributes are the core elements of defining your cyberware item. With the exception of the array entries above, these values will always change from item-to-item or slot-to-slot.

buyPrice:
  - Items.YourCustomBuyRecord
cyberwareType: MemoryBoost
displayName: YourItemNameFromArchiveXL
equipArea: EquipmentArea.FrontalCortexCW
iconPath: cw_frontalcortex_memoryboost
localizedDescription: LocKey#YourItemDescFromArchiveXL
nextUpgradeItem: Items.YourCustomCuberwarePlus
OnEquip: []
quality: Quality.Uncommon
sellPrice:
  - !append Items.YourCustomSellRecord
slotPartListPreset:
  - !append Items.YourStatShardRecord
statModifiers:
  - !append Quality.IconicItem
upgradeCostMult: 2
variants: 
  - Variants.Humanity8Cost

Notes:

  • buyPrice: This array should include a record to determine the humanity-to-cost ratio when buying from a vendor

  • cyberwareType: Each cyberware type is given a unique value. Two items with the same value cannot be equipped, meaning iconic variants of cyberware (such as Axolotl) cannot be equipped alongside their base variant (Newton Module). All Kiroshi cyberware share the same value, which is accommodated in Cyberware-EX by assigning new values to each vanilla implant.

  • displayName: If you are providing a custom item name using ArchiveXL, only the secondaryKey is required. Do not include the LocKey prefix.

  • equipArea: denotes the slot that will accept your cyberware item.

  • localizedDescription: No longer used by default, but the mod Flavorful Descriptions will add this text to the bottom of all cyberware as it was before the 2.0 update. This does require the LocKey prefix before the secondaryKey

  • OnEquip: This array includes all the records that define your cyberware's functionality, including Attunement if any

  • sellPrice: This array should include a record to determine the humanity-to-cost ratio when selling from a vendor (can use the same record as buyPrice if you wish)

  • slotPartListPreset: This array should include your StatShard, which is used to determine bonus stats for cyberware.

  • statModifiers: This array typically includes 3 items:

    1. A slot-specific record such as Items.AdvancedCardiovascularSystemModule_inline0

    2. A record to calculate the current Attunement level for the Attunement UI

    3. If the cyberware is iconic, Quality.IconicItem

  • upgradeCostMult: A multiplier applied to the required crafting components when upgrading.

  • variants: A single array entry is used to determine the humanity cost.

Addendum #1: Item-Specific Entries for Cyberdecks

blueprint: Items.CyberdeckBlueprint8Slots
buyPrice:
  - !append Items.YourCustomCyberdeckBuyRecord
cyberwareType: Cyberdeck
displayName: YourItemNameFromArchiveXL
equipArea: EquipmentArea.SystemReplacementCW
iconPath: cw_system_ravencyberdeck 
localizedDescription:
nextUpgradeItem: Items.YourCustomCuberwarePlus
objectActions:
  - DeviceAction.DataExtractionClassHack
  - DeviceAction.MalfunctionClassHack
  - DeviceAction.ToggleStateClassHack
  - DeviceAction.TurretToggleStateClassHack
  - DeviceAction.TakeControlCameraClassHack
  - DeviceAction.VehicleForceBrakesClassHack
  - DeviceAction.OverloadClassHack
OnEquip:
  - Items.YourCyberdeckGameplayLogicRecords
quality: Quality.Common
sellPrice:
  - !append Items.YourCustomCyberdeckSellRecord
slotPartList:
  - Items.GenericRootSlotItem
slotPartListPreset: 
  - !remove Items.GenericItemRootPreset
statModifiers: 
  - !remove Items.ItemArmorToArmor
  - !append Quality.IconicItem
tags:
  - !append Cyberdeck
upgradeCostMult: 2.5
variants:
  - Variants.Humanity8Cost

Notes:

  • blueprint: This determines the number of quickhack slots available in your deck (2 through 8)

  • buyPrice: This record typically uses a higher ratio as operating systems tend to be more expensive.

  • cyberwareType: All cyberdecks share the same cyberwareType.

  • localizedDescription: Not currently used by Flavorful Descriptions for cyberdecks. If you want favor text in your cyberdeck UI, it will need to be a UI entry in the OnEquip array.

  • objectActions: This array defines the device and vehicle hacks available at each tier (see below).

  • sellPrice: This record typically uses a higher ratio as operating systems tend to be more expensive.

  • slotPartListPreset: Not used in cyberdecks.

  • statModifiers: This is not used for cyberdecks, apart from identifying if the deck is iconic.

  • upgradeCostMult: A higher multiplier is usually applied to cyberdecks.

Code Sample: Adding Device & Vehicle hacks to your Cyberdeck tiers

Items.YourCustomDeck$(quality):
  $instances:
    - { quality: Common }
    - { quality: CommonPlus }
    - { quality: Uncommon }
    - { quality: UncommonPlus }
    - { quality: Rare }
    - { quality: RarePlus }
    - { quality: Epic }
    - { quality: EpicPlus }
    - { quality: Legendary }
    - { quality: LegendaryPlus }
    - { quality: LegendaryPlusPlus }
  objectActions:
    - !append-once DeviceAction.DataExtractionClassHack
    - !append-once DeviceAction.MalfunctionClassHack
    - !append-once DeviceAction.ToggleStateClassHack
    - !append-once DeviceAction.TurretToggleStateClassHack
    - !append-once DeviceAction.TakeControlCameraClassHack
    - !append-once DeviceAction.VehicleForceBrakesClassHack
    - !append-once DeviceAction.OverloadClassHack

Items.YourCustomDeck$(quality):
  $instances:
    - { quality: Uncommon }
    - { quality: UncommonPlus }
    - { quality: Rare }
    - { quality: RarePlus }
    - { quality: Epic }
    - { quality: EpicPlus }
    - { quality: Legendary }
    - { quality: LegendaryPlus }
    - { quality: LegendaryPlusPlus }
  objectActions:
    - !append DeviceAction.TakeControlClassHack
    - !append DeviceAction.TurretOverloadClassHack
    - !append DeviceAction.OverrideAttitudeClassHack
    - !append DeviceAction.HighPitchNoiseQuickHack
    - !append DeviceAction.TurretToggleStateClassLvl2Hack
    - !append DeviceAction.VehicleAccelerateClassHack

Items.YourCustomDeck$(quality):
  $instances:
    - { quality: Rare }
    - { quality: RarePlus }
    - { quality: Epic }
    - { quality: EpicPlus }
    - { quality: Legendary }
    - { quality: LegendaryPlus }
    - { quality: LegendaryPlusPlus }
  objectActions:
    - !append DeviceAction.TakeControlVehicleClassHack
    - !append DeviceAction.SetDeviceTagKillMode
    - !append DeviceAction.OverrideAttitudeClassLvl3Hack
    - !append DeviceAction.TurretToggleStateClassLvl3Hack

Items.YourCustomDeck$(quality):
  $instances:
    - { quality: Epic }
    - { quality: EpicPlus }
    - { quality: Legendary }
    - { quality: LegendaryPlus }
    - { quality: LegendaryPlusPlus }
  objectActions:
    - !append DeviceAction.VehicleExplodeClassHack
    - !append DeviceAction.OverloadClassLvl4Hack
    - !append DeviceAction.TurretOverrideAttitudeClassHack
    - !append DeviceAction.OverrideAttitudeClassLvl4Hack
    - !append DeviceAction.TurretToggleStateClassLvl4Hack
    - !append DeviceAction.ServerOverloadClassHack

Attunements

Applying attunements to your non-OS cyberware requires 3 elements:

  1. A record to provide a UI icon (not required for vanilla Attunements)

  2. A record to provide a bonus to the player

  3. A record to calculate the current value provided by the attunement for the UI

Code Sample: Adding Vanilla Attuments to your cyberware

Items.YourCustomCyberware:
  OnEquip:
    - !append Attunements.IntelligenceAllDamage
  statModifiers:
    - !append
      $type: gamedataCombinedStatModifier_Record
      opSymbol: '*'
      refObject: Player
      refStat: BaseStats.Intelligence
      value: 0.0500000007 # used in the UI, not applied to any gameplay calc
      modifierType: Additive
      statType: BaseStats.AttunementHelper

Notes:

The value attribute in your statModifiers record is not used to apply a bonus to the player. It is used to generate a value for the UI record within Attunements.IntelligenceAllDamage to display.

In this case, the bonus within Attunements.IntelligenceAllDamage is to multiply all damage by Intelligence*0.0005 but the UI needs to display percentages, not decimal modifiers. This value is referenced in the Attunement record's UI data as the AttunementHelper.

Code Sample: Adding Custom Attuments to your cyberware

Below is an example of using the player's Max RAM to generate a bonus to Armor taken from an existing mod.

UIIcon.SampleCyberware_RAMArmorIcon:
  $type: gamedataUIIcon_Record
  atlasPartName: perks_ram
  atlasResourcePath: base\gameplay\gui\widgets\healthbar\atlas_buffinfo.inkatlas

Attunements.SampleCyberware_RAMArmor:
  $type: gamedataGameplayLogicPackage_Record
  stackable: True
  UIData:
    iconPath: UIIcon.SampleCyberware_RAMArmorIcon
    localizedDescription: LocKey#YourAttunementDescFromArchiveXL
    localizedName: Cyberdeck RAM Attuned
    floatValues:
      - 5 # The static value for the UI
    stats:
      - BaseStats.AttunementHelper # References the calculated total for the UI
  stats:
    - $type: gamedataCombinedStatModifier_Record
      opSymbol: '*'
      refObject: Self
      refStat: BaseStats.Memory
      value: 5 # The value used to calculate the bonus to Armor from RAM
      modifierType: Additive
      statType: BaseStats.Armor
      
Items.SampleCyberwareCommon:
  OnEquip:
    - !append Attunements.SampleCyberware_RAMArmor
  statModifiers:
    - !append
      $type: gamedataCombinedStatModifier_Record
      opSymbol: '*'
      refObject: Player
      refStat: BaseStats.Memory
      value: 5 # This value is used to generate the calculated total for the UI
      modifierType: Additive
      statType: BaseStats.AttunementHelper

Technology Perk Requirements

There are a few ways in which the functionality of Cyberware is impacted by Technology Perks. In order for newly-created Cyberware to react to these situations appropriately, some considerations needs to be be made in your design.

All Things Cyber

Level 2 of this perk reduces the Cyberware Capacity cost for cyberware in the Integumentary System and Skeleton slots by 20%. In the variant attribute, cyberware inteded for these slots should use:

Variants.Humanity[num]CostTinkererVariant # where [num] is the numeric cost

If you choose to create your own Tinkerer variant, remember that the 20% discount is not a calculated value; you are free to set whatever Cyberware Capacity cost you choose for players who buy this perk.

License To Chrome

Level 3 of this perk increases the stats of all Skeleton cyberware. This is achieved by creating a duplicate of your cyberware item that will be swapped into the player's cyberware slot seamlessly if they've purchased this perk.

In your base cyberware records, include:

sideUpgradeItem: [The name of your license to chrome record]

Note: in vanilla items, these copies are identifiable by the 2 in their names, i.e. Items.AdvancedBionicJointsCommon2

In your license to chrome record, include:

tags:
  - SkipActivityLog

Armor Bonuses

Static bonuses to Armor are calculated by 4 records, all of which evaluate the item's tier and apply the bonus accordingly.

  1. A standard record used by all cyberware for a particular slot. All 4 vanilla records are identical with the exception of the name, so there is no practical limit on applying an armor bonus to any cyberware regardless of its type. The existing records are:

    • Items.AdvancedCardiovascularSystemModule_inline0

    • Items.AdvancedIntegumentarySystemModule_inline0

    • Items.AdvancedMusculoskeletalSystemModule_inline0

    • Items.AdvancedNervousSystemModule_inline0

  2. A record to establish the base (Common) bonus applied

  3. A record to establish the bonus applied at each full tier (Common, Uncommon, etc)

  4. A record to establish the bonus applied at each half-tier (CommonPlus, UncommonPlus, etc)

Code Sample: Adding Armor Bonus calculations to your cyberware

Items.AdvancedMusculoskeletalSystemModule_inline0: # standard record
  $type: gamedataCombinedStatModifier_Record
  opSymbol: '*'
  refObject: Self
  refStat: BaseStats.Armor
  value: 1
  modifierType: Additive
  statType: BaseStats.Protection
  
Items.SampleArmorBase:
  $type: gamedataConstantStatModifier_Record
  value: 18 # starting value for Common
  modifierType: Additive
  statType: BaseStats.Armor

Items.SampleArmorIncrease:
  $type: gamedataCombinedStatModifier_Record
  opSymbol: '*'
  refObject: Self
  refStat: BaseStats.Quality
  value: 9 # added at every new tier (uncommon, rare, etc)
  modifierType: Additive
  statType: BaseStats.Armor

Items.SampleArmorIncreasePlus:
  $type: gamedataCombinedStatModifier_Record
  opSymbol: '*'
  refObject: Self
  refStat: BaseStats.IsItemPlus
  value: 4 # added for LegenaryPlus and PlusPlus
  modifierType: Additive
  statType: BaseStats.Armor

Items.SampleCyberwareCommon:
  statModifiers:
    - !append Items.AdvancedMusculoskeletalSystemModule_inline0
    - !append Items.SampleArmorBase
    - !append Items.SampleArmorIncrease
    - !append Items.SampleArmorIncreasePlus

Notes:

The code sample above will result in the following values:

  1. Common: 18 (base)

  2. CommonPlus: 22 (base + plus)

  3. Uncommon: 27 (base + increase * tiers added)

  4. UncommonPlus: 31 (base + plus + increase * tiers added)

  5. Rare: 36 (base + increase * tiers added)

  6. RarePlus: 40 (base + plus + increase * tiers added)

  7. Epic: 45 (base + increase * tiers added)

  8. EpicPlus: 49 (base + plus + increase * tiers added)

  9. Legendary: 54 (base + increase * tiers added)

  10. LegendaryPlus: 58 (base + plus + increase * tiers added)

  11. LegendaryPlusPlus: 62 (base + plus * 2 + increase * tiers added)

The armor bonus is always calculated starting from Common even if your custom cyberware only has records for higher tiers; if your base cyberware item start at Epic, the armor bonus will still be 45.

Stats Shards

Any piece of cyberware that will receive random bonus stats requires a StatsShard record to do so. Much of the StatsShard record is ignored, so a simple base record can be used for virtually any piece of cyberware.

Much if the information in the sample is the same, generally dealing with randomizing stat bonuses during upgrades. Key to your custom cyberware are the last 5 records in statModifiers as they control the initial stats when aquiring the cyberware item.

Typically, these stats include 3 direct bonuses and 2 modifying bonuses. Keep in mind that including more direct bonuses means that your cyberware will be found with extra stats, but they will be lost when upgrading.

Code Sample: Adding a StatShard record to your cyberware

Items.SampleCyberwareStatShard:
  $base: Items.AnyStatShardRecordYouWant
  statModifierGroups:
    - ModifierGroups.CyberwareModifierBoosts # Always the same
    - ModifierGroups.TransferCyberwareModifiersToItem # Always the same
  statModifiers: 
    - Items.CyberwareStatsShardStatic_inline0 # Always the same
    - Items.CyberwareStatsShardStatic_inline1 # Always the same
    - Items.CyberwareStatsShardStatic_inline2 # Always the same
    - Items.CyberwareStatsShardStatic_inline3 # Always the same
    - Modifiers.BonusQuickHackDamage # direct bonus 1
    - Modifiers.RamOnKill # direct bonus 2
    - Modifiers.RamOnKillQualityToggle # modifying bonus 1
    - Modifiers.DamageOverTimePercentBonus # direct bonus 3
    - Modifiers.DamageOverTimePercentBonusToggle # modifying bonus 2
    
Items.SampleCyberwareCommon:
  $type: gamedataSlotItemPartPreset_Record
  itemPartPreset: Items.AflotasIntegrationStatsShard
  slot: AttachmentSlots.StatsShardSlot

Arms Cyberware Specifics

Cyberware for the Arms slot have their Cyberware Capacity cost calculated for the holstered and unholstered states in separate locations. If you intend to use a cost other than the base 8, you will need to take them both into account.

The unholstered value, which is also used for the UI, is calculated here:

variants:
  - Variants.Humanity8Cost # the default record for all Arms cyberware

If you only change this value, you'll find that the UI indicates a new Cyberware Capacity cost, but equipping the item will only reduce the user's Cyberware Capacity by 8. If order to modify the cost when holstered, you'll need to make a change here:

Items.NanoWireHolsteredFists
  statModifiers:
    - Items.NanoWireHolsteredFists_inline1 #this record holds the value

This record is referenced in your Arms cyberware here:

holsteredItem: Items.NanoWireHolsteredFists
PreviousTweak modding: GuidesNextGetting started: Making mods

Last updated