# Documentation

## Horse and Rider Deformation system On top of running standard animations, horse comes with a advanced deformation system built within animation blueprint that transforms individual bones based on user input and camera rotation to achieve more realistic and responsive body movement.

Transforms nodes are located in the AnimGraph of the horse animation blueprint.

Rotation driving values are located within Animation Update Events section of the BP\_Horse\ These values are set to what we believe looks most natural. However it all can be adjusted for more or less intense deformation if that would suit your setup better.\ Current setup affects the Lowerback (area around back legs), spine and the head. Chest bone rotation is currently deprecated. It looks great on a wild horse without the saddle, however this particular bone rotation is too intense for most saddles resulting in mesh clipping. That being said, you may want to make use of it depending on your setup.

This package comes with an example BP\_Rider prefab with full interaction support. Rider character can mount and ride the horse as well as interact with the hat prop.

Just like the horse, Rider has a similar deformation system built into his animation blueprint to match his twisting and rotation to the likes of the horse. Rotation control values are located within BP\_Horse next to the horse rotation values.

BP\_Rider character prefab is built on the default Epic mannequins skeleton. Therefore the mannequin model can be swapped with any other mesh that is rigged to this skeleton. *** ## Universal IK correction for Riders Hands and Feet

Due to the nature of the twisting deformations of the moving horse, we are using IK corrections for rider's feet and hands so they would always match the location of Stirrups and saddle grip point. If a new saddle model were to be added, it would be very likely that its stirrups and hand rest point would be in a different location. If that's the case, it would be recommended to add a new IK profile for riders hands and feet.

IK locator components inside the BP\_Horse are used to drive the Riders IK system

Locator setup consist of Left and Right :\ IK\_Stirrups (feet corrections inside stirrups)\ IK\_Knee ( IK offset correction for knee's to ensure that they never clip into the saddle) IK\_Hand ( IK offset correction for riders hands, normally used to match the saddle straps)\ IK\_Hand\_Sprint ( IK Offset location for hands when rider is hunched during Gallop animation)

Depending on what kind of saddle we use, we load a Update Hand IK profile function which essentially locks these Locators in their ideal position to ensure no clipping occurs.

And we do the same thing for feet (IK\_Stirrups) and Knees (IK\_Knee)

To add more profiles, you would need to add additional entries to Enum\_HandIK\_Variant and set up a similar offset profile for the feet and knees. *** ## Custom Footstep SFX based on surface material Each time horses leg collides with the surface it does a line trace downwards, ascertains physical material properties from the impact surface and plays appropriate sound effect.

Normally this sort of setup would just use Surface type parameter built directly into the materials and decide what SFX to play, however due to the nature of new marketplace guidelines, marketplace packs can no longer contain any data which would go into config folder and defaultengine.ini which is where these are stored.

As a direct workaround, our implementation uses only the SurfaceType\_Default physcal surface, and instead extrapolates variants from the value of the friction parameter

As such each type of physical material type has a static friction value which is used to identify that material during the footstep trace event and play appropriate SFX. Friction values used - Concrete \[1], Dirt \[2], Grass \[3] and Water \[4]. If your project requires the usage of friction on physical materials, then it would be highly recommended to unhook this logic from the Foot SFX trace function inside BP\_Horse and replace it with standard physic surface types stored within defaultengine.ini to determine the appropriate sound effect. *** ## Water Detection and Swimming mode

Our horse system is built with a custom swimming mode. One of the Demonstration levels has the example setup with the water asset from official Epic Games Water plugin. BP\_Horse is built with a trace function which scans if the horse is submerged in water and automatically switches it into swimming mode or back to walking mode when no longer in water.

That being said, depending on your specific needs - using the water plugin may not be an option. In which case we have a BP\_Swimzone blueprint, which can be used to tell the horse which areas of the level are intended to be water zones so the horse would switch into swimming mode when walking over them. Blueprint itself is lightweight and can be duplicated and scaled to cover desired swimming area. For ideal results, blue preview mesh \[water level] should be matched to the surface of your custom water area. *** ## Advanced Saddle customization

Both stylized and realistic versions of the horse have an optional saddle mesh, however only realistic horse version can use Advanced saddle which can be customized.

We exposed some presets which can be selected through BP\_Horse when placed directlly in a level, however these presets are few and just serve as an example selection of some of available saddle materials.

There are various fabric and leather textures and materials available for each individual part of the advanced saddle which can be used to assemble many different variants. For additional customization we've also included custom materials which let you pick your own color tint.

For advanced customization, open BP\_AdvancedSaddle and from there you can modify attachments placement, their individual materials and remove / add more props. *** ## Enhanced Input and Controller Support This package is using enhanced input system which is a new default input method since UE 5.1.0 and mandatory for all marketplace packages going forward.

ATTENTION : In earlier engine versions than 5.1.0 you need to enable Enhanced input plugin manually and set Default Player input class and Input component class into enhanced input.

Current setup fully supports Keyboard + Mouse and Xbox Controllers.\ When it comes to PlayStation controllers it gets a little more tricky. There is no way to officially support PlayStation controllers without official Dual Shock plugin which can only be used by developers verified by Sony. That being said, our package is using Windows Raw Input plugin and can read the input from PS controllers. However it cannot differentiate from PS4 and PS5 controllers and thus can only support one or the other at any given time.

By default, this package is set up to recognize PS4 controllers input. If you want it to be compatible with PS5 controllers instead, you need swap InputMappingsPS4 profile with InputMappingsPS5 on the nodes highlighted in the picture above for both BP\_Horse and BP\_Rider

## 5.6 Update (New docs below) ## 1) Optional Camera Settings *** Optional camera settings have been added and exposed with Unreal engine 5.6 version update

These settings can be found under "user settings" tab within BP\_Horse

**Default Camera Setting** is the original camera control where both mouse and keyboard steers the horse and controls the camera simultaneously. \ **Optional Camera Setting (v2)** disconnects horse rotation from the mouse and only leaves the keyboard, allowing the mouse to rotate the camera independently of the horse. \ **Optional Camera distance** works only with the Optional camera setting and enables the user to set a custom camera distance. \ **Camera Sensitivity** works for both camera settings.