xc3_lib

Rust libraries and tools for working with rendering related file formats for Xenoblade Chronicles X, Xenoblade Chronicles 1 DE, Xenoblade Chronicles 2, and Xenoblade Chronicles 3.

Report any bugs or request new features in issues. Download precompiled binaries for the tools in releases. Python bindings for xc3_model are available with xc3_model_py. See the xenoblade rendering research website for information on topics related to in game rendering.

Formats

xc3_lib supports a number of in game formats. All formats support reading. Write support is still a WIP for some formats. Click on the links to open the corresponding Rust module in xc3_lib. Extensions starting with wi are for the Switch like wimdo or wismt. Extensions starting with pc are for PC builds like pcmdo or pcsmt. Extensions starting with ca are for the Wii U like camdo or casmt.

* Some files are not binary identical with the originals after saving.

Projects

See Architecture for a design overview of the various projects. Click on the docs.rs links below to see the generated rustdoc documentation.

Libraries

• - file format library
• - higher level API for xc3_lib
• - model and map renderer
• - binary writing and layout

Binaries

• xc3_gltf - convert models and maps to glTF
• xc3_test - test against files in an extracted dump
• xc3_tex - convert textures to and from common formats and replace textures in wilay and wimdo files
• xc3_viewer - simple model viewer for testing xc3_wgpu
• xc3_wgpu_batch - batch render models and maps to PNG

Usage

These projects are still highly unstable. When using the latest version from github, specify a specific git revision or commit the Cargo.lock file to source control. This locks the version and avoids any breaking changes. The debug or JSON output has not stabilized and should not be assumed to be the same between commits.

xc3_model = { git = "https://github.com/ScanMountGoat/xc3_lib", rev = "commit_hash" }
xc3_wgpu = { git = "https://github.com/ScanMountGoat/xc3_lib", rev = "commit_hash" }
xc3_lib = { git = "https://github.com/ScanMountGoat/xc3_lib", rev = "commit_hash" }

Building

After installing the Rust toolchain, run cargo build --release in the repository directory to build the tools to target/release. Running cargo build without the --release will result in faster compile times during development but dramatically worse runtime performance. The tools can also be run using cargo run --release -p <project> <args>. xc3_tex uses image_dds, which supports Windows x86, Linux x86, MacOS x86, and MacOS Apple Silicon due to using precompiled kernels for DDS encoding. Other projects should build on other platforms without issues.

Credits

This project is based on previous reverse engineering work, including work done for Xenoblade X and Xenoblade 2. Special thanks go to members of the World Tree Research discord (formerly the World of Alrest discord) for their assistance.

• Xenoblade Data Hub
• xc2f wiki
• Xenoblade-Switch-Model-Importer-Noesis
• fmt_xc3
• XbTool
• XenoLib
• SimpleDimple