ModularGameplayActors

Overview

ModularGameplayActors contains base classes designed to be used with the Modular Gameplay plugin

Installation

You can download these sources directly and put them in your project's Plugins folder Or you can add the plugin as a submodule git submodule add git@github.com:FishingCactus/UEModularGameplayActors Plugins/ModularGameplayActors

Dependencies

• ModularGameplay

Quick Start

Basic Setup

1. Enable the Plugin

   • Navigate to Edit → Plugins
   • Search for "ModularGameplayActors" and check the enabled box
   • Restart the editor

2. Register the framework component manager init states

   • In your game instance, in the Init function, add the following code:

    auto * ComponentManager = GetSubsystem< UGameFrameworkComponentManager >( this );
   
    if ( ensure( ComponentManager ) )
    {
      ComponentManager->RegisterInitState( ModularGameplayTag_InitState_Spawned, false, FGameplayTag() );
      ComponentManager->RegisterInitState( ModularGameplayTag_InitState_DataAvailable, false, ModularGameplayTag_InitState_Spawned );
      ComponentManager->RegisterInitState( ModularGameplayTag_InitState_DataInitialized, false, ModularGameplayTag_InitState_DataAvailable );
      ComponentManager->RegisterInitState( ModularGameplayTag_InitState_GameplayReady, false, ModularGameplayTag_InitState_DataInitialized );
    }
   

Contributing

We welcome contributions! Please see our Contributing Guide for details.

Development Setup

1. Fork this repository
2. Create a feature branch: git checkout -b feature/amazing-feature
3. Clone to your UE project's Plugins folder
4. Make your changes and test thoroughly
5. Submit a pull request

Coding Standards

• Follow Unreal Engine Coding Standards
• Use clear, descriptive variable and function names
• Comment complex algorithms and public APIs

Support

Getting Help

• Documentation: Full documentation

Reporting Issues

Please report bugs and feature requests through GitHub Issues.

When reporting issues, please include:

• Unreal Engine version
• Plugin version
• Platform (Windows/Mac/Linux)
• Steps to reproduce
• Expected vs actual behavior
• Relevant log files

FAQ

Q: Can I use this in commercial projects? A: Yes! See the LICENSE file for details.

Q: How do I update the plugin? A: Download the new version and replace the plugin files, then recompile your project.

Changelog

See CHANGELOG.md for complete version history.

License

This project is licensed under the MIT License - see the LICENSE file for details.

---

Made with ❤️ for the Unreal Engine community

If this plugin helped you, consider giving it a ⭐ on GitHub!