Repository navigation
v4.0.0 turns the X4 Foundations Claude Code Modding Toolkit into the X4 AI Assistant Toolkit: X4-specific analysis tools, engine knowledge and guided workflows for working with your own game installation.
Claude Code and Codex are first-class integrations. OpenCode support is best effort and CLI only. Other coding agents can use the knowledge and tools; guard protection requires an adapter that passes the included conformance check.
What changes in 4.0
- Choose your agent. Instructions, skills, guards and settings are generated from a shared source into the files each supported agent reads.
- Verified save preservation. With guards active, recognized changes to one or two existing saves require permanent, verified preservation first. Bulk access requires qualified human approval. Opaque programs naming saves require review; unresolved scope is refused.
- Check which protections are ready.
x4doctorchecks prerequisites, wiring and guard self-tests, and distinguishes failures, unknowns and steps only the user can complete. - Optional reference protection.
x4refguardcan protect the unpacked reference folder independently of agent hooks. Existing reference trees require an explicit protection step; elevated processes remain outside this guarantee. - More precise mod interaction reports.
x4compatevaluates edits at their load position, identifies overwritten additions and separates qualified dependency overwrites into advisories. - Find Nexus mods by name.
x4modlistsearch marks candidates as have, have? or new against the active registry and reports incomplete coverage. - Keep useful evidence while managing output. Retention tooling uses recoverable removal and protects qualified backups, baselines and linked evidence. Personal notes in
KNOWLEDGEBASE.local.mdsurvive upgrades.
The toolkit also includes validation, merged-data provenance, log triage, save inspection, numeric comparisons, script-reference tracing, semantic version comparisons and optional corpus/live queries. See the README for what each tool can help you do.
Selected fixes
- Cross-mod patches at nested DLC paths are included in the effective store.
- Hook-only deployments resolve their configured shared runtime instead of raising
ValueErrorfor unknown tools. - Save/profile approval ordering preserves saves before returning a separate confirmation.
- Restoring an older backup preserves the current destination first.
- Interrupted or malformed Steam responses report unavailable information rather than a false absence.
- Cleanup preserves known-good baselines and linked evidence, and isolated test scratch avoids pruning other projects' runs.
- Selector/reference, expression-checker, guard parsing and install/upgrade issues found during review are corrected.
The full changelog records the complete changes, evidence and known limitations.
Upgrading to 4.0
- Read the upgrade notes, then rerun the installer with
--over-existing(-OverExistingin PowerShell). - The paths configuration moves to
x4-paths.envin the toolkit root. - An edited legacy
CLAUDE.mdis preserved asX4-NOTES.pre-4.0.md, but that copy is no longer loaded. Move the personal instructions you want intoKNOWLEDGEBASE.local.md. A customizedAGENTS.mdis preserved separately. - Codex users: trust the folder, review the hooks in
/hooks, then runx4doctor. Look for the X4 GUARDS LIVE session banner. - Rebuild the effective store and other derived indexes before relying on their results. Check whether an existing reference folder needs OS protection applied.
For a fresh installation, follow the setup guide and the included SETUP_PROMPT.txt. On Windows, extract to a short path.
Validation and support
The complete Windows/Ubuntu CI run 39541688798 passed on b9bab53: Windows 6,262 passed / 60 skipped; Ubuntu 5,904 / 330 on both main and cold-clone checks, and 5,847 / 379 on the cold archive. All mutation and fuzz gates passed. The final executable code is identical; the subsequent resource-policy wording and release metadata are checked separately and independently reviewed. The final generated release metadata passed 16 targeted checks with no skips; both required identifier scans passed. This is scoped verification of release metadata, not a claim of full CI on the final tag.
Windows is the primary development environment. Codex on Linux/macOS and reference OS protection there are best effort, not device-tested. OpenCode host operation has not been verified. The entire optional live channel is experimental: use a throwaway save. Guards do not sandbox arbitrary programs; keep independent backups and read the coverage limitations.
Independent fan project. No Egosoft game data, AI model or subscription is bundled.
Release asset
- Tag:
v4.0.0ate20a7382ad44d3ad80fa70f09230a360d157207e. - Archive:
X4.Foundations.AI.Assistant.Toolkit-v4.0.0.zip. - Size: 10,666,173 bytes.
- SHA-256:
ae030cbb5ce07296485a1c2cdc61294ec015c0ec56a8276fd1d7eba7ff2e7437. - Packaging verification: all 791 shipped files match the tag's tracked member set and committed objects; 37 export-ignored maintainer files are excluded.