mirror of
https://github.com/loot/loot-condition-interpreter.git
synced 2026-07-27 14:16:09 -07:00
20474297543e385678e2c5b1327717f8e5185de9
The action updates very frequently with irrelevant changes (for other things it can install), making it more of a review burden than it's worth.
loot-condition-interpreter
A library for parsing and evaluating LOOT's metadata condition strings. It provides:
- Support for metadata syntax v0.26 condition strings.
- Condition string parsing without evaluation, for checking syntax.
- Evaluation of parsed condition strings.
- Efficient and safe concurrent condition evaluation thanks to Rust's safety guarantees.
- Caching of individual function evaluation results and calculated CRCs.
- Executable version parsing without any external runtime dependencies.
- Lots of tests, and benchmarks.
- A C FFI library that wraps the Rust library.
Build
Make sure you have Rust installed.
To build the Rust and C FFI libraries, run:
cargo build --release --package loot-condition-interpreter-ffi
Use cbindgen to generate a C++ header file:
cbindgen ffi/ -o ffi/include/loot_condition_interpreter.h
Tests & Benchmarks
The tests and benchmarks need the testing-plugins and the LOOT API v0.13.8 Windows archives to be extracted and present in the repo root. See the GitHub Actions CI workflow for examples on what should be extracted where.
To run the Rust tests:
cargo test --workspace
To run the benchmarks:
cargo bench
There are also C++ tests for the FFI library, they require a C++ toolchain and CMake to be installed. To run the C++ tests:
mkdir ffi/build
cd ffi/build
cmake ..
cmake --build .
ctest
Languages
Rust
97.2%
C++
2.5%
CMake
0.3%