Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

All pages

Every page AnimSmith publishes, one row each — each page owns one job. The site's front door, which routes the two reader journeys and the ten-minute path, is at https://mmannerm.github.io/animsmith/.

The Category column names the documentation site's part and optional Part › Group, so this table and the site sidebar carry the same structure in the same order.

DocumentUse it to…Category
Why animsmithDecide whether animsmith fits your team — what it is, why it exists, and what it is worth by role. The canonical home of the positioning case.Start
What game-ready meansRead the staged readiness ladder — what "game-ready" is evidence for at each level, who owns that level, and what one lint run does and does not settle.Start
InstallGet the binary — prebuilt archive, cargo install, or the pure-Rust glTF-only build — and confirm it runs.Start
First lint in 60 secondsSee a finding, repair what is mechanically safe, and watch a declared contract catch a popped loop, on two committed sample clips.Start
Your first reportTurn findings into skeleton playback, charts and one shareable HTML file, including the before/after comparison and the evidence-only form.Start
Mixamo tutorialTake a real Mixamo download end-to-end — download, convert, inspect, lint, fix, and grow a contract config with the built-in mixamo rig profile.Start
Symptom indexStart from what you see in the engine and route it to the page, check, repair and config that address it.Symptoms
The pose flickers, spins, or explodesRepair the rotation representation itself: non-unit keys, hemisphere flips, non-finite values, and what fix restores losslessly.Symptoms
The clip is the wrong length or freezes at the endFind the channel that stopped early or the export range that drifted, and pin the duration and frame grid the clip owes you.Symptoms
The loop popsFix a looping clip that jumps or hitches at the wrap: what the seam checks measure, the before/after evidence, and the loop contract.Symptoms
The character glides or runs in placeSettle whether gameplay or the animation owns horizontal movement, and hold the clip's measured travel to that decision.Symptoms
Feet skate when clips blendHold a directional set to one stride phase and one timing surface, and know which member is out.Symptoms
Feet slide within a clipFix a planted foot that skates during stance: the sampled stance intervals, the declared speed, and who owns the repair.Symptoms
A limb is T-posed, or a bone never movesSeparate a bone that is absent from one that is keyed but frozen, and both from a clip authored against another bind.Symptoms
Files disagree about skeleton or clip identityKeep the exact (file, clip) identity of a pack instead of trusting a repeated display name, and decide what a retarget still owes you.Symptoms
The file is bloated, or the retargeter chokesDecide what is redundant exported data and what is authored scale, then remove only the part a transform can prove.Symptoms
For artists: from export to handoffTake an authored export from immutable source through evidence-backed candidate handoff, without treating a safe mechanical edit as artistic approval.Workflows
For game developers: from pack to engine gateTake a pack or collection from inventory through an exact engine profile and an engine-observed gate; includes the complete Bevy 0.19.0 path.Workflows
Declaring the contract: who writes whatSettle who owns each animsmith.toml surface — which parts an animator declares alone, which are the game's call, and where each value comes from — with one complete minimal config.Workflows
Pipeline scenario guidePlan a raw-to-game-ready asset process — marketplace intake, mocap cleanup, outsourced acceptance, CI gating, and artifact storage.Workflows
Unity 6000.3 profile guideConfigure the exact Unity Generic/Humanoid profiles, importer advice, root-motion choices, and scale boundary.Workflows › Engine profiles
Unreal Engine 5.8 profile guideMap FBX animation, Skeleton, frame, unit, root-motion, and scale concerns to AnimSmith evidence without inventing importer settings.Workflows › Engine profiles
Godot 4.7 profile guidePlan scene import, retargeting, animation slicing, root scale, and the current profile's explicit prediction boundary.Workflows › Engine profiles
Bevy 0.19.0 profile guideGenerate exact Animation{i} selector evidence and keep runtime loading, graph, target, and scale responsibilities explicit.Workflows › Engine profiles
glTF and generic runtime guideUse the engine-neutral contract for custom runtimes, glTF units, source identity, scale repair, and downstream validation.Workflows › Engine profiles
Examples cookbookDo the work, copy-paste style — gate exports in CI, repair a broken export, trim or re-anchor a clip, encode a project contract config, migrate FBX/Mixamo exports, embed the checks in Rust.Workflows
Static asset workflow guideDiagnose bounds and transform domains, preserve normal maps, bake supported static placement, attach explicit textures, and understand what still needs engine validation.Workflows › Advanced workflows
Scaling glTF safelyChoose whole-document unit conversion or rest/bind reparameterization, understand the exact-source rewrite/proof transaction, and interpret its support boundary.Workflows › Advanced workflows
Material texture recipesAttach explicit BaseColor, normal, metallic-roughness, and occlusion images during conversion with deterministic resizing and provenance evidence.Workflows › Advanced workflows
Multi-source character assemblyCombine an authoritative skinned base with exact takes and timeline windows from separate inputs, producing one deterministic GLB plus evidence.Workflows › Advanced workflows
Collection contract extensionsRead the contact-fragment, foot-cycle planner, and transition-family contracts, including strict manifest and contact-evidence bindings.Workflows › Advanced workflows
Configuration referenceComplete animsmith.toml tables, keys, defaults, precedence, validation, globs, rig profiles, and engine settings.More › Reference
Built-in check referenceLook up every registered built-in check: current IDs, default findings, prerequisites, config keys, gap semantics, and remediation boundaries.More › Reference
CLI referenceLook up a command, flag, or exit code.More › Reference
Machine-readable outputParse versioned --format json reports, glTF animation-addressability inventories, engine import advice, and producer evidence in a pipeline, validated by the JSON Schema under schemas/.More › Reference
Commercial-pack evaluation guideRead the maintained Mixamo and Protofactor technical-report/evidence pairs and separate their scoped findings from project acceptance.More › Pack evaluations
Animation-pack evaluation reportsReview evidence-backed marketplace-pack assessments and the reporting convention for constituent packs and collection-level cross-pack summaries.More › Pack evaluations
Embedding guideChoose library crates and integration boundaries, then follow the embedded gate flow with the runnable embed example.More › Rust integration
docs.rs API referencesLook up exact published Rust API contracts for animsmith-core, animsmith-gltf, animsmith-fbx, animsmith-engine, and animsmith-report.More › Rust integration
CONTRIBUTING.mdWork on animsmith itself — contribution flow.More › Project and contributing
DEVELOPMENT.mdSet up a checkout and run the local verification commands.More › Project and contributing
RELEASING.mdCut a release — the release-plz flow, the manual 0.1.0 bootstrap, and the published-doc-link policy.More › Project and contributing
SUPPORT.mdGet help or file a bug.More › Project and contributing
SECURITY.mdReport a vulnerability privately.More › Project and contributing
DESIGN.mdFollow the architecture, check-catalog rationale, and roadmap.More › Project and contributing
Scale proof calibrationReview the implementation-owned calibration sweep, provenance magnitudes, historical policy measurements, and reproducible command behind appendix-d-v6.More › Project and contributing
research/Read the dated research notes that inform the roadmap.More › Project and contributing
All pagesFind any page by the job it owns — this table, which is also where the site's navigation comes from.More