minecraft-assets 0.0.6

Parsing Minecraft asset files and resource packs in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

//! An API for programmatically accessing Minecraft resources and associated
//! metadata.
//!
//! ## Resource Locations
//!
//! Every resource is associated with a unique [`ResourceLocation`], which is a
//! combination of a [`ResourceKind`] and a *namespaced identifier*.
//!
//! ## Providers
//!
//! Resources can be enumerated and loaded using the [`ResourceProvider`] trait.
//! This crate provides the [`FileSystemResourceProvider`] as a convenient
//! implementation of this trait.
//!
//! ## Asset Pack
//!
//! Resources can be ergonomically loaded through the [`AssetPack`] API.

use std::io;

mod asset_pack;
mod provider;
mod resolve;
mod resource;

pub use asset_pack::AssetPack;
pub use provider::{
    EnumerateResources, FileSystemResourceProvider, LoadResource, ResourceProvider,
};
pub use resolve::ModelResolver;
pub use resource::{
    ModelIdentifier, ResourceCategory, ResourceKind, ResourceLocation, ResourcePath,
    MINECRAFT_NAMESPACE,
};

/// Error types that can be returned from API methods.
#[derive(Debug, thiserror::Error)]
#[allow(missing_docs)]
pub enum Error {
    #[error(transparent)]
    IoError(#[from] io::Error),

    #[error(transparent)]
    ParseError(#[from] serde_json::Error),
}

/// Result alias for convenience.
pub type Result<T, E = Error> = std::result::Result<T, E>;