Skip to content

Latest commit

 

History

History
31 lines (20 loc) · 1.39 KB

README.md

File metadata and controls

31 lines (20 loc) · 1.39 KB

unreal_helpers

Documentation Crates.io Build status License: MIT

The unreal_helpers crate is a Rust library that implements common functionality for reading Unreal Engine files.

Documentation

Crate documentation is published to docs.rs/unreal_helpers.

Usage

The crate can be added to a Rust project as a dependency by running the command cargo add unreal_helpers.

Features

All content in this crate is hidden behind feature flags. Enabling most features will also enable further dependencies.

  • read_write: Enables extension Traits UnrealReadExt and UnrealWriteExt which help with parsing Unreal data formats.
  • path: Enables game_to_absolute function.
  • guid: Enables Guid type.
  • serde: Enables serde support for Guid type.
  • bitvec: Enables extension Trait BitVecExt.

Examples

The tests directory contains several tests that demonstrate how to use the crate.