Add Vortex extension design doc (Unit 4, design only) - #4
Merged
Conversation
Design document for a future Vortex (Nexus Mods) extension that would drive WSM's existing CLI (`merge`) and MCP (`scan_conflicts`, `merge_conflicts`, `get_status`, `list_merges`) interfaces from Vortex's TypeScript/Node extension runtime, instead of only through direct invocation. Covers tech stack, install/setup, invocation model (CLI-first recommended, MCP as a v2 enhancement), data model mapping between Vortex's mod/load-order state and WSM's mods directory/ mods.settings, proposed UX, and open questions for the repo owner. No code changes - this unit is explicitly design-only per this batch's plan; TypeScript/Vortex implementation is deferred to a later batch. Grounded directly against this repo's CLAUDE.md and against Vortex's actual, current game-witcher3 extension source (fetched via `gh api`) to document real prior art - including its GUI-only tool invocation, its existing WitcherScriptMerger.exe.config rewriting, and its MergeInventory.xml/Collection-import behavior - rather than assuming or inventing capabilities on either side. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01GXAuGMLB44T5Zv5o5ZzKah
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/vortex-extension-design.md: a design document for a future Vortex (Nexus Mods mod manager) extension that would drive WitcherScriptMerger's existing CLI (merge) and MCP (scan_conflicts,merge_conflicts,get_status,list_merges) interfaces from Vortex's TypeScript/Node extension runtime.mergeas the lower-risk default, MCP as a v2 enhancement for conflict preview/history/status), a data-model mapping between Vortex's mod/load-order state and WSM'sModsDirectory/mods.settings/MergedModName, proposed UX surface, and a list of open questions for the repo owner to resolve before real implementation starts.Why
Vortex already has mature, built-in support for managing Witcher 3 mod installation and load order, and its own (separate, older) integration with a different Script Merger fork. A first-class Vortex extension for this repo's WSM — with its newer CLI/MCP headless interfaces — needs a written plan before anyone starts writing TypeScript against it, per the repo owner's explicit direction for this unit.
How I verified it
This is a documentation change, so there's no build/test in the traditional sense. What I did:
CLAUDE.mdin full and grounded every claim about WSM's own CLI/MCP behavior against it plus the actual source (Program.cs'sRunCli/RunMcp,Mcp/WsmMcpTools.cs,Paths.cs,AppSettings.cs) rather than paraphrasing from memory — e.g. the CLI's exact exit-code semantics (0/1/2) came from readingProgram.csdirectly, not fromCLAUDE.md's prose.game-witcher3extension source directly (gh api repos/Nexus-Mods/vortex-games/contents/game-witcher3/index.js) to document real prior art instead of guessing: it already auto-downloads a different WSM fork (IDCs/WitcherScriptMerger), already rewritesWitcherScriptMerger.exe.config'sGameDirectory/VanillaScriptsDirectory/ModsDirectoryviasetMergerConfig(), already parsesMergeInventory.xml, and expects a lockedmod0000_-prefixed merged-mod folder — all called out and reconciled with this design rather than treated as if this were greenfield.code-reviewskill against the diff. It independently re-fetched the Vortex source and caught several factual errors in my first draft (most importantly: I'd initially claimed Vortex's existing tool-launch was a proven headless-invocation precedent — it's actually a GUI launch with an empty argument list, which I verified myself against the source and then corrected, along with several other findings: an internal contradiction between the CLI's exit-code semantics and a UX bullet, an overstated table row, and an unexamined Proton-vs-native-Linux-build assumption). All findings were verified against source before being incorporated.dotnet build WitcherScriptMerger.slnstill succeeds (doc-only change, but checked per this repo's process).AI assistance disclosure
This PR was produced by Claude Code (Claude Sonnet 5), per this repo's AI-assisted-development disclosure policy in
CONTRIBUTING.md. Includes independent fact-checking against both this repo's source and Vortex's third-party source, and a self-correction pass after thecode-reviewskill caught inaccuracies in an earlier draft (detailed above).https://claude.ai/code/session_01GXAuGMLB44T5Zv5o5ZzKah