Russian version: README_RU.MD
Repo-local Codex skill/plugin workbench for S.T.A.L.K.E.R. Anomaly 1.5.3 modding.
This repository is meant to be opened directly in Codex or VS Code. It provides:
- a local STALKER modding skill
- repo-local MCP config for DeepWiki and GitMCP references
- helper scripts for project creation, import, validation, packaging, FOMOD staging, XML encodings, crash-log triage, and an evidence-backed expertise vault
AGENTS.md and .skills/stalker-modding/SKILL.md remain the source of truth for the agent. This README is the human quickstart.
- Codex can currently be tried from ChatGPT Free and Go for a limited time, while Plus, Pro, Business, and Enterprise/Edu have broader included access.
- Do not assume "free" means unlimited. Codex usage is capped by plan limits, and larger tasks, bigger codebases, long sessions, cloud work, and higher-reasoning runs consume the allowance faster.
- If someone is new to Codex, warn them up front that limits can disappear quickly on real coding work so they are not surprised.
- Official references:
- plan/access overview: https://help.openai.com/en/articles/11369540
- rate card / credits overview: https://help.openai.com/en/articles/20001106-codex-rate-card
-
Download this repository and unpack it into a normal working folder on disk. You can use a ZIP download of the repo or your usual Git workflow. The important part is that Codex opens the unpacked repository folder itself, not a nested subfolder.
-
Install Codex in one of these ways:
- Codex CLI:
- official getting started: https://help.openai.com/en/articles/11096431-openai-codex-ci-getting-started
- Codex docs overview: https://platform.openai.com/docs/codex
- Codex Desktop app:
- official product announcement: https://openai.com/index/introducing-the-codex-app
- Codex product page: https://openai.com/codex
- Codex in VS Code:
- OpenAI help overview for Codex availability in VS Code: https://help.openai.com/en/articles/11369540
- Codex product/docs overview: https://platform.openai.com/docs/guides/code-generation
- Codex CLI:
-
Open the unpacked repository folder in Codex or in VS Code with Codex available.
-
In Codex settings, install the repo-local plugins if Codex offers them. This workbench provides
STALKER Modding WorkbenchandExpertise Compiler. -
After installation, start a new Codex task. The checked-in
stalker-anomalyvault is mandatory: the harness retrieves and verifies evidence before repository decisions. Good starter prompts:Get oriented in this workspace and tell me what you can do nowInitialize yourself for working with this repoWhat modding workflows and helper tools are available in this workspace?
-
To verify the bundled knowledge runtime manually, run:
- WSL / Linux:
python3 ./.skills/stalker-modding/scripts/expertctl.py --workspace . doctor stalker-anomaly- PowerShell:
py -3 .\.skills\stalker-modding\scripts\expertctl.py --workspace . doctor stalker-anomaly.expertise/stalker-anomaly ships compiled from the bundled Anomaly skill, local vanilla and engine references, Modding Book, MCM, GAMMA, and the Lua API export. It is a compact workspace-reference vault: it stores the compiled Wiki, source hashes, deterministic indexes, diagnostics, and the generated runtime skill without duplicating the tracked reference packs.
The local launcher requires only Python 3.11+ and Git:
python3 ./.skills/stalker-modding/scripts/expertctl.py --workspace . status stalker-anomaly
python3 ./.skills/stalker-modding/scripts/expertctl.py --workspace . context stalker-anomaly "MCM callback lifecycle" --budget 1200To extend the vault, first run hydrate stalker-anomaly to materialize self-contained snapshots, then follow add, scan, compile-plan, apply-build, and doctor. Do not edit .expertise state or snapshots manually.
Create a blank local project under projects/<name>:
python3 ./.skills/stalker-modding/scripts/init_project.py --name my_mod
python3 ./.skills/stalker-modding/scripts/scaffold_template.py --project my_mod --template lua_feature
python3 ./.skills/stalker-modding/scripts/validate_project.py --project my_mod
python3 ./.skills/stalker-modding/scripts/package_project.py --project my_modImport an existing mod copy into projects/:
python3 ./.skills/stalker-modding/scripts/import_mod.py --source /path/to/mod-or-gamedata --name imported_modExtract configs/ and scripts/ from every MO2 mods/ subfolder into one shared reference folder:
python3 ./.skills/stalker-modding/scripts/extract_mo2_resources.py --source /path/to/ModOrganizer/mods --dest "ai_workspace/user references/mo2-extract"The output is a common dest/configs and dest/scripts tree. Same-path conflicts are reported instead of silently overwritten by default; use --overwrite for last-wins behavior.
If you want to edit an existing mod in place instead of copying it into projects/, provide the explicit target path and say that in-place edits are intended.
Summarize a log file or a whole logs directory:
python3 ./.skills/stalker-modding/scripts/log_triage.py summarize /path/to/log/or/logs-dirFor recurring crash work, prefer remembering the path to MO2 mods/ or unpacked gamedata/ before remembering a logs_dir, because those paths help resolve the failing addon files. Remember external paths only with explicit user approval.
Loose package:
python3 ./.skills/stalker-modding/scripts/package_project.py --project my_modBasic core-only FOMOD package:
python3 ./.skills/stalker-modding/scripts/fomod_tool.py --project my_modprojects/is the user-owned work area for local mod projectstests/fixtures/contains repo-tracked regression inputs, not live mod projectsai_workspace/contains local reference material.codex-stalker/workspace.jsonstores workspace overlay data and remembered external paths.expertise/stalker-anomaly/is the checked-in compact starter vault; its evidence resolves to the tracked reference packs.vscode/mcp.jsonmirrors the repo-local plugin MCP configuration
- Use
ai_workspace/user referencesfor extra local references or linked external material. - The mandatory harness routes repository work through the
stalker-anomalyvault, then verifies decision-critical source ranges. - Russian localization XML is often
windows-1251; usexml_localization_tool.pybefore editing legacy XML directly. - MO2 is treated as a deployment surface, not the authoring root. Author in
projects/first, then package for MO2 when needed.