xray-forge/stalker-xrf-engine

Enabling power of typescript and pre-processing for XRay-16 engine.

🎮 Stalker XRF

Fully rewritten stalker lua script engine with typescript.

📦 In short

• Faster development with typescript and static analysis
• Custom CLI and build pipeline, dev tools
  • Scripts engine rewritten with typescript (tstl)
  • Generation UI forms from JSX
  • Building game configs
  • Simple translations generation
• Creation of custom modded game packages
• Modular extensions
• Unit testing
• Consistent code formatting, linting, configs format and verification

📍 Purpose

• Provide shared up-to-date template and tools for mod development
• Produce documented and readable code, document xray SDK
• Simplify development and building process, automate some steps

---

🌓 Links

• Starting work
• CLI commands
• Docs
• Types, source

📌What is used

• NodeJS
• Typescript
• TypeScriptToLua
• Jest
• Fengari Lua VM
• Open-X-Ray
• XRF tools

📦 Changes / differences from original

Full changes list: changelist

The intention of this engine is to allow easier modding without introducing breaking changes to the original plot.
Optimizations, quality and logics updates are welcome.

Breaking / radical changes can be implemented as extensions.

🌓 TODOs / tasks

• cli and tooling
• xrf engine
• c++ engine (open xray)
• documentation

🧰 State / bugs

It took ~3 months just to migrate all the 20 years of LUA codebase to typescript / support luabind.
Further game testing and re-architecture produces new bugs and issues which are easier to prevent with unit tests.
As for now, main focus is separation and clarification of logics, unit tests coverage.