> For the complete documentation index, see [llms.txt](https://roogame.gitbook.io/roogame/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://roogame.gitbook.io/roogame/roo-gameplay-framework.md).

# Roo Gameplay Framework

Roo Gameplay Framework is a modular C++ and Blueprint framework for building data-driven gameplay systems in Unreal Engine 5. It provides a shared foundation for stats, attributes, formulas, progression, stat actions, status effects, inventory, equipment, runtime UI, and editor workflows.

[**Purchase on Fab**](https://www.fab.com/listings/12888893-e540-4785-a1a0-586931539fc7)

## Verified Engine Versions

The initial release has been built and validated on Unreal Engine 5.5, 5.6, 5.7, and 5.8 for Win64. Use the plugin package that matches your project's engine version.

The framework is designed so gameplay designers can configure most content with Gameplay Tags and Data Assets, while programmers retain clear C++ and Blueprint APIs for runtime integration.

<figure><img src="https://2218703886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4YPyrdOyfjDGtlxlvjSd%2Fuploads%2FA5U8n9ndMsHrk2TyDe4F%2FBlueprintDemo_Promo.png?alt=media&#x26;token=03bf22e6-5b1a-4b7c-aaee-72c531e667c2" alt=""><figcaption></figcaption></figure>

## Start Here

* Installation and Setup
* Quick Start
* Demo Overview
* Blueprint Reference
* Troubleshooting and Limitations

## Documentation

* [Getting Started](/roogame/roo-gameplay-framework/getting-started.md)
* [Core Concepts](/roogame/roo-gameplay-framework/core-concepts.md)
* [Stats System](/roogame/roo-gameplay-framework/stats-system.md)
* [Status Effects](/roogame/roo-gameplay-framework/status-effects.md)
* [Inventory and Equipment](/roogame/roo-gameplay-framework/inventory-and-equipment.md)
* [Editor Tools](/roogame/roo-gameplay-framework/editor-tools.md)
* [API or Blueprint Reference](/roogame/roo-gameplay-framework/api-or-blueprint-reference.md)
* [Troubleshooting and Limitations](/roogame/roo-gameplay-framework/troubleshooting-and-limitations.md)
* [Changelog](/roogame/roo-gameplay-framework/changelog.md)

## Included Systems

* Stats with base values, formulas, progression tables, and runtime modifiers
* Attributes with current, minimum, maximum, and normalized values
* Gameplay Tag based lookup and organization
* Reusable stat actions for damage, healing, resource changes, and other operations
* Status effects with duration, periodic execution, stacking, refresh, and display queries
* Inventory storage, movement, equipment, modifiers, and Blueprint-ready events
* Base UMG widgets for inventory and equipment interfaces
* Stats Designer, Setup panel, factories, thumbnails, and custom asset editors
* A Blueprint-focused demo that demonstrates the systems working together

## Design Philosophy

The framework separates authored configuration from runtime state. Data Assets describe what a stat, item, formula, action, or status effect should do. Components own the live values for each actor. Gameplay Tags provide stable identities across assets, Blueprints, UI, and C++.

This keeps gameplay content reusable and avoids coupling a system to a particular character class or interface.

## AI-Friendly

Whenever you want to create a new feature or learn how an existing system works, you can provide the AI with a link to the relevant documentation page. This allows the AI to quickly understand the framework’s structure, APIs, and recommended workflows, and then guide you through the implementation process.

For example, you can ask an AI tool to help you with:

* Creating and configuring Buffs
* Implementing attack damage calculations
* Implementing critical hit calculations
* Setting up equipment and item attributes
* Connecting Stats, Buffs, Inventory, and Equipment systems
* Troubleshooting Blueprint logic or configuration issues

For better results, include the relevant documentation link in your prompt and clearly describe what you want to build.

Example prompt:

> I am using Roo Gameplay Framework. Please read the following documentation and help me create a Buff that increases Attack Power by 20% for 10 seconds:\
> [\[Documentation URL\]](https://roogame.gitbook.io/roogame)

By providing the documentation, the AI can understand the framework more accurately and generate instructions that are consistent with its actual design.