Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

XRF Tools

stalker-xrf-tools is the companion tools workspace for XRF development. It contains reusable Rust crates, a CLI, and a Tauri desktop application.

Use it for tasks that are awkward to do by hand:

  • reading and unpacking X-Ray archives;
  • verifying and formatting LTX configs;
  • converting and checking translations;
  • inspecting script exports;
  • packing and unpacking equipment icons and texture descriptions;
  • inspecting or converting spawn, particles, OGF, and OMF data.

Repository Layout

  • crates/: reusable Rust crates for X-Ray formats and project validation.
  • bin/xrf-cli: command-line tool.
  • bin/xrf-app: Tauri backend for the desktop application.
  • bin/xrf-ui: React frontend for the desktop application.

The engine repository uses a bundled tools binary from cli/bin for some build and asset operations.

Interfaces

Use the desktop app for manual inspection and editing workflows. Use the CLI for repeatable scripts, CI checks, and engine build integration.

Choosing an interface

Use the CLI when the command must be repeatable, run in CI, or become part of an engine build step. Examples include LTX verification, translation builds, archive unpacking, spawn conversion, and texture packing.

Use the desktop app when you need to inspect structured project data with navigation: archives, configs, dialogs, exports, icons, spawns, and translations. Some app routes are read-only or prototype workflows; the page for each app tool calls out what is currently wired.

Source truth

Tool behavior comes from the tools workspace, not from the book text:

  • CLI commands: stalker-xrf-tools/bin/xrf-cli/src/commands;
  • desktop backend commands: stalker-xrf-tools/bin/xrf-app/src;
  • desktop frontend routes: stalker-xrf-tools/bin/xrf-ui/src/applications;
  • reusable format logic: stalker-xrf-tools/crates.