X-Ray Forge

X-Ray Forge (XRF) is a collection of development projects for X-Ray 16 engine. It provides a TypeScript scripting layer and the tooling around it for building, testing, and maintaining mods.

What XRF includes

• A TypeScript rewrite of the OpenXRay scripting layer, compiled to Lua.
• Build-time tools for scripts, configs, UI forms, translations, and resources.
• A TypeScript SDK for the OpenXRay engine API.
• The XRF CLI for building projects and working with a local game installation.
• XRF Tools: a command-line toolset and a desktop development application.
• This book and the SDK API reference.

Start here

• Setting up or building an XRF project? Read Installation, then Building.
• Writing or changing scripts? Start with the Game scripting and Schemes.
• Looking for a command? See the XRF CLI or XRF Tools CLI.
• Working with game-data files? See XRF Tools.
• Investigating runtime behavior? Read X-Ray engine and Debugging.

Repositories

Core development

• XRF engine — TypeScript scripting layer, build pipeline, and CLI.
• X-Ray 16 TypeScript SDK — TypeScript API for OpenXRay.
• XRF tools — command-line tools and desktop application.
• XRF tools end-to-end tests — end-to-end tests for the XRF Tools CLI.
• XRF book — this documentation.

Distribution

• XRF binaries — packaged engine and tool binaries.

Resource packs

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