Library and binary for parsing Skyrim plugin files and extracting CELL data.
The main objective of this library is to extract the form ID and X and Y coordinates of every exterior cell a plugin edits as fast as possible, ignoring the rest of the plugin.
cargo install skyrim-cell-dump
Or, build yourself by checking out the repository and running:
cargo build --release --features build-binary
```
Usage: skyrim-cell-dump.exe
Extracts cell edits from a TES5 Skyrim plugin file
Options: -f, --format format of the output (json or text) -p, --pretty pretty print json output --help display usage information ```
The pretty JSON format looks something like:
json
{
"header": {
"version": 1.0,
"num_records_and_groups": 792,
"next_object_id": 221145,
"author": "Critterman",
"description": "An example plugin",
"masters": [
"Skyrim.esm",
"Update.esm",
"Dawnguard.esm",
"HearthFires.esm",
"Dragonborn.esm"
]
},
"cells": [
{
"form_id": 100000001,
"editor_id": "SomeInterior",
"x": null,
"y": null,
"is_persistent": false
},
{
"form_id": 3444,
"editor_id": null,
"x": 0,
"y": 0,
"is_persistent": true
},
{
"form_id": 46432,
"editor_id": "SomeExterior01",
"x": 32,
"y": 3,
"is_persistent": false
},
{
"form_id": 46464,
"editor_id": "SomeExterior02",
"x": 33,
"y": 2,
"is_persistent": false
},
{
"form_id": 46498,
"editor_id": null,
"x": 32,
"y": 1,
"is_persistent": false
}
]
}
Note: I have only tested parsing Skyrim Special Edition .esp, .esm, and .esl files.
You can include this crate in your Cargo.toml and get the parsed Plugin struct with:
```rust use skyrimcelldump::parse_plugin;
let plugincontents = std::fs::read("Plugin.esp").unwrap(); let plugin = parseplugin(&plugin_contents).unwrap(); ```