Stalker XRF Book

This book documents the X-Ray Forge script engine, build pipeline, CLI tools, and supporting modding workflow for S.T.A.L.K.E.R.: Call of Pripyat projects.

Use it when you need to:

• set up the XRF engine project locally;
• build scripts, configs, UI forms, translations, and resources into target/gamedata;
• use the local CLI for linking, verification, packaging, engine switching, and asset utilities;
• understand how the rewritten TypeScript script engine maps to X-Ray Lua scripts;
• debug game logic, UI, weather, logs, and runtime state.

The implementation source lives in stalker-xrf-engine. This book should describe behavior that is implemented there or in the sibling XRF tool/resource repositories.

Links

• XRF X-Ray 16 SDK
• XRF engine repository
• XRF tools repository
• XRF binaries repository
• Book repository

Resource Repositories

• Base assets
• Extended assets
• English locale assets
• Ukrainian locale assets
• Russian locale assets

References

• This site is built with mdBook.
• XRF targets OpenXRay as the main engine fork.