mirror of
https://github.com/loot/libloot.git
synced 2026-07-27 14:16:01 -07:00
Oliver Hamlet
c94629303d
It only does so if git is on the PATH and `git rev-parse --short HEAD` produces a UTF-8 string, but the script should never fail.
88 lines
3.6 KiB
Markdown
88 lines
3.6 KiB
Markdown
# libloot
|
|
|
|
|
|
[](http://loot-api.readthedocs.io/en/latest/?badge=latest)
|
|
|
|
## Introduction
|
|
|
|
LOOT is a plugin load order optimisation tool for Starfield, TES III: Morrowind, TES IV: Oblivion, TES IV: Oblivion Remastered, TES V: Skyrim, TES V: Skyrim Special Edition, TES V: Skyrim VR, Fallout 3, Fallout: New Vegas, Fallout 4, Fallout 4 VR and OpenMW. It is designed to assist mod users in avoiding detrimental conflicts, by automatically calculating a load order that satisfies all plugin dependencies and maximises each plugin's impact on the user's game.
|
|
|
|
LOOT also provides some load order error checking, including checks for requirements, incompatibilities and cyclic dependencies. In addition, it provides a large number of plugin-specific usage notes, bug warnings and Bash Tag suggestions.
|
|
|
|
libloot provides access to LOOT's metadata and sorting functionality, and the LOOT application is built using it.
|
|
|
|
libloot's core is written in Rust, and C++, Python and Node.js wrappers can be found in the `cpp`, `python` and `nodejs` subdirectories respectively.
|
|
|
|
## Downloads
|
|
|
|
Binary artifacts are currently only provided for the C++ wrapper.
|
|
|
|
Releases are hosted on [GitHub](https://github.com/loot/libloot/releases).
|
|
|
|
Snapshot builds are available as artifacts from [GitHub Actions runs](https://github.com/loot/libloot/actions), though they are only kept for 90 days and can only be downloaded when logged into a GitHub account. To mitigate these restrictions, snapshot build artifacts include a GPG signature that can be verified using the public key hosted [here](https://loot.github.io/.well-known/openpgpkey/hu/mj86by43a9hz8y8rbddtx54n3bwuuucg), which means it's possible to re-upload the artifacts elsewhere and still prove their authenticity.
|
|
|
|
The snapshot build artifacts are named like so:
|
|
|
|
```
|
|
libloot-<last tag>-<revisions since tag>-g<short revision ID>_<branch>-<platform>.<file extension>
|
|
```
|
|
|
|
## Build
|
|
|
|
Make sure you have [Rust](https://www.rust-lang.org/) installed.
|
|
|
|
The `LIBLOOT_REVISION` environment variable is used to embed the commit hash into the build. If it's not defined then `unknown` will be used instead. The Cargo build script will automatically define it if libloot is built from a Git repository and `git` is accessible from your `PATH`.
|
|
|
|
To define it in PowerShell, run:
|
|
|
|
```powershell
|
|
$env:LIBLOOT_REVISION = git rev-parse --short HEAD
|
|
```
|
|
|
|
To define it in a POSIX shell, run:
|
|
|
|
```sh
|
|
export LIBLOOT_REVISION=$(git rev-parse --short HEAD)
|
|
```
|
|
|
|
The build can then be run using:
|
|
|
|
```
|
|
cargo build --release
|
|
```
|
|
|
|
### API documentation
|
|
|
|
The Rust API's reference documentation can be built and viewed using:
|
|
|
|
```
|
|
cargo doc --open
|
|
```
|
|
|
|
The `docs` directory contains more general documentation.
|
|
|
|
## Tests
|
|
|
|
Before running the tests, first extract the [testing-plugins](https://github.com/Ortham/testing-plugins) archive to this readme's directory (so that there's a `testing-plugins` directory there).
|
|
|
|
To do that using `curl` and `tar` in a POSIX shell:
|
|
|
|
```sh
|
|
curl -sSfL https://github.com/Ortham/testing-plugins/archive/refs/tags/1.6.2.tar.gz | tar -xz --strip=1 --one-top-level=testing-plugins
|
|
```
|
|
|
|
To do that in PowerShell:
|
|
|
|
```powershell
|
|
Invoke-WebRequest https://github.com/Ortham/testing-plugins/archive/refs/tags/1.6.2.zip -OutFile testing-plugins-1.6.2.zip
|
|
Expand-Archive testing-plugins-1.6.2.zip .
|
|
Move-Item testing-plugins-1.6.2 testing-plugins
|
|
Remove-Item testing-plugins-1.6.2.zip
|
|
```
|
|
|
|
The tests can then be run using:
|
|
|
|
```
|
|
cargo test
|
|
```
|