# FocalRig

FocalRig is a performant procedural animation toolkit for Unreal Engine, built as a library of [self-configuring](quick-setups.md) [Control Rig](https://dev.epicgames.com/documentation/en-us/unreal-engine/control-rig-in-unreal-engine) nodes.

FocalRig makes it easy to:

- Replace or layer on top of aim offsets with [pixel-perfect procedural look](aim-chain.md) and [aim](aim-weapon.md).
- Build [third-person characters](third-person-setup.md) with procedural look, aim, and foot IK.
- Build [true first-person player characters](first-person-setup.md) with foot IK, head bob, idle sway, landing dip, and world collision.
- Add [weapon handling](aim-weapon.md) from just one hold pose. Precise muzzle aiming, ADS, recoil kick, moving bob, idle sway, landing dip, and aim lock.
- Make [animations aim in any direction](preserve-limb-placement.md) (e.g., reload, attack, etc).
- Make [eyes look at things](aim-eyes.md) with eye darts and cross-eye prevention.
- Add [spray patterns](spray.md) to weapons or the camera using a spray pattern editor or configure cumulative recoil.

<div class="embed-responsive embed-responsive-16by9 docs-home-video">
		<iframe
				src="https://www.youtube-nocookie.com/embed/Zg6EzUp1Pd4?rel=0&modestbranding=1&playsinline=1"
				title="FocalRig full showcase"
				loading="lazy"
				referrerpolicy="strict-origin-when-cross-origin"
				allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
				allowfullscreen>
		</iframe>
</div>

## Try the Demo

Download the [Windows demo build](https://focalrig.com/demo)* to evaluate FocalRig in action.

<small>*The demo uses several [Paragon characters](https://www.fab.com/sellers/Epic%20Games) to showcase the plugin's features and includes a 100-character performance benchmark scene. These are not part of the plugin and are shown for demonstration purposes only. The demo is an executable build only, not an example project that can be opened in Unreal Editor.</small>

## Quick Start

### 1. Install the Plugin

1. Purchase and install FocalRig from [Fab](https://focalrig.com/fab).
2. Enable it in **Edit → Plugins**.
3. Restart the editor.

### 2. Create a Control Rig

![Create a Control Rig walkthrough](_media/quick-start-create-control-rig.mp4 ':include :type=video controls preload=metadata playsinline')

1. In the Content Browser, right-click and select **Animation → Control Rig**
2. Give the new Control Rig asset a name and open it
3. In the Rig Hierarchy panel, click **Import Hierarchy** and select the skeletal mesh of your character.

### 3. Connect It to an Animation Blueprint

To use your Control Rig at runtime, connect it to the character's **Animation Blueprint**:

![Animation Blueprint hookup walkthrough](_media/quick-start-animation-blueprint.mp4 ':include :type=video controls preload=metadata playsinline')

1. Open the character's [Animation Blueprint](https://dev.epicgames.com/documentation/en-us/unreal-engine/animation-blueprints-in-unreal-engine) (or create one)
2. In the Anim Graph, add a **Control Rig** node
3. Set its **Control Rig Class** to the Control Rig asset you created
4. Wire the Control Rig node into the animation graph after your existing animation logic (typically towards the end of the graph, before the final pose output)

### 4. Choose a Setup

- [Third-Person Setup](third-person-setup.md) for NPCs and third-person player characters.
- [First-Person Setup](first-person-setup.md) for first-person full-body avatars.

## Support

If you have questions, suggestions, or run into issues, feel free to reach out:

- Email: [support@focalrig.com](mailto:support@focalrig.com)
- Discord: [focalrig.com/discord](https://focalrig.com/discord)
