/ALS-Refactored

Completely reworked and improved version of the Community Version of Advanced Locomotion System V4.

Primary LanguageC++MIT LicenseMIT

Advanced Locomotion System Refactored

Completely reworked and improved С++ version of Advanced Locomotion System V4.

The main goal of this ALS version is a complete and high-quality refactoring of all aspects of the plugin to make it easier to understand, flexible, reliable (especially in network multiplayer), performant, and simply more enjoyable to work with.

Features
  • Reworked plugin structure. Content is separated into 3 categories: ALS - main content, ALSCamera - camera-related content, and ALSExtras - other optional content
  • Use of multiple linked animation blueprints instead of a single monolithic animation blueprint.
  • Use of animation layer interfaces to dynamically switch overlay states at runtime instead of directly referencing them in animation blueprints.
  • Use of the Control Rig plugin for IK and other bone manipulation tasks instead of animation graph nodes.
  • Significantly reduced the number of virtual bones required by the plugin.
  • Added the ability to disable the use of IK bones and use only virtual bones for all bone manipulation tasks, which can be useful in cases where IK bones are not animated in your custom animations.
  • Added a skeleton asset action that can help set up all the necessary skeleton stuff: animation curves, slots, virtual bones, etc. It can be accessed by right-clicking on the skeleton asset -> Scripted Asset Actions -> Setup Als Skeleton.
  • Reworked foot locking to make it more performant and reliable, especially in network multiplayer.
  • Reworked foot and pelvis offset logic for smoother movement of the character on stairs and sloped surfaces.
  • Added Slot overlay animation curves to control the blending of overlay poses with animation montages played in Layering animation slots.
  • Added Blend Curves and Blend Poses by Gameplay Tag animation graph nodes. Blend Curves blends animation curves without the need for the VB curves virtual bone, and Blend Poses by Gameplay Tag is similar to Blend Poses by Enum but uses gameplay tags instead of enum.
  • Moved thread-safe animation instance logic to the worker thread to improve game thread performance.
  • Added automatic generation of foot sync markers using B_Als_AnimationModifier_FootSyncMarkers.
  • Replaced C++ enums such as EAlsOverlayMode with gameplay tags, allowing new entries to be added without code modification.
  • Reworked UAlsCharacterMovementComponent for better movement synchronization over the network.
  • Added support for direction-dependent movement speed.
  • Reworked mantling. Implemented as root motion source for better movement synchronization over the network.
  • Reworked camera. Implemented as a component similar to the standard camera component, no need for custom APlayerCameraManager or APlayerController classes.
  • Reworked debug mode. Toggled by pressing Shift + [1-8] or using console commands such as ShowDebug ALS.Curves.
  • Use of Push Model and support of Iris replication system.
  • Use of the MetaSounds and Enhanced Input plugins.
  • Support of Update Rate Optimization (disabled by default) and Large World Coordinates.
  • A lot of other fixes, improvements and refactorings.

For more information, see the Releases. Reading the changelogs is a good way to keep up to date with the newest features of a plugin.

Supported Unreal Engine Versions & Platforms

Plugin Version Unreal Engine Version
4.14 5.4
4.13 5.3
4.12 5.2
4.11 5.1
4.10 - 4.9 5.0
4.8 and below 4.26, 4.27 and 5.0 Early Access

The plugin is developed and tested primarily on Windows, so use it on other platforms at your own risk.

Quick Start

  1. Clone the repository to your project's Plugins folder, or download the latest release and extract it to your project's Plugins folder.
  2. Merge the DefaultEngine.ini and DefaultInput.ini files from the plugin's Config folder with files from your project's Config folder.
  3. Recompile your project.

Known Issues & Discussion

  • See the Issues page for list of known issues.
  • See the Discussions page to discuss anything about the plugin and ask questions. Please do not open an issue for questions.

License & Contribution

ALS Refactored is licensed under the MIT License, see LICENSE.md for more information. Other developers are encouraged to fork the repository, open issues & pull requests to help the development.