sdraw_mods_cvr/ml_amt/README.md
2023-01-05 00:15:29 +00:00

3.5 KiB

Avatar Motion Tweaker

This mod adds features for AAS animator and avatar locomotion behaviour.

Installation

Usage

Available mod's settings in Settings - IK - Avatar Motion Tweaker:

  • IK override while crouching: disables legs locomotion/autostep upon HMD reaching Crouch limit; default value - true.
  • Crouch limit: defines crouch limit; default value - 65.
    • Note: Can be overrided by avatar. For this avatar has to have child gameobject with name CrouchLimit, its Y-axis location will be used as limit, should be in range [0.0, 1.0].
  • IK override while proning: disables legs locomotion/autostep upon HMD reaching Prone limit; default value - true.
  • Prone limit: defines prone limit; default value - 30.
    • Note: Can be overrided by avatar. For this avatar has to have child gameobject with name ProneLimit, its Y-axis location will be used as limit, should be in range [0.0, 1.0].
  • IK override while flying: disables legs locomotion/autostep in fly mode; default value - true.
  • IK override while jumping: disables legs locomotion/autostep in jump; default value - true.
  • Follow hips on IK override: adjust avatar position to overcome animation snapping on IK override; default value - true.
    • Note: Works perfect with animations that have root transform position (XZ) based on center of mass.
    • Note: Made for four point tracking (head, hands, hips) in mind.
  • Pose transitions: allows regular avatars animator to transit in crouch/prone states; default value - true.
    • Note: Avatar is considered as regular if its AAS animator doesn't have Upright parameter.
  • Adjusted pose movement speed: scales movement speed upon crouching/proning; default value - true.
  • Detect animations emote tag: disables avatar's IK entirely if current animator state has Emote tag; default value - true.
  • Alternative avatar collider scale: applies slightly different approach to avatar collider size change; default value - true

Available additional parameters for AAS animator:

  • Upright: defines linear coefficient between current viewpoint height and avatar's viewpoint height; float, range - [0.0, 1.0].
    • Note: Can be set as local-only (not synced) if starts with # character.
    • Note: Defining this parameter in AAS animator will consider avatar as compatible with mod.
    • Note: Can't be used for transitions between poses in desktop mode. In desktop mode its value is driven by avatar animations. Use CVR Parameter Stream for detecting desktop/VR modes and change AAS animator transitions accordingly.
  • GroundedRaw: defines instant grounding state of player instead of delayed default parameter Grounded.
    • Note: Can be set as local-only (not synced) if starts with # character.
  • Moving: defines movement state of player
    • Note: Can be set as local-only (not synced) if starts with # character.

Additional avatars tweaks:

  • If avatar has child object with name LocomotionOffset its local position will be used for offsetting VRIK locomotion mass center.

Additional mod's behaviour:

  • Overrides FBT behaviour in 4PT mode (head, hands, hips). Be sure to disable legs and knees tracking in Settings - IK tab.