Oliver Hamlet
d9173d37cd
Unfortunately the published binary no longer works on Travis unless the build happens on its bionic image, because the binary is built in GitHub Actions using the ubuntu:latest image. Running in bionic isn't guaranteed not to break in the future, so install from source and cache the artifact to be sure. Fortunately, cargo install no longer requires --force to update an installed binary crate, so building from source and caching the result is simpler than it used to be.
loot-condition-interpreter
A library for parsing and evaluating LOOT's metadata condition strings. It provides:
- Support for metadata syntax v0.14 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
To generate a C++ header file as part of the build, instead run:
cargo build --release --package loot-condition-interpreter-ffi --all-features
This will create a file at ffi/include/loot_condition_interpreter.h.
However, this involves building cbindgen
as a dependency, which is relatively slow. If you have cbindgen installed
separately, it's faster to generate the headers using its CLI:
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 AppVeyor and Travis CI configurations for examples on what should be extracted where.
To run the Rust tests:
cargo test --all
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