# FocalRig

> FocalRig is a performant procedural animation toolkit for Unreal Engine, built as a library of self-configuring Control Rig nodes for precise aiming, true first person, weapon handling, recoil, eye motion, and related character animation.

The human documentation entry point at https://focalrig.com/docs is a client-side Docsify application. Docsify loads Markdown and renders it as HTML in the browser. For direct access, agents should use the raw Markdown URLs listed below instead of relying on the Docsify shell.

The default documentation page is https://focalrig.com/README.md. A Docsify route such as `https://focalrig.com/docs#/aim-chain` corresponds to `https://focalrig.com/aim-chain.md`. The landing page has a semantic Markdown counterpart at https://focalrig.com/index.md. Images, video posters, and video files referenced by these documents are available under https://focalrig.com/_media/. Videos may be available in AV1, HEVC, and H.264 variants. The comprehensive public URL inventory is https://focalrig.com/sitemap.xml.

## Overview

- [FocalRig landing page](https://focalrig.com/index.md): Product positioning, major features, performance claims, links, and showcase media.
- [Documentation home and quick start](https://focalrig.com/README.md): Product overview, installation, initial Control Rig setup, demo, and support information.
- [Tutorials](https://focalrig.com/tutorials.md): Step-by-step video tutorials for setting up and using FocalRig.
- [Quick Setups](https://focalrig.com/quick-setups.md): How FocalRig detects rig hierarchies and generates node presets.

## Complete setups

- [Third-Person Setup](https://focalrig.com/third-person-setup.md): Complete procedural look and aim setup for player characters and NPCs.
- [First-Person Setup](https://focalrig.com/first-person-setup.md): Complete full-body first-person setup where the camera drives the character pose.

## Aim nodes

- [Clamp Aim Target](https://focalrig.com/clamp-aim-target.md): Clamp a target to a character's valid pitch and yaw range.
- [Aim Chain](https://focalrig.com/aim-chain.md): Rotate a pelvis, spine, neck, or similar chain so a child element aims at a target.
- [Aim Weapon](https://focalrig.com/aim-weapon.md): Aim a weapon muzzle and adjust the supporting arms.
- [Aim Eyes](https://focalrig.com/aim-eyes.md): Aim eye elements with optional procedural saccades and cross-eye prevention.

## First-person nodes

- [First Person Camera Control](https://focalrig.com/first-person-camera-control.md): Apply translation smoothing, head bob, idle sway, landing dip, and world collision to a camera transform.
- [First Person Aim Target](https://focalrig.com/first-person-aim-target.md): Produce an aim target by tracing from the first-person camera.
- [First Person View](https://focalrig.com/first-person-view.md): Move a character chain so its camera element matches a desired camera transform.

## Spray and recoil

- [Spray](https://focalrig.com/spray.md): Configure authored spray patterns or cumulative burst recoil.
- [Apply Spray To Target](https://focalrig.com/apply-spray-to-target.md): Apply the current spray offset to an aim target before downstream aim nodes solve.
- [Apply Spray To Camera](https://focalrig.com/apply-spray-to-camera.md): Apply the current spray offset as visible camera kick.

## Rig helpers

- [Adjust Three Bone Chain](https://focalrig.com/adjust-three-bone-chain.md): Adjust a three-bone limb with FK while preserving lengths and its bend plane.
- [Preserve Limb Placement](https://focalrig.com/preserve-limb-placement.md): Restore selected hands or feet after another part of the rig changes the pose.
- [Preserve Item Placement](https://focalrig.com/preserve-item-placement.md): Restore a bone, control, or prop after another part of the rig changes the pose.
- [Smooth Toggle](https://focalrig.com/smooth-toggle.md): Smoothly interpolate a boolean state for blending procedural nodes.
- [Spring Interp Quaternion Clamped](https://focalrig.com/spring-interp-quaternion-clamped.md): Spring-interpolate a quaternion while keeping the full interpolation path within rotation limits.

## Shared settings and reference

- [Aim Element](https://focalrig.com/aim-element.md): Shared element and forward-axis settings used by aim nodes.
- [Limb Adjustment](https://focalrig.com/limb-adjustment.md): Shared limb preservation settings.
- [Three Bone Chain](https://focalrig.com/three-bone-chain.md): Shared limb definition, stretch, and twist settings.
- [Rotation Clamping](https://focalrig.com/rotation-clamping.md): Shared rotation limit settings.
- [Smoothing](https://focalrig.com/smoothing.md): Shared spring-smoothing behavior.
- [Bob](https://focalrig.com/bob.md): Shared stride-driven camera and weapon bob settings.
- [Idle Sway](https://focalrig.com/idle-sway.md): Shared camera and weapon idle-sway settings.
- [Landing Dip](https://focalrig.com/landing-dip.md): Shared camera and weapon landing-impact settings.
- [Get Focal Point Of Pawn](https://focalrig.com/get-focal-point-of-pawn.md): Get a world-space point for a player, AI, or preview pawn to look or aim at.
- [Get Pawn View Transform](https://focalrig.com/get-pawn-view-transform.md): Get the appropriate view transform for a player, AI, or preview pawn.
- [Sync Control Rotation To Player View](https://focalrig.com/sync-control-rotation-to-player-view.md): Match pawn control rotation to the current camera pitch and yaw.

## Project information

- [Changelog](https://focalrig.com/changelog.md): Release history and feature changes.
- [FocalRig on Fab](https://focalrig.com/fab): Product listing.
- [Windows demo](https://focalrig.com/demo): Download the executable demo build.
- [Discord](https://focalrig.com/discord): Community and support server.