Expand description
A library for reading and extracting files from Obsidian .obby plugin files.
This crate provides functionality to read .obby files, which are archives used
by Obsidian plugins. It allows you to list and extract files from these archives,
with special support for extracting plugin.json files.
§Example
use obsidian_lib::{ObbyArchive, extract_plugin_json};
use std::path::Path;
use std::fs::File;
// From a file path
let json = extract_plugin_json(Path::new("plugin.obby"))?;
// Or from any Read + Seek source
let file = File::open("plugin.obby")?;
let mut archive = ObbyArchive::new(file)?;
let entries = archive.list_entries();
let data = archive.extract_entry("plugin.json")?;Structs§
- Obby
Archive - Main reader struct for working with .obby files from any source
- Wasm
Obby Archive - A wrapper struct for the WebAssembly environment to interact with
.obbyfiles
Functions§
- extract_
plugin_ json - Convenience function to extract and parse the
plugin.jsonfile from an.obbyarchive - open
- Opens an .obby file from a path