modwright 0.1.0

package/knowledge/baldursgate3/audio.voice.yaml

@@ -0,0 +1,182 @@
+game: baldursgate3
+topic: audio.voice
+title: Voice-line filename conventions, replacement workflow, and Wwise limits
+facts:
+  - id: bg3.audio.voice.wwise-free-tier-200-asset-cap
+    claim: '"The Free Trial version of Wwise allows you to create a project for non-commercial use only
+      and is limited to 200 media assets in the Wwise SoundBanks" — a hard ceiling on how many lines
+      one voice-replacement or new-voice-line mod can carry without a paid Wwise licence.'
+    status: community
+    source: wiki.bg3.community/en/Information/Sound/Summary
+    tags:
+      - audio
+      - wwise
+      - asset-cap
+      - licensing
+  - id: bg3.audio.voice.no-way-to-add-new-soundbanks-or-events
+    claim: 'There is no way to add new soundbanks or new audio events to BG3 — "The only option is to
+      replace existing sound files (.wem format) so that an event plays your replaced track in place
+      of the original." Both pages date-stamp the claim (Summary: "as of May 6, 2024";
+      Replace-Sound: "as of May 11th 2024").'
+    status: community
+    source: wiki.bg3.community/en/Tutorials/Sound/Replace-Sound;
+      wiki.bg3.community/en/Information/Sound/Summary
+    tags:
+      - audio
+      - wwise
+      - soundbank
+      - scope-limit
+    detail: "This is the authoring boundary around the verified read-side facts in audio.wwise.yaml
+      (bg3.audio.fnv-1-hash-resolution, bg3.audio.wem-extraction-and-decode): resolving an existing
+      event to its .wem and decoding it is solved there; minting a new event is not possible from
+      the mod side."
+  - id: bg3.audio.voice.audio-events-not-editable-as-data
+    claim: Wwise-authored audio events can be viewed as data in .lsf(x) files, but their actual playback
+      instructions (which files, durations, triggers) come from Wwise itself and cannot be edited
+      through normal data editing — inspecting the event data doesn't let a modder change what it
+      plays.
+    status: community
+    source: wiki.bg3.community/en/Information/Sound/Summary
+    tags:
+      - audio
+      - wwise
+      - events
+      - scope-limit
+  - id: bg3.audio.voice.replacement-wem-must-match-format-exactly
+    claim: A replacement .wem must be converted through Wwise's conversion settings to match the
+      original file's channel count, sample rate, and format exactly (identified beforehand with
+      vgmstream-cli -m on the original .wem); a format mismatch is the documented cause of the
+      replacement producing no sound in game at all.
+    status: community
+    source: wiki.bg3.community/en/Tutorials/Sound/Replace-Sound §Getting Metadata, §Converting to .wem
+      with Wwise ("If you end up with no sound in game for the event, the format is probably wrong")
+    tags:
+      - audio
+      - wem
+      - format
+      - silent-failure
+  - id: bg3.audio.voice.replacement-clip-truncated-to-original-length
+    claim: A replacement sound plays only up to the original clip's duration — inserting audio longer
+      than the original file it replaces wastes the extra runtime, since playback is cut off at the
+      original's length, not extended to the new file's length.
+    status: community
+    source: wiki.bg3.community/en/Tutorials/Sound/Replace-Sound §Editing Your Audio ("If the original
+      clip is 18 seconds and you insert a 2 minute clip, it will only play the first 18 seconds")
+    tags:
+      - audio
+      - wem
+      - duration
+      - gotcha
+  - id: bg3.audio.voice.wwise-output-filename-must-match-source-1to1
+    claim: "Wwise's conversion output adds extra characters to the converted .wem's filename: \"Wwise
+      added some junk to your filename, make sure to rename it. It needs to match 1-to-1 with the
+      source .wem file.\""
+    status: community
+    source: wiki.bg3.community/en/Tutorials/Sound/Replace-Sound §Converting to .wem with Wwise
+    tags:
+      - audio
+      - wem
+      - filename
+  - id: bg3.audio.voice.non-voice-sounds-vs-voice-lines-different-paths
+    claim: Replaced non-voice sounds (music, sound effects) go under Public/Shared/Assets/Sound/ in the
+      mod's own workspace, while story voice lines (location and quest remarks, dialogue) and
+      repeated point-and-click reaction lines are placed under
+      Data/Mods/Gustav/Localization/English/Soundbanks/ instead — the two categories are not
+      interchangeable paths.
+    status: community
+    source: wiki.bg3.community/en/Tutorials/Sound/Replace-Sound §Placing Your File, §Voice Lines
+    tags:
+      - audio
+      - voice
+      - file-path
+  - id: bg3.audio.voice.character-voice-lines-are-four-plus-file-types
+    claim: "A character voice line is assembled from several files: \"A character voicebank .lsf file, A
+      .wem audio file, A .GR2 animation file for the character's gestures during the line, A
+      .ffxanim file for lipsyncing. And .ffxactor and .ffxbones files for the character to use those
+      lipsyncing files.\" They \"are referenced within the DialogBinary files via a text handle,
+      which is also used to call to the captions in the localization files.\""
+    status: community
+    source: wiki.bg3.community/en/Tutorials/new-voice-lines
+    tags:
+      - audio
+      - voice
+      - voicebank
+      - ffxanim
+      - structure
+  - id: bg3.audio.voice.voicebank-filename-is-character-uuid-no-hyphens
+    claim: A character's voicebank .lsf file is named after that character's Root/GlobalTemplate UUID
+      with all hyphens removed; the same (hyphenated) UUID also appears inside the file under
+      VoiceSpeakerMetaData, which is how you confirm you have the right voicebank for a character.
+    status: community
+    source: wiki.bg3.community/en/Tutorials/new-voice-lines
+    tags:
+      - audio
+      - voicebank
+      - uuid
+      - naming-convention
+  - id: bg3.audio.voice.wem-filename-convention
+    claim: A new voice line's audio filename follows the pattern v<character voicebank ID>_<text
+      handle>.wem — the voicebank ID is the character UUID with hyphens stripped, and the handle
+      keeps its leading "h" — and the same v<id>_<handle> stem is reused with an "MC_" prefix for
+      the mocap .GR2 and an "FX_" prefix for the lipsync .ffxanim.
+    status: community
+    source: wiki.bg3.community/en/Tutorials/new-voice-lines
+    tags:
+      - audio
+      - wem
+      - naming-convention
+      - ffxanim
+    detail: "Worked example: character UUID 1323c4b6-92f7-4fda-8bad-6a96b8ddbc73 (voicebank ID
+      1323c4b692f74fda8bad6a96b8ddbc73) and text handle h580e6615c3364b05843d7575309ad942e568 give
+      v1323c4b692f74fda8bad6a96b8ddbc73_h580e6615c3364b05843d7575309ad942e568.wem, with mocap
+      MC_v1323c4b692f74fda8bad6a96b8ddbc73_h580e6615c3364b05843d7575309ad942e568.GR2 and lipsync
+      FX_v1323c4b692f74fda8bad6a96b8ddbc73_h580e6615c3364b05843d7575309ad942e568.ffxanim."
+  - id: bg3.audio.voice.ffxactor-ffxbones-unique-per-character
+    claim: .ffxactor and .ffxbones lipsync files are unique per character and a lipsync .ffxanim can
+      only be used by the character whose matching .ffxactor/.ffxbones pair is present in that
+      character's Localization/English/Animation/FaceFXActors folder; a custom character with no
+      such files can borrow another character's pair by renaming a duplicated copy to the custom
+      character's own UUID.
+    status: community
+    source: wiki.bg3.community/en/Tutorials/new-voice-lines §A note about mocap and lipsync
+    tags:
+      - audio
+      - ffxactor
+      - ffxbones
+      - lipsync
+    detail: 'The pair must stay together: "Mixing and matching them will result in horrors beyond
+      imagination." Cloning is explicitly allowed — "you can clone them and use them for your own
+      characters, without affecting the original!"'
+  - id: bg3.audio.voice.dialog-priority-levels
+    claim: A VoiceTextMetaData entry's dialog priority level should be set to one of P1_StoryDialog
+      (cutscene/conversation dialog), P2_VoiceBark_AD (combat/overworld voicebarks),
+      P3_StoryDialog_AD (story-related overworld automatic dialog), or P4_RepeatingDialog_AD
+      (repeating/ambient overworld automatic dialog) matching the kind of line being added.
+    status: community
+    source: wiki.bg3.community/en/Tutorials/new-voice-lines
+    tags:
+      - audio
+      - voicetextmetadata
+      - priority
+      - enum
+  - id: bg3.audio.voice.mocap-gr2-not-required-to-match-bodytype
+    claim: Any character's mocap .GR2 animation can be reused as the gesture animation for a different
+      character's voice line — it does not have to match the target character's body type — as long
+      as the filename follows the required naming pattern for that line.
+    status: community
+    source: wiki.bg3.community/en/Tutorials/new-voice-lines §A note about mocap and lipsync
+    tags:
+      - audio
+      - gr2
+      - mocap
+      - reuse
+  - id: bg3.audio.voice.bg3-target-audio-level-around-minus-12db
+    claim: BG3's voice lines sit around -12 to -18db, noticeably quieter than the -6 to -9db typical of
+      other media's voice audio; a replacement/new voice line should be normalized to roughly -12db
+      and checked against an audio meter, not by ear, since speaker setups vary.
+    status: community
+    source: wiki.bg3.community/en/Tutorials/new-voice-lines
+    tags:
+      - audio
+      - volume
+      - normalization

package/knowledge/baldursgate3/audio.wwise.yaml

@@ -0,0 +1,104 @@
+game: baldursgate3
+topic: audio.wwise
+title: Wwise audio banks, sound event resolution, and FNV-1 hashing
+facts:
+  - id: bg3.audio.sound-numbering-unnamed
+    claim: "BG3 sounds are Wwise. Nothing is named on disk — SharedSounds.pak is 105,402 files called
+      Public/Shared/Assets/Sound/<numeric-id>.wem. The names only exist as FNV-1 hashes inside the
+      banks. Resolution chain: stats field → event name → hash → bank lookup → wem id → decode."
+    status: verified
+    verified_on: 4.73.98.727 (Patch 8)
+    source: ModWright field verification
+    tags:
+      - audio
+      - wwise
+      - sound
+      - fnv-1
+      - banks
+    detail: This is why there is no "find the sound file" UI — the lookup is table-driven via hashing.
+  - id: bg3.audio.event-names-from-stats
+    claim: "Get event names from the stats: CastSound / TargetSound / PrepareSound / SoundLoop /
+      SoundStop carry readable Wwise event names, e.g., Spell_Cast_Damage_Fireball_L5."
+    status: verified
+    verified_on: 4.73.98.727 (Patch 8)
+    source: ModWright field verification
+    tags:
+      - audio
+      - wwise
+      - events
+      - stats
+    detail: These are the entry points for sound lookup. Not every event is declared (e.g., Fireball
+      declares CastSound but not the detonation or charge-up).
+  - id: bg3.audio.wwise-bnk-extraction
+    claim: Wwise banks are in Data/SharedSoundBanks.pak (43 MB, 133 .bnk files). Extract with Divine.exe
+      -a extract-package. Spells are in SPELLS.bnk; status loops in STATUS.bnk.
+    status: verified
+    verified_on: 4.73.98.727 (Patch 8)
+    source: ModWright field verification
+    tags:
+      - audio
+      - wwise
+      - banks
+      - divine
+    detail: The .bnk files are binary; they need a hash walker to resolve event names to wem IDs.
+  - id: bg3.audio.fnv-1-hash-resolution
+    claim: "Resolve event name to wem id: hash the name (FNV-1 32-bit, LOWERCASED, multiply-then-xor),
+      find the Event in the HIRC, and walk Event → Action (only actionType 0x04xx = Play) →
+      container → CAkSound → source wem ids. Tool: tools/wwise_bnk.py <bank1;bank2> <EventName...>."
+    status: verified
+    verified_on: 4.73.98.727 (Patch 8)
+    source: ModWright field verification
+    tags:
+      - audio
+      - wwise
+      - fnv-1
+      - hash
+    detail: "The name must be LOWERCASED before hashing. Most events resolve to 4 wems (random-container
+      variants). Container child lists are found heuristically (NodeBaseParams is version-dependent
+      and variable-length): scan the payload for a u32 count followed by count u32s that are all
+      known object ids in the bank."
+  - id: bg3.audio.wem-extraction-and-decode
+    claim: 'Pull the wem from SharedSounds.pak: Divine.exe -a extract-single-file -s SharedSounds.pak -f
+      "Public/Shared/Assets/Sound/<id>.wem" -d out.wem (~0.2 s each). Decode: vgmstream-cli -o
+      out.wav in.wem. The wems are Wwise Vorbis (plugin=0x00040001, RIFF fmt size 0x42). ffmpeg
+      cannot decode them, and neither can Audacity without a plugin.'
+    status: verified
+    verified_on: 4.73.98.727 (Patch 8)
+    source: ModWright field verification
+    tags:
+      - audio
+      - wwise
+      - vorbis
+      - vgmstream
+      - decode
+    detail: ~0.2 s per extraction even against the 10.8 GB pak. The wem files are proprietary Wwise
+      Vorbis, not standard Vorbis.
+  - id: bg3.audio.event-guessing-convention
+    claim: Not every event is declared in stats. For undeclared events, guess from the convention
+      Spell_<Cast|Prepare|Impact|Loop|Status>_<VerbalIntent>_<SpellName>_<L#> and probe the hash.
+      The script prints NOT FOUND with the id if the guess misses.
+    status: verified
+    verified_on: 4.73.98.727 (Patch 8)
+    source: ModWright field verification
+    tags:
+      - audio
+      - wwise
+      - events
+      - conventions
+    detail: "Example: Fireball declares CastSound but not the detonation
+      (Spell_Impact_Damage_Fireball_L5) or charge-up (Spell_Prepare_Damage_Fireball_L5) — these
+      exist in the bank but appear in no txt. The convention is a guessing heuristic: an individual
+      guessed event name is unproven until the hash probe finds it."
+  - id: bg3.audio.divine-silent-failure
+    claim: Divine.exe writes nothing if a path is malformed and still exits 0 — silent no-op, no stderr.
+      Build Windows paths with cygpath -m and forward slashes. In bash, "$D\$var" collapses to a
+      literal $var with the backslash eaten.
+    status: verified
+    verified_on: 4.73.98.727 (Patch 8)
+    source: ModWright field verification
+    tags:
+      - audio
+      - divine
+      - paths
+      - windows
+    detail: This cost an hour in the audio session. No output, no error, just a missing file.

package/knowledge/baldursgate3/charactercreation.heads-hair.yaml

@@ -0,0 +1,193 @@
+game: baldursgate3
+topic: charactercreation.heads-hair
+title: Head/hair mesh import, CC slot registration, and the GLTF/Collada exporter split
+facts:
+  - id: bg3.character-creation.heads-hair.gr2-extension-must-be-uppercase
+    claim: A hair/head mesh's SourceFile path in the _merged.lsf.lsx VisualBank entry must point at a
+      file named with an uppercase ".GR2" extension — a mesh saved as ".gr2" (lowercase) will not
+      load, and the path separators must be "/" (Windows Explorer's copy-path default of "\" must be
+      corrected).
+    status: community
+    source: wiki.bg3.community/en/Tutorials/Visual/Creating-A-Hair-Mod/File-Setup
+    tags:
+      - character-creation
+      - hair
+      - gr2
+      - case-sensitivity
+      - silent-failure
+  - id: bg3.character-creation.heads-hair.needsskeletonremap-toggles-autosnap
+    claim: "The VisualBank Resource attribute NeedsSkeletonRemap is what tells the game whether a hair
+      is autosnapping or not: True = autosnapping (the mesh reshapes to fit different body types),
+      False = non-autosnapping (fixed to one body type, requiring a separate mesh per body type
+      supported)."
+    status: community
+    source: wiki.bg3.community/en/Tutorials/Visual/Creating-A-Hair-Mod/File-Setup
+    tags:
+      - character-creation
+      - hair
+      - autosnapping
+      - needsskeletonremap
+  - id: bg3.character-creation.heads-hair.ccav-vs-ccsv-compatibility-tradeoff
+    claim: CharacterCreationAppearanceVisuals.lsx (CCAV) and CharacterCreationSharedVisuals.lsx (CCSV)
+      both register a new CC slot entry. "CCSV is a lot easier to set up, file-wise. However, it is
+      incompatible with other mods that edit the same files. Unless you plan on using Compatibility
+      Framework, we recommend sticking with CCAV for both types of hair."
+    status: community
+    source: wiki.bg3.community/en/Tutorials/Visual/Creating-A-Hair-Mod/File-Setup
+    tags:
+      - character-creation
+      - ccav
+      - ccsv
+      - compatibility
+  - id: bg3.character-creation.heads-hair.ccav-ccsv-must-stay-lsx
+    claim: CharacterCreationAppearanceVisuals and CharacterCreationSharedVisuals files must stay in .lsx
+      format, not .lsf or .lsf.lsx — converting them to .lsf (as the multitool does by default for
+      that naming pattern) makes the game unable to read them.
+    status: community
+    source: wiki.bg3.community/en/Tutorials/Visual/Creating-A-Hair-Mod/File-Setup
+    tags:
+      - character-creation
+      - ccav
+      - ccsv
+      - lsx
+      - silent-failure
+  - id: bg3.character-creation.heads-hair.autosnapping-can-use-either-ccav-or-ccsv
+    claim: An autosnapping hair/CC asset can register its slot through either
+      CharacterCreationAppearanceVisuals or CharacterCreationSharedVisuals; a non-autosnapping asset
+      can only use CharacterCreationAppearanceVisuals.
+    status: community
+    source: wiki.bg3.community/en/Tutorials/Visual/Creating-A-Hair-Mod/File-Setup
+    tags:
+      - character-creation
+      - ccav
+      - ccsv
+      - autosnapping
+  - id: bg3.character-creation.heads-hair.ccav-uuid-must-match-merged-id
+    claim: A CharacterCreationAppearanceVisual node's VisualResource attribute must equal the ID
+      attribute set on the corresponding VisualBank Resource in the asset's own _merged.lsf.lsx
+      file, or the CC slot entry won't resolve to any mesh.
+    status: community
+    source: wiki.bg3.community/en/Tutorials/Visual/Creating-A-Hair-Mod/File-Setup
+    tags:
+      - character-creation
+      - ccav
+      - uuid-linkage
+      - visualresource
+  - id: bg3.character-creation.heads-hair.invisible-after-selection-means-path-mismatch
+    claim: A hair that appears as a selectable CC slot but is invisible once selected almost always
+      indicates a mismatch between the _merged file's SourceFile/Template path and the mesh's actual
+      location on disk; a slot missing entirely instead points to the CCAV/CCSV registration itself.
+    status: community
+    source: wiki.bg3.community/en/Tutorials/Visual/Creating-A-Hair-Mod/File-Setup
+    tags:
+      - character-creation
+      - hair
+      - troubleshooting
+      - silent-failure
+  - id: bg3.character-creation.heads-hair.scalpmaterialid-known-bug
+    claim: Some hairs in the vanilla game files ship without a ScalpMaterialId to copy — "(as of
+      24.11.23 some hairs in the game files don't have a scalp ID, larian is aware of this bug)" —
+      so a custom hair should reuse the base hair's ScalpMaterialId where one exists rather than
+      assume every vanilla hair has one.
+    status: community
+    source: wiki.bg3.community/en/Tutorials/Visual/Creating-A-Hair-Mod/File-Setup
+    tags:
+      - character-creation
+      - hair
+      - scalpmaterialid
+      - known-bug
+    detail: "Corrected from \"as of 24 November 2025\": the page's date stamp is 24.11.23, i.e. 24
+      November 2023."
+  - id: bg3.character-creation.heads-hair.hair-physics-needs-vanilla-skeletonresource
+    claim: Custom hair physics is only possible by borrowing a vanilla physics-enabled hair's
+      SkeletonResource UUID (set into the _merged.lsf.lsx SkeletonResource field) and weighting the
+      custom mesh to that armature — there is no way to author a new physics skeleton for hair.
+    status: community
+    source: wiki.bg3.community/en/Tutorials/Visual/Creating-A-Hair-Mod/Creating-Hair-Mesh-Blender
+    tags:
+      - character-creation
+      - hair
+      - physics
+      - skeletonresource
+  - id: bg3.character-creation.heads-hair.export-order-must-be-sequential
+    claim: "The exporter's per-mesh Export Order field must be set sequentially: \"For the first part of
+      your mesh set the export order to 1. Increase the export order number for every part you
+      have\" (with LOD Level and LOD Distance set to 0), because \"Blender will throw an error if
+      you don't have these in order.\""
+    status: community
+    source: wiki.bg3.community/en/Tutorials/Visual/Creating-A-Hair-Mod/Creating-Hair-Mesh-Blender
+    tags:
+      - character-creation
+      - export-order
+      - blender
+      - gr2
+  - id: bg3.character-creation.heads-hair.conform-required-for-multi-mesh-hair
+    claim: A hair mesh exported directly as .GR2 without conforming can look deformed or detached
+      in-game due to a skeleton mismatch; the fix is either using a hair's own "_Base" UUID as
+      SkeletonResource, or using LSLIB to conform an exported .dae to a vanilla .GR2 and copy its
+      skeleton — LSLIB's conform matches meshes by mesh DATA name (not the Blender object name), so
+      any mesh not sourced from that vanilla hair must have its mesh data name renamed to match one
+      already present in the vanilla file, or the conform export fails.
+    status: community
+    source: wiki.bg3.community/en/Tutorials/Visual/Creating-A-Hair-Mod/exporting-conforming
+    tags:
+      - character-creation
+      - hair
+      - gr2
+      - lslib
+      - conform
+  - id: bg3.character-creation.heads-hair.export-collada-requires-selected-only-and-dae-extension
+    claim: Exporting a hair mesh for LSLIB conforming must use File > Export > DOS2/BG3 Collada with the
+      extension explicitly changed to .dae and "Selected Only" chosen instead of "Visible Only,"
+      after applying all transforms (Ctrl+A > Apply > All Transforms) so the mesh doesn't fall
+      through the floor in-game due to leftover rotation.
+    status: community
+    source: wiki.bg3.community/en/Tutorials/Visual/Creating-A-Hair-Mod/exporting-conforming
+    tags:
+      - character-creation
+      - hair
+      - collada
+      - export-settings
+  - id: bg3.character-creation.heads-hair.body-shape-body-type-numeric-values
+    claim: A CharacterCreationAppearanceVisual's BodyShape attribute is 0 = Standard, 1 = Tall Muscular
+      (except Half-Orcs, which use Tall Muscular assets but must still be set to 0), and BodyType is
+      0 = Masc, 1 = Fem.
+    status: community
+    source: wiki.bg3.community/en/Tutorials/Visual/Creating-A-Hair-Mod/File-Setup
+    tags:
+      - character-creation
+      - ccav
+      - bodyshape
+      - bodytype
+      - enum
+  - id: bg3.character-creation.heads-hair.filename-is-the-in-game-asset-name
+    claim: "The filename of a hair/head mesh (e.g. HAIR_HUM_F_Braids_Short_B) is what the asset is
+      called in the game files, and is what you search for when extracting it with the Multitool:
+      \"the filename is what the hair is actually called in the game files. You'll need this when
+      extracting the hair meshes using the Multitool.\""
+    status: community
+    source: wiki.bg3.community/en/Tutorials/Visual/Creating-A-Hair-Mod/Preparing-To-Mod
+    tags:
+      - character-creation
+      - hair
+      - naming
+      - multitool
+  - id: bg3.character-creation.heads-hair.gltf-and-collada-are-both-supported-import-paths
+    claim: "The same Blender exporter add-on offers two export routes and the tutorials pick different
+      ones by asset kind: a static hair/head mesh being conformed goes out through \"File > Export >
+      DOS2/BG3 Collada\" as .dae, while an animation is exported \"using the exporter addon (the
+      'export via GLTF' option, not via Collada)\". Choose the route by whether the asset carries
+      animation, not by preference."
+    status: community
+    source: wiki.bg3.community/en/Tutorials/Visual/Creating-A-Hair-Mod/exporting-conforming
+      (Collada/.dae route); wiki.bg3.community/en/Tutorials/Animations/CustomAnimationsBlender §How
+      to correctly bake and export your animation (GLTF route)
+    tags:
+      - character-creation
+      - gltf
+      - collada
+      - exporter
+    detail: "Neither the Creating-A-Head-Mod page nor getting-started-with-3d-modding states the
+      add-on's format capabilities, so this fact cites the two pages that actually demonstrate each
+      route. Duplicates nothing: it is the selection rule;
+      bg3.animations.gr2.export-via-gltf-not-collada-for-animations is the animation half."

package/knowledge/baldursgate3/communitylibrary.shared-content.yaml

@@ -0,0 +1,129 @@
+game: baldursgate3
+topic: communitylibrary.shared-content
+title: BG3 Community Library — reusing shared content as a runtime dependency
+facts:
+  - id: bg3.community-library.shared-content.reference-not-copy
+    claim: Using Community Library content does not require copying any of its files into a dependent
+      mod — a mod references a Community Library entry by its data ID (e.g. a spell or passive name)
+      from its own SpellLists.lsx/Progressions.lsx, and the actual asset stays owned by the
+      Community Library mod, which must be installed as a runtime dependency.
+    status: community
+    source: github.com/BG3-Community-Library-Team/BG3-Community-Library wiki,
+      Using-Community-Library-Content.md ("You don't need to copy/paste any of the Community Library
+      content into your mod to make use of it. All you have to do is reference the ID of the piece
+      you want in the right spot."); dependency half from Readme.md §For Players
+    tags:
+      - community-library
+      - dependency
+      - reuse
+    detail: "This is the distinction that matters for provenance: a declared dependency, not a vendored
+      copy of the library's mesh/texture/script/data files."
+  - id: bg3.community-library.shared-content.cl-naming-prefix-convention
+    claim: Community Library content is namespaced with a "CL_" prefix on every internal Name (e.g.
+      CL_Target_WeaknessToFire, CL_STATUS_WEAKNESS_TO_FIRE, CL_Passive_Petpal), which is what a
+      dependent mod's Selectors/PassivesAdded strings must reference verbatim.
+    status: community
+    source: github.com/BG3-Community-Library-Team/BG3-Community-Library Included.md (all three names
+      appear in the included-content list)
+    tags:
+      - community-library
+      - naming-convention
+      - cl-prefix
+  - id: bg3.community-library.shared-content.add-spell-via-spelllist-and-addspells
+    claim: Pulling a Community Library spell into a mod's own race/class/subclass is done by (1) adding
+      a SpellList entry in Public/ModName/Lists/SpellLists.lsx whose Spells attribute names the CL_
+      spell, then (2) referencing that SpellList's UUID from a Progression's Selectors as
+      AddSpells(YOUR_SPELLLIST_UUID), then (3) putting that Progression's TableUUID into the target
+      Race/ClassDescription's ProgressionTableUUID field — three separate files must all agree.
+    status: community
+    source: github.com/BG3-Community-Library-Team/BG3-Community-Library wiki,
+      Using-Community-Library-Content.md §Adding a spell or passive to a race or class via
+      progression
+    tags:
+      - community-library
+      - spelllists
+      - progressions
+      - uuid-linkage
+  - id: bg3.community-library.shared-content.add-passive-skips-spelllist-step
+    claim: Adding a Community Library passive (instead of a spell) skips the SpellLists.lsx step
+      entirely — the CL_ passive's name is placed directly into the target Progression's
+      PassivesAdded attribute.
+    status: community
+    source: github.com/BG3-Community-Library-Team/BG3-Community-Library wiki,
+      Using-Community-Library-Content.md §Adding a spell or passive to a race or class via
+      progression
+    tags:
+      - community-library
+      - passivesadded
+      - progressions
+  - id: bg3.community-library.shared-content.using-clause-clones-and-overrides
+    claim: A mod can create a specialized version of a Community Library spell/passive/item/character by
+      making a new stats entry that "using"s the CL_ entry's name and then overriding only the
+      fields it wants to change — the new entry pulls in all of the CL_ entry's data first, so only
+      the differing fields need to be listed.
+    status: community
+    source: github.com/BG3-Community-Library-Team/BG3-Community-Library wiki,
+      Using-Community-Library-Content.md §Using a library spell, passive, or other data item as a
+      base for a more mod-specialized version
+    tags:
+      - community-library
+      - using-clause
+      - stats-inheritance
+  - id: bg3.community-library.shared-content.compat-framework-split-out-since-2-0-4-1
+    claim: As of Community Library 2.0.4.1, the Compatibility Framework is no longer bundled inside the
+      Community Library — it was split out into its own project, though the Compatibility Framework
+      still relies on Lua functions defined within the Community Library at runtime.
+    status: community
+    source: github.com/BG3-Community-Library-Team/BG3-Community-Library Readme.md ("As of 2.0.4.1, this
+      mod no longer includes the Compatibility Framework, which has been separated out into it's own
+      project. Compatibility Framework does rely on Lua functions defined within the Community
+      Library.")
+    tags:
+      - community-library
+      - compatibility-framework
+      - version-floor
+      - dependency
+  - id: bg3.community-library.shared-content.players-only-need-it-if-a-mod-requires-it
+    claim: Community Library is not something a player needs to install proactively — it's only required
+      when another installed mod declares it as a dependency; if none of a player's mods require it,
+      the README states they "don't need to install it."
+    status: community
+    source: github.com/BG3-Community-Library-Team/BG3-Community-Library Readme.md §For Players
+    tags:
+      - community-library
+      - player-facing
+      - dependency
+  - id: bg3.community-library.shared-content.attribution-credited-in-readme
+    claim: 'The Community Library README carries a "Credits for External Content Used" section that
+      credits third-party art individually by name — "Game-Icons.net for The following Icons,
+      granted under CC 3.0", then each icon listed (Alter Weapon, Alter Weapon: Enflame, ...).
+      Attribution for externally-sourced assets inside shared content is expected to be itemised,
+      not covered by a blanket licence note.'
+    status: community
+    source: github.com/BG3-Community-Library-Team/BG3-Community-Library Readme.md §Credits for External
+      Content Used
+    tags:
+      - community-library
+      - attribution
+      - licensing
+  - id: bg3.community-library.shared-content.contribution-goes-through-fork-and-pr
+    claim: "Contributing content to the Community Library follows a fork-then-pull-request workflow on
+      GitHub: fork the repo, add and test changes, then submit a PR for the team to review, accept,
+      or explain why it wasn't accepted."
+    status: community
+    source: github.com/BG3-Community-Library-Team/BG3-Community-Library Readme.md §Independent Contribution
+    tags:
+      - community-library
+      - contribution
+      - workflow
+  - id: bg3.community-library.shared-content.recommended-load-order-top
+    claim: The Community Library's own install instructions direct players to drag it to the top of the
+      mod list in BG3 Mod Manager's left pane — the opposite end from where the (now-separate)
+      Compatibility Framework is told to load.
+    status: community
+    source: github.com/BG3-Community-Library-Team/BG3-Community-Library Readme.md §Installation > BG3
+      Mod Manager, step 6 ("Drag CommunityLibrary to the top of the Left pane"); contrast with
+      bg3.compatibility-framework.api.load-order-bottom
+    tags:
+      - community-library
+      - load-order