X-Ray Forge

X-Ray Forge (XRF) is a TypeScript rewrite of the S.T.A.L.K.E.R.: Call of Pripyat script layer. It compiles gameplay code to Lua and builds the configs, UI forms, translations, and resources used by X-Ray.

This book covers the full development workflow: project setup, builds, CLI and desktop tools, runtime architecture, gameplay schemes, and debugging.

Start here

• New to XRF? Follow Installation, then read Building.
• Working on gameplay? Start with the Script engine and Schemes.
• Looking for a command? See the XRF CLI or Tools CLI.
• Investigating runtime behavior? Read Game engine and Debugging.

Generated files are written under target/. Edit sources in the engine or tools repository and rebuild; do not edit generated gamedata by hand.

Project repositories

• XRF engine — script runtime and project CLI.
• XRF tools — format libraries, CLI, and desktop application.
• XRF binaries — packaged engine and tool binaries.
• XRF X-Ray 16 SDK — TypeScript-facing engine API.
• Book source — this documentation.

XRF uses OpenXRay as its main engine reference. Game assets are split across base, extended, and locale repositories for English, Ukrainian, and Russian.