Convert

Utility module. Handles conversion logic between formats.

Detect

Conversion by input path based on file suffix.

auto(source, output=None, options=None)

Automatically convert file between formats based on file suffix.

Parameters:

• source (str | PathLike[str] | Path) – Path to input file.

• output (optional) – Path to output directory. Defaults: Same directory as source.

• options (optional) – User settings. Default: None.

Return type:

None

Example

auto(“model.mcsb”, “path/to/output”, UserOptions(parse_skeleton=True))

Formats

Implement functions to convert one format to another by simplest way.

mcsb_to_obj(source, output=None, options=None)

Converts model from .mcsb to .obj format.

Parameters:

• source (str | PathLike[str] | Path) – Path to input .mcsb file.

• output (optional) – Path to output directory. Defaults: Same directory as source.

• options (optional) – User settings. Default: None.

Example

mcsb_to_obj(“model.mcsb”, “path/to/output”, UserOptions(parse_skeleton=True))

mcsb_to_glb(source, output=None, options=None)

Converts model from .mcsb to .glb format.

Parameters:

• source (str | PathLike[str] | Path) – Path to input .mcsb file.

• output (optional) – Path to output directory. Defaults: Same directory as source.

• options (optional) – User settings. Default: None.

Example

mcsb_to_glb(“model.mcsb”, “path/to/output”, UserOptions(parse_skeleton=True))

mcsb_to_dae(source, output=None, options=None)

Converts model from .mcsb to .dae format.

Parameters:

• source (str | PathLike[str] | Path) – Path to input .mcsb file.

• output (optional) – Path to output directory. Defaults: Same directory as source.

• options (optional) – User settings. Default: None.

Example

mcsb_to_dae(“model.mcsb”, “path/to/output”, UserOptions(parse_skeleton=True))

mcsb_to_ms3d(source, output=None, options=None)

Converts model from .mcsb to .ms3d format.

Parameters:

• source (str | PathLike[str] | Path) – Path to input .mcsb file.

• output (optional) – Path to output directory. Defaults: Same directory as source.

• options (optional) – User settings. Default: None.

Example

mcsb_to_ms3d(“model.mcsb”, “path/to/output”, UserOptions(parse_skeleton=True))

ol_to_dds(source, output=None, options=None)

Converts texture from .ol to .dds format.

Parameters:

• source (str | PathLike[str] | Path) – Path to input .ol file.

• output (optional) – Path to output directory. Defaults: Same directory as source.

• options (optional) – User settings. Default: None.

Example

ol_to_dds(“texture.ol”, “path/to/output”)

ol_cubemap_to_dds(source, output=None, options=None)

Converts cubemap texture from .ol to .dds format.

Parameters:

• source (str | PathLike[str] | Path) – Path to input .ol file.

• output (optional) – Path to output directory. Defaults: Same directory as source.

• options (optional) – User settings. Default: None.

Example

ol_cubemap_to_dds(“cubemap.ol”, “path/to/output”)

mic_to_png(source, output=None, options=None)

Converts image from .mic to .png format.

Parameters:

• source (str | PathLike[str] | Path) – Path to input .mic file.

• output (optional) – Path to output directory. Defaults: Same directory as source.

• options (optional) – User settings. Default: None.

Example

mic_to_png(“image.mic”, “path/to/output”)

texarr_to_zip(source, output=None, options=None)

Converts archive from .texarr to .zip format.

Parameters:

• source (str | PathLike[str] | Path) – Path to input .texarr file.

• output (optional) – Path to output directory. Defaults: Same directory as source.

• options (optional) – User settings. Default: None.

Example

texarr_to_zip(“blockMap.texarr”, “path/to/output”)

nbt_to_json(source, output=None, options=None)

Converts data from NBT to .json format.

Parameters:

• source (str | PathLike[str] | Path) – Path to input NBT file.

• output (optional) – Path to output directory. Defaults: Same directory as source.

• options (optional) – User settings. Default: None.

Example

nbt_to_json(“itemnames.dat”, “path/to/output”)

Legacy

Implement functions to convert legacy mcsa format to another by simplest way.

mcsa_to_obj(source, output=None, options=None)

Converts model from .mcsa to .obj format.

Parameters:

• source (str | PathLike[str] | Path) – Path to input .mcsa file.

• output (optional) – Path to output directory. Defaults: Same directory as source.

• options (optional) – User settings. Default: None.

Example

mcsa_to_obj(“model.mcsa”, “path/to/output”, UserOptions(parse_skeleton=True))

mcsa_to_glb(source, output=None, options=None)

Converts model from .mcsa to .glb format.

Parameters:

• source (str | PathLike[str] | Path) – Path to input .mcsa file.

• output (optional) – Path to output directory. Defaults: Same directory as source.

• options (optional) – User settings. Default: None.

Example

mcsa_to_glb(“model.mcsa”, “path/to/output”, UserOptions(parse_skeleton=True))

mcsa_to_dae(source, output=None, options=None)

Converts model from .mcsa to .dae format.

Parameters:

• source (str | PathLike[str] | Path) – Path to input .mcsa file.

• output (optional) – Path to output directory. Defaults: Same directory as source.

• options (optional) – User settings. Default: None.

Example

mcsa_to_dae(“model.mcsa”, “path/to/output”, UserOptions(parse_skeleton=True))

mcsa_to_ms3d(source, output=None, options=None)

Converts model from .mcsa to .ms3d format.

Parameters:

• source (str | PathLike[str] | Path) – Path to input .mcsa file.

• output (optional) – Path to output directory. Defaults: Same directory as source.

• options (optional) – User settings. Default: None.

Example

mcsa_to_ms3d(“model.mcsa”, “path/to/output”, UserOptions(parse_skeleton=True))

Base

Basic implementation of converting one format to another.

convert(decoder, encoder, source, output=None, options=None)

Converts file between formats with basic validations.

Parameters:

• decoder (Type[FileDecoder[TypeVar(Content, bound= FileContent)]]) – Input file decoder class.

• encoder (Type[FileEncoder[TypeVar(Content, bound= FileContent)]]) – Output file encoder class.

• source (str | PathLike[str] | Path) – Path to input file.

• output (optional) – Path to output directory. Defaults: Same directory as source.

• options (optional) – User settings. Default: None.

Return type:

None

Example

convert(McsaDecoder, ObjEncoder, “model.mcsb”, “path/to/output”)

ensure_unique_path(path, suffix)

Generates unique file path by appending counter if path exists.

Return type:

Path

Factory

Internal factory decorator for convert functions.

converter(decoder, encoder)

Factory decorator for base convert function with fixed decoder/encoder.

Return type:

Callable