DOCS // meshfx

meshfx inputs and outputs Available

meshfx reads glTF, GLB, OBJ, STL and PLY, with PNG and JPEG textures. It writes GLB files for Godot 4 and preview images.

Contents4 sections
  1. Input files
  2. Files written
  3. Check each level
  4. Questions

meshfx runs on the hosted API: try it in the Playground.

Input files

The source model is beside or beneath the spec. PNG and JPEG textures are supported. For a skinned glTF model, set source.skin = "keep" to carry joint weights and animation through the LODs. For a sand3d assembly, use source.hierarchy = "tree" to keep each rigid part on its pivot. See errors and exit codes.

Files written

Articulated assemblies also include a sorted joint table in layout.json, an articulated preview and a Godot scene with articulated.gd.

  • preview_contact_sheet.png
  • preview_uv.png
  • preview_turntable.png
  • preview_thumb.png
  • godot/crate.glb
  • godot/layout.json

Check each level

The report records input hashes, the requested settings and each level's measured distance and faults. Levels may not add a hole. Folds and crossing triangles are counted and can be forbidden through simplify.forbid.

The whole report of crate (0 warnings, 0 errors)

Download the full JSON report, including every metric, warning and error. Local paths are reduced to file names.

Questions

Where should the source model be placed for a meshfx spec?

Place the source model file beside or beneath the spec file, with PNG or JPEG textures if needed.

What extra files does meshfx write for articulated assemblies?

Articulated assemblies include a sorted joint table in layout.json, an articulated preview image and a Godot scene with articulated.gd.

How can you check for faults after a meshfx compile?

Inspect the JSON report, which records input hashes, requested settings and each level's measured distance, folds, crossing triangles and faults.