modwright 0.1.0

package/knowledge/cyberpunk2077/quests.scenes.yaml

@@ -0,0 +1,282 @@
+game: cyberpunk2077
+topic: quests.scenes
+title: .questphase/.scene structure and WolvenKit's quest/scene editing limits
+facts:
+  - id: cp2077.quests.scenes.questphase-vs-scene-roles
+    claim: "\"Missions or quests are organized into separate files that contain nodes or references to
+      other 'files' called Questphases and Scenes. Questphases can be thought of as graphs that may
+      contain a few #noderefs, which are used to load prefabs for the phase. The questphases are
+      connected together using handlerefs, which handle IDs in their socket setups.\""
+    status: community
+    source: wiki.redmodding.org "Visualize Quest files", opening paragraphs
+    tags:
+      - quest
+      - questphase
+      - scene
+      - noderef
+      - handleref
+      - file-type
+    detail: "The page's illustration of the split is the apartments: \"they consist of a questphase
+      side, which forms the core of the entire game, and a scene file side, which includes choices,
+      animations, buffs obtained from sleeping, timeskips resulting from sleeping, or audio in the
+      shower\". Trimmed on 2026-09-07: that list is the apartment example, not a general statement
+      of everything a `.scene` owns. Page title corrected (the page is \"Visualize Quest files\",
+      and it has no \"File Types\" heading)."
+  - id: cp2077.quests.scenes.wolvenkit-view-is-resource-plus-graph-only
+    claim: Opening a `.questphase` in WolvenKit shows "first a 'resource' window with all the questphase
+      dependencies/archives and info"; the node graph is on a separate Graph editor tab you switch
+      to.
+    status: community
+    source: wiki.redmodding.org "Visualize Quest files", section "To visualize Questphase in Wolvenkit
+      we need to:"
+    tags:
+      - quest
+      - questphase
+      - wolvenkit
+      - editor-limitation
+    detail: 'Corrected 2026-09-07: the previous claim that there is "no dedicated higher-level quest
+      logic view beyond those two tabs" is an inference the page does not make. The page links a
+      community list of questphase files (DoctorPresto/Cyberpunk-File-Types, questphase.txt) for
+      finding one to open, and its own worked example is
+      `/dlc\dlc6_apart\loc_dlc6_apart_hey_gle\quest\phases\dlc6_apart_hey_gle.questphase`.'
+  - id: cp2077.quests.scenes.subtitle-edit-needs-two-resources
+    claim: "Finding a spoken line's text spans two resources: in the `.scene`, walk `struct Data >
+      scnSceneResource > scnscreenplayStore > scnscreenplayDialogLine` and read its `locstringIds`;
+      then open the matching localization `.json` under
+      `lang_en_text\\base\\localization\\en-us\\subtitles\\quest\\` and walk `struct Data >
+      JsonResource > handle:iSerializable > localizationPersistenceSubtitleEntry >
+      array:localizationPersistenceSubtitleEntry`, whose `stringId` values are the same numbers."
+    status: community
+    source: wiki.redmodding.org "How to Edit Voiceover and Subtitles In a Quest.", numbered steps 2-7
+    tags:
+      - quest
+      - scene
+      - dialogue
+      - subtitle
+      - locstringid
+      - localization
+    detail: "Worked example: `mq041_corpo_01_deadmans_switch.scene` against
+      `mq041_corpo_01_deadmans_switch.json`, where stringId 1822802647440039936 is \"Hey, yeah,
+      sure. Damn, you ol' bastard, been a while since...\" The archive is named `lang_eng_text` in
+      prose while the extracted path is `lang_en_text`. The same String ID mechanism is described
+      from the audio side in cp2077.audio.events.voiceover-subtitles-mapped-by-string-id. Section
+      name corrected 2026-09-07 (there is no \"Key Steps\" heading; the page is a numbered list)."
+  - id: cp2077.quests.scenes.subtitle-locstringids-must-swap-in-pairs
+    claim: 'Reassigning a line is a two-part swap INSIDE the `.scene`: first swap the two `locstringIds`
+      in the dialogue-line array, then "swap the names we see on the left; in this case
+      `m_194BE559A84E2000` with `m_1A04A1D80244D000`" by replacing their entries in the `CName`
+      array. The localization JSON is only read to learn which stringId carries which line.'
+    status: community
+    source: wiki.redmodding.org "How to Edit Voiceover and Subtitles In a Quest.", numbered steps 8-11
+    tags:
+      - quest
+      - scene
+      - subtitle
+      - locstringid
+      - cname
+      - gotcha
+    detail: 'Corrected 2026-09-07: the previous claim had the pair straddling the `.scene` and the
+      localization JSON, and asserted an audio/subtitle desync as the failure mode; neither is what
+      the page describes. The `m_<hex>` CName is the hex form of the same stringId. The edit
+      finishes with "save, pack" and putting the archive in the Mod folder.'
+  - id: cp2077.quests.scenes.scene-editing-tooling-is-not-wolvenkit
+    claim: "Both raw `.scene` editing guides list the same toolchain and none of it is WolvenKit: CP77
+      Tools (github.com/WolvenKit/CP77Tools) to unbundle and uncook the archives, 010 Editor, and
+      alphaZomega's `CP77_CR2W.bt` binary template to read and write the structs."
+    status: community
+    source: wiki.redmodding.org "How to Edit Voiceover and Subtitles In a Quest.", section
+      "Requirements:"; same list in "How to Remove an Animation (and Potentially Replace It)",
+      section "Requirements:"
+    tags:
+      - quest
+      - scene
+      - 010editor
+      - cp77tools
+      - tooling
+    detail: The animation guide spells the template `CP77_CR2.bt` while the subtitle guide spells it
+      `CP77_CR2W.bt`; both link the same CP77_CR2W_v0.46.zip download. Both also ask for "Some basic
+      knowledge of what are you doing".
+  - id: cp2077.quests.scenes.remove-animation-five-hop-chain
+    claim: "Removing a scene animation traces a chain: find the `sectionNode` playing it, then `Struct
+      Data > scnSceneResource > scnSceneEvent array > scnPlaySkAnimEvent >
+      scnEventBlendWorkspotSetup` and note its `workspotId`; find the `scnWorkspotInstance` whose
+      `workspotInstanceId` matches and note its `dataId`; find the `scnWorkspotData` with that
+      `dataId` and note the path after `workspotResource`; open that `.workspot` at `Struct Data >
+      workWorkspotResource > workWorkspotTree > handle:worldEntry > workSequence > worklEntry`, find
+      the `work[...]Anim` matching the animation, note the number before the name, and zero out that
+      name in the CNAME array."
+    status: community
+    source: wiki.redmodding.org "How to Remove an Animation (and Potentially Replace It)", section "The
+      Steps:" (steps 2-8)
+    tags:
+      - quest
+      - scene
+      - animation
+      - workspot
+      - scnplayskanimevent
+    detail: "Worked example: removing the mirror idle, with the scene at
+      `base\\quest\\minor_quests\\mq000\\scenes\\mq000_01_apartment.scene` and the workspot at
+      `base\\worksposts\\quest\\main_quests\\prologue\\q001\\q001_01_wakeup\\q001_01_wakeup__look_m\
+      irror.workspot` (the page's own spelling of the folder). Section names corrected 2026-09-07
+      (there are no \"Key Node/Event Types\" or \"Essential Steps\" headings)."
+  - id: cp2077.quests.scenes.workspots-underpin-most-ai-interaction
+    claim: "\"Most of the game relies on Workspots used as interactable points both by the AI and the
+      Player\" — a workspot edited for one scene's animation may be shared, e.g. the mirror workspot
+      above \"is used for the various interactions in V's appartment\"."
+    status: community
+    source: wiki.redmodding.org "How to Remove an Animation (and Potentially Replace It)", section "The
+      Steps:" (the SIDE NOTE after step 3)
+    tags:
+      - quest
+      - scene
+      - workspot
+      - shared-resource
+      - gotcha
+    detail: Section name corrected 2026-09-07 (there is no "Critical Gotchas" heading; this is a side
+      note in the numbered steps).
+  - id: cp2077.quests.scenes.community-area-node-alwaysloaded-requirement
+    claim: '"There are two types `worldCompiledCommunityAreaNode` and
+      `worldCompiledCommunityAreaNode_Streamable`. The difference between them is only that
+      `worldCompiledCommunityAreaNode` must be registered in `AlwaysLoaded` type of
+      `.streamingsector` [and] `worldCompiledCommunityAreaNode_Streamable` can be registered in
+      other types of `.streamingsector` (exterior/quest/etc)."'
+    status: community
+    source: wiki.redmodding.org "How to use worldCommunityRegistry and worldCompiledCommunity", section
+      "Basics"
+    tags:
+      - quest
+      - community-registry
+      - worldcompiledcommunityareanode
+      - streaming-sector
+    detail: Page title and section name corrected 2026-09-07. The page's own warning is that it
+      "explains the theory"; for actually creating communities it redirects to the Object Spawner
+      "creating communities" guide.
+  - id: cp2077.quests.scenes.community-registry-sourceobjectid-must-match
+    claim: On a `worldCompiledCommunityAreaNode`, "`Node/area/entriesData` we specify an
+      `entryName/phaseName/spotId(AiSpoNodeHash)` so in the future, we can
+      `Activate/Reactivate/Deactivate` its entities by these params" and "`sourceObjectId` - it
+      should match `id` of registry item".
+    status: community
+    source: wiki.redmodding.org "How to use worldCommunityRegistry and worldCompiledCommunity", section
+      "Theory" (step 4, "Important")
+    tags:
+      - quest
+      - community-registry
+      - sourceobjectid
+      - gotcha
+    detail: "On the `worldCommunityRegistryNode` side, \"`communitiesData` - there we are specifying the
+      type of NPC its template, entryName, and all possible phases\" and \"`workspotsPersistentData`
+      - there we are adding a new spot into the engine's global registry by the hash of our
+      `AiSpotNode`\". Corrected 2026-09-07: the previous claim placed the matching `id` in
+      `communitiesData` specifically and asserted a failure mode (\"the spawn registration fails to
+      resolve\"); the page says neither."
+  - id: cp2077.quests.scenes.community-registry-version-floor
+    claim: The worldCommunityRegistry/worldCompiledCommunity guide's one listed requirement is ArchiveXL
+      1.17.0+.
+    status: community
+    source: wiki.redmodding.org "How to use worldCommunityRegistry and worldCompiledCommunity", section
+      "Requirements"
+    tags:
+      - quest
+      - community-registry
+      - archivexl
+      - version-floor
+    detail: An ArchiveXL version on its own numbering, so it stays in the claim with no `verified_on`.
+      Section name corrected 2026-09-07 (it is under "Requirements", not "Important Gotchas").
+  - id: cp2077.quests.scenes.archivexl-quest-phase-merge
+    claim: "ArchiveXL merges a mod's .questphase into a loaded quest graph from the manifest key `quest:
+      phases:`, a list of entries with `path` (the mod phase) and `parent` (a .questphase or .quest,
+      scope names allowed), plus optional `connection` / `input` (a node-id path and optional
+      socket; empty means the parent's start node), `output` and `intercept`. It adds a
+      questPhaseNodeDefinition whose id is a CRC-16 of \"<path>:<input node id>\" and connects the
+      input node's Out to its In1. When the parent is a .quest resource, the merged phase node is
+      also force-started on game restore (once, recorded by a fact keyed on the node) and marked
+      started on quest start, so a phase merged into the main quest runs on every load without any
+      trigger of its own."
+    status: verified
+    source: https://github.com/psiberx/cp2077-archive-xl src/App/Extensions/QuestPhase/Config.cpp
+      (LoadYAML, FillConnection) and Extension.cpp (PatchPhase, CreatePhaseNode, OnGameRestored,
+      OnQuestStart); bundle/source/resources/QuestBaseScope.xl (the cyberpunk2077.quest scope)
+    tags:
+      - archivexl
+      - questphase
+      - quest
+      - merge
+      - mod-quest
+    detail: >-
+      Installed quest mods (Kidnap, Aldecaldos High Stakes, Lizzie's BDs) each list their launcher
+      phase twice, with parents base\quest\cyberpunk2077.quest and ep1\quest\ep1_standalone.quest,
+      and again for the NG+ quests; a cyberware mod (v0.12) follows the first two. The input node's
+      phase is started with the socket "In1", so the mod phase's questInputNodeDefinition carries
+      socketName In1.
+
+      Seen in game on 2026-09-22. After a save loaded, ArchiveXL logged `[QuestPhase] Patching phase
+      "base\quest\cyberpunk2077.quest"...` and `Merged phase "mod\<mod>\body\<mod>_body.questphase"
+      from "<Mod>.archive.xl"`. The phase's fact-driven loops then ran with no trigger of their own:
+      community Activate on the fact 1, Deactivate on 0, and again. At the main menu the log has
+      only the config pass; the merge lines come with the save.
+  - id: cp2077.quests.scenes.noderef-hash-is-fnv-of-the-path-without-hash-marks
+    claim: A full world NodeRef path ("$/03_night_city/.../#prefab/#name") hashes to the 64-bit FNV-1a
+      of the path string with every '#' removed; the community registry's gameCommunityID, the
+      compiled community area's sourceObjectId, an AI spot's worldGlobalNodeID and the
+      AISpotPersistentData globalNodeId are all that hash. Quests and scripts name the same node by
+      its short alias ("#name"), which the engine resolves through the sector's nodeRefs list, not
+      by hashing the alias itself.
+    status: verified
+    verified_on: "2.31"
+    source: base\worlds\03_night_city\_compiled\default\always_loaded_1.streamingsector
+      (ep1_1_nightcity.archive) nodeRefs entries for
+    tags:
+      - noderef
+      - hash
+      - community-registry
+      - ai-spot
+      - streaming-sector
+    detail: >-
+      FNV-1a 64 of the bare alias ("mq060_communityArea") does not give the id, so the alias form is
+      resolved, not hashed. The alias resolution through the nodeRefs list is inferred from vanilla
+      (the spot's full path is listed in the always-loaded sector although the spot node lives
+      elsewhere) and from Kidnap, whose quest names "#sq_kidnap_community" while its sector lists
+      only the full path.
+
+      Checked in game on 2026-09-22. Codeware's NodeRefToHash(CreateNodeRef(path)) on
+      "$/03_night_city/#<mod>/#<mod>_body_community" returned the generator's value. The same call
+      on the alias "#<mod>_body_community" returned the FNV-1a 64 of the bare
+      "<mod>_body_community", not the node's id. Even so, the mod phase's
+      questCommunityTemplate_NodeType, given that alias, activated the community. The quest system
+      resolves an alias; script CreateNodeRef only hashes it.
+    related:
+      - cp2077.quests.scenes.community-registry-sourceobjectid-must-match
+  - id: cp2077.quests.scenes.vanilla-quest-community-shape
+    claim: "A quest-activated community in vanilla is three nodes in an AlwaysLoaded sector: a
+      worldCommunityRegistryNode item (communityAreaType Regular, communityId = the area's path
+      hash, entriesInitialState entryActiveOnStart 0 with the initial phase, and the template inline
+      as communityCommunityTemplateData: a communitySpawnEntry with characterRecordId, entryName,
+      and a communitySpawnPhase with alwaysSpawned, appearances, phaseName and
+      communityPhaseTimePeriod entries of hour, quantity and spotNodeRefs), a
+      worldCompiledCommunityAreaNode whose sourceObjectId is the same id and whose entriesData maps
+      entry, phase and period to the spots' worldGlobalNodeIDs, with MaxStreamingDistance FLT_MAX in
+      its node data; and the spots' AISpotPersistentData (hash, world position as FixedPoint bits of
+      metres x 131072, yaw) in the registry's workspotsPersistentData. A quest activates it with
+      questSpawnManagerNodeDefinition -> questCommunityTemplate_NodeType (action Activate /
+      Deactivate, spawnerReference the area's alias, communityEntryName, communityEntryPhaseName)."
+    status: verified
+    verified_on: "2.31"
+    source: base\worlds\03_night_city\_compiled\default\always_loaded_1.streamingsector
+      (ep1_1_nightcity.archive) nodes 2277 (mq060 area) and 3256 (the registry);
+      base\quest\minor_quests\mq060\phases\mq060_yaiba_showroom.questphase nodes 174 and 206
+    tags:
+      - community-registry
+      - worldcompiledcommunityareanode
+      - ai-spot
+      - questphase
+      - streaming-sector
+    detail: "A working mod lays it out the same way (Kidnap's kidnap_always_loaded sector: registry,
+      compiled area node and nine AI spots together, level 0, AlwaysLoaded descriptor), and
+      entSpawner's exporter writes the registry into a separate AlwaysLoaded sector with the area
+      node in the group's sector. Spot workspots are resources the NPC plays at the spot; Kidnap
+      places a vehicle entry on a spot carrying a bar-stool workspot, so the spot is read as a
+      position for entities that cannot use it (inferred)."
+    related:
+      - cp2077.quests.scenes.community-area-node-alwaysloaded-requirement
+      - cp2077.quests.scenes.community-registry-sourceobjectid-must-match

package/knowledge/cyberpunk2077/quickhacks.tiers.yaml

@@ -0,0 +1,41 @@
+game: cyberpunk2077
+topic: quickhacks.tiers
+title: How a vanilla quickhack's tiers are built in TweakDB
+facts:
+  - id: cp2077.quickhacks.tiers.program-chain-per-quality
+    claim: "A vanilla quickhack's tiers are separate program items in a $base chain, one per quality,
+      each with its own hack action. Blind is the worked example: Items.BlindProgram
+      (Quality.Common, Tier0Shard, QuickHack.BlindHack) <- Items.BlindLvl1Program (Uncommon,
+      Tier1Shard, BlindLvl1Hack) <- Items.BlindLvl2Program (Rare, Tier2Shard, BlindLvl2Hack) <-
+      Items.BlindLvl3Program (Epic, Tier3Shard, BlindLvl3Hack) <- Items.BlindLvl4Program (Legendary,
+      Tier4Shard, BlindLvl4Hack). Items.BlindLvl4PlusPlusProgram is an iconic Legendary (Tier6Shard)
+      that reuses the Lvl4 actions. Each tier lists its action with Boss… and Chimera… variants in
+      objectActions, and has its own OnAttach and OnEquip packages and a CraftingData package. The
+      Lvl2 action costs QuickHack.MemoryIncreaseTier4."
+    status: verified
+    verified_on: "2.31"
+    source: .modwright-cache/cyberpunk2077/vanilla.sqlite (Items.Blind*Program, QuickHack.Blind*Hack)
+    tags:
+      - quickhack
+      - tier
+      - quality
+      - program
+      - tweakdb
+  - id: cp2077.quickhacks.tiers.one-program-per-shardtype
+    claim: "The cyberdeck takes one program per shardType: slotting compares the new program's shardType
+      with each slotted one's (itemModificationSystem.script:125). A mod quickhack whose program
+      $bases a vanilla program inherits its shardType (Items.BlindProgram: \"Blind\") and cannot
+      share the deck with that vanilla quickhack; it needs its own shardType."
+    status: verified
+    verified_on: "2.31"
+    source: 'tools\redmod\scripts\cyberpunk\systems\itemModificationSystem.script:125, :136, :316; the
+      vanilla index: Items.BlindProgram shardType "Blind", Items.DisableCyberwareProgram shardType
+      "DisableCyberware"'
+    tags:
+      - quickhack
+      - program
+      - cyberdeck
+      - shardtype
+      - slot
+    related:
+      - cp2077.quickhacks.tiers.program-chain-per-quality