Configuration - Character

Setting up your Character for MxM/Strider and MMLP behavior

1. First, create an empty game object in the scene to hold your player character. This top-level object will hold the character controller and our player controller script, as well as serving as the parent for the actual character model(s) and behaviors of the character.

2. Add your Character Model in as a child of that object. In the image below from the demo scene, we've named the top-level object PlayerMaskman and have dragged in Maskman_LODed2 from Movement Animset Pro.

   

3. Add the following components to the Top-level object PlayerMaskman in our example:

   1. CharacterController and NGCharacterControllerWrapper

   

   1. The settings in the above screenshot are optimal for Maskman_LODed2, but configure CharacterController::[Center, Radius, and Height] to match your character model.
   2. Set the Ground Layers that represent all the layers the system should consider as ground in the NGCharacterControllerWrapper component.

4. To the object with the Animator component on it (in our example, that's Maskman_LODed2), do the following:

   1. Add MxMAnimator component and configure like this screenshot:

      

      1. Animation Root Override must be set to the Top-level Object Transform (e.g. PlayerMaskman)

   2. Add Strider Biped MxM component and configure like this screenshot:

      

   3. Add NG Dispatch Animation Events component (handles firing footstep event handlers)

   4. Add MxM Root Motion Applicator component and configure like this screenshot:

      

      1. Controller Wrapper must be set to the Top-level Object's NG Character Controller Wrapper component.

   5. Add Locomotion Speed Ramp component and configure like this screenshot:

      

      1. Player Transform must be set to the Top-level Object Transform (e.g. PlayerMaskman)

   6. Add MxM Trajectory Generator component and configure like this screenshot:

      

      1. Cam Transform must be set to your Main Camera's transform in order to have directional inputs work properly (unless you want Tank controls)

5. Back on the Top-level object (e.g. PlayerMaskman):

   1. add NG Player Controller component and configure it like this screenshot:

      

      1. Assign all Component Refs to the appropriate object
      2. Use MxMInputProfile_LocomotionStrider and ..._SprintStrider for Input Profiles
      3. Set Config Jump to NGJumpSettings
      4. Set Config to NGParkourSettings_VaultsAndMantles (parkour config)
      5. If you've set up an Input Axis in the Input Manager for joystickLeftTrigger (to control sprint), you can check Use Joystick Axes, otherwise, uncheck it.

Footstep reaction (sounds and effects)

The high likelihood of using multiple Animators or systems to animate each character (and suggestions from MxM author) led this solution to utilize pure Unity Animation Events for footstep invocation. To use this, Put the NGDispatchAnimationEvents component on the object containing your character's Animator (same object as MxMAnimator). Add method handlers for right, left, and/or any footstep event based on your needs.

Configuration

While NGPlayerController and NGCharacterControllerWrapper have some basic and scene-specific configuration elements to control MMLocoParkour's behavior, the predominance of customization/configuration for this asset is provided by ScriptableObject configuration. This configuration is provided through NGParkourSettings and NGJumpSettings.

There are pre-configured settings Scriptable Objects in Assets/Plugins/Threepeat/MMLocoParkour/Configs/ that can be duplicated to make customized versions for your application. The process of creating them from scratch is covered in more detail in the next two sections.

Controlling Parkour Abilities (NGParkourSettings)

1. To create an NGParkourSettings object, right click in the Project view and select Create -> Threepeat -> NGParkourSettings. An example of a preconfigured settings object is below:

   

2. Capabilities List: This list defines the capabilities the character will have. Each capability in the list has the following parameters:

   • Event Type: The type of athletic action (e.g. vault, vault on, fence clear, mantle). Note: the list provided has several more options for event type that are not implemented in this version of MMLocoParkour.
   • Standing Event: The MxM event to be executed when engaging this action when character is standing or moving slowly.
   • Running Event: The MxM event to be executed when engaging this action when character is running.

3. Mantle Check Character Height Factor: this defines the highest ledge, as a multiple of the character's height, that the character can "reach" to mantle (aka climb onto).

Setting up Jump Behavior (NGJumpSettings)

1. To create an NGParkourSettings object, right click in the Project view and select Create -> Threepeat -> NGParkourSettings. An example of a preconfigured settings object is below:

   

2. Jump Force: upward force to be applied to character on a regular jump event

3. Jump Force Big: upward force to be applied to character on a big jump event

4. Jump_Event Def: MxM Event to fire for jumps

5. Landing_Event Def: MxM Event to fire whenever the player lands (impacts the ground after having not been grounded. this includes both post-jump conditions and any time the player walks, runs or falls off a ledge.)

6. Landing Heavy_Event Def: MxM Event to fire on hard landings (as defined by Landing_HeavySpeedThreshold) with low forward velocity or when ground path ahead of character is obstructed.

7. Landing Heavy Forward Clear_Event Def: MxM Event to fire on hard landings (as defined by Landing_HeavySpeedThreshold) with high forward velocity or when ground path ahead of character is clear.

8. Jump Big_Favour Tag: (leave this set to 22): Favour tag to use to achieve correct launch animation for big jumps.

9. Landing_Distance To Check For Clear Path Ahead: Distance ahead of player upon hard landing to check for obstruction to decide which event to fire (e.g. if there's room to do a landing forward roll, do that, otherwise do a more stationary or space-constrained landing animation.)

10. Landing_Heavy Speed Threshold: Ground Impact Speed to engage heavy landing logic. This is a negative number, since it represents a negative speed in the Y direction (fall speed at impact with ground).

11. Landing_Min Forward Speed For Landing Event: For normal landings, if speed is below this value, the player will just resume their idle or walking behavior upon landing instead of engaging the landing event. This makes the landing system more responsive/realistic for small jumps or falls.

12. Delay Gravity Time: Duration of time gravity re-enabling should be delayed after the landing event is complete.

Using Gamepad / Game Controller

1. Setup inputs for JoystickLeftTrigger (this will toggle sprint) in Project Settings -> Input Manager -> Axes :

   

   1. Note: JoystickRightTrigger would be the same just with 10th Axis (Joysticks) instead of 9th.

2. In the Main Player object's NGPlayerController component, toggle on Use Joystick Axes