Skip to content

Latest commit

 

History

History
155 lines (107 loc) · 9.48 KB

README.md

File metadata and controls

155 lines (107 loc) · 9.48 KB

ALSXT - ALS-Refactored XT

ALSXT

GitHub last commit GitHub issues GitHub pull requests MIT License Become a Sponsor Become a Patron

An Unreal Engine 5 plugin that extends ALS-Refactored with a set of popular replicated gameplay features, to demonstrate the extendability of ALS-Refactored in a Modular, Data-Driven, UE5 Way. The feature-set is informed by First and Third Person Tactical Shooters, Action Shooters and the parent project Target Vector.

ALSXT is under heavy development, many features may not be finished or production-ready.

Contibutors and PRs are welcome.

Introduction

Features

ALSXT

  • Expanded Character States (Combat Stance, Sex, Variant, Weapon Ready Position)
  • Sliding Locomotion Action (with Sound, Decal and Particle Support)
  • Expanded Footprints System (Independent foot states, Saturation, Material Transfer, Vertex Paint Support(Static Mesh only, In Progress))
  • Customization Component In Progress
  • Paintable Skeletal Mesh Component In Progress
  • Combat Component In Progress
  • Impact Reactions (Blending reaction animations with Physical Animation) In Progress
  • Character Sound Component_In Progress_
  • Idle Animation Component In Progress
  • Vaulting In Progress
  • Physical Animation In Progress
  • Sound Component In Progress
  • Idle Animation Component
  • Gesture In Progress
  • Emotes In Progress
  • Basic Stats Component (Stamina and Health to demonstate the functionality of various components)

ALSXT Advanced

  • Combat
  • ADS
  • Procedural Recoil
  • Reloading
  • Camera FX Component In Progress
  • Acrobatic Actions (Flipping, Wallrunning etc) In Progress

Planned Features

  • New Skeletal Mesh and Clothing set with Morph Targets/Shape Keys
  • Stationary Modes (Sitting etc)
  • Prone Stance
  • Ladder Climbing Custom Movement Mode

Dependencies

Important Note

ALSXT is not automatically synced with the main ALS-Refactored repository, but is instead maintained through this fork. If you find changes in ALS-Refactored have broken ALSXT you may use this fork to maintain more stability in your projects.

Installation

  • Begin with an empty C++ Project
  • Install and setup Enhanced Input Plugin
  • Install and setup MetaSound Plugin
  • Install the latest version of ALS-Refactored via https://github.com/Sixze/ALS-Refactored#quick-start
  • Clone/download ALSXT into your projects Plugin folder (You should have both ALS-Refactored and ALSXT side by side)
  • Build your Solution in Visual Studio again
  • Once compilation is successful you can now begin using ALSXT in your project

Settings

Most Settings are set in the ALSXT Character Settings Data Assets in the Character Blueprint. This is where you would customize animations, sounds, parameters and toggle features. Components are configured similarly. Components may have some general settings that are editable when clicking on the Component inside the Character Blueprint.

Contributions

I'm looking for help with implementing Root Motion for Vaulting, Wallrunning, Walljumping! Any advice regarding making actions more GAS-friendly would be welcome!

If you wish to contribute, please ensure you are in sync with ALSXT, message me and I'll set up permissions for you. While I try to stay in sync with ALS-Refactored, at times it may be temporarily out of sync and features may break or need refactoring. Please submit an issue for any Compile error fixes. Most are usually the result of ALSXT not being synced to ALS-R.

License

Original content and code in this repository is under the MIT license. Any git submodules are covered by their respective licenses. Content listed in the Attributions are covered by their respective licenses.

Attributions

Special Thanks

Sixze

Freesound

SketchFab

Mixamo