https://github.com/gamesmiths-guild/forge

Unreal GAS-like gameplay framework for C# (engine-agnostic).
https://github.com/gamesmiths-guild/forge

abilities attributes csharp dotnet engine-agnostic gameplay-ability-system gameplay-framework status-effects

Last synced: about 2 months ago
JSON representation

Unreal GAS-like gameplay framework for C# (engine-agnostic).

• Host: GitHub
• URL: https://github.com/gamesmiths-guild/forge
• Owner: gamesmiths-guild
• License: mit
• Created: 2024-09-21T02:16:24.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2026-03-29T01:49:59.000Z (3 months ago)
• Last Synced: 2026-03-29T04:32:22.511Z (3 months ago)
• Topics: abilities, attributes, csharp, dotnet, engine-agnostic, gameplay-ability-system, gameplay-framework, status-effects
• Language: C#
• Homepage:
• Size: 919 KB
• Stars: 18
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# Forge Gameplay System

[![CI](https://github.com/gamesmiths-guild/forge/actions/workflows/validate-project.yml/badge.svg)](https://github.com/gamesmiths-guild/forge/actions/workflows/validate-project.yml)

[![NuGet](https://img.shields.io/nuget/v/Gamesmiths.Forge.svg)](https://www.nuget.org/packages/Gamesmiths.Forge)

[![License](https://img.shields.io/github/license/gamesmiths-guild/forge)](LICENSE)

An Unreal GAS-like gameplay framework for developing games in C#.

Forge is an engine-agnostic gameplay framework designed for building robust game systems in C#. Inspired by Unreal Engine's Gameplay Ability System (GAS), Forge provides a centralized and controlled approach to managing attributes, effects, tags, abilities, events, and cues in your games.

Forge is an engine-agnostic, data-driven system inspired by Unreal Engine’s Gameplay Ability System (GAS), designed to manage attributes, effects, abilities, tags, events, and cues in a structured way.

The framework eliminates the need to rebuild status systems for every game project by offering a flexible, data-driven architecture that works seamlessly with Unity, Godot, and other C#-compatible engines. With Forge, all attribute changes are handled through effects, ensuring organized and maintainable code even in complex gameplay scenarios.

**Keywords:** gameplay framework, C#, engine-agnostic, data-driven, attributes, gameplay effects, abilities, gameplay tags

## Quick Start

New to Forge? Check out the [Quick Start Guide](docs/quick-start.md) to build your first Forge-powered entity in minutes.

## Architecture Overview

Forge is built around core systems that work together to provide comprehensive gameplay functionality:

### Core Systems

- **[Attributes](docs/attributes.md)**: Centralized attribute management with min/max values, channels, and controlled modifications.

- **[Effects](docs/effects/README.md)**: Data-driven system for applying temporary or permanent changes to entities.

- **[Tags](docs/tags.md)**: Hierarchical tagging system for entity classification and effect targeting.

- **[Abilities](docs/abilities.md)**: Creation, granting, activation, cooldowns, costs, and instancing rules for gameplay abilities.

- **[Events](docs/events.md)**: Gameplay event handling and propagation used for ability triggers and game logic reactions.

- **[Cues](docs/cues.md)**: Visual and audio feedback system that bridges gameplay with presentation.

- **[Statescript](docs/statescript/README.md)**: State-based scripting system for defining ability behaviors through node graphs.

### Entity Integration

Every game object that uses Forge implements the `IForgeEntity` interface, providing:

- `EntityAttributes` - Manages all attributes and attribute sets.

- `EntityTags` - Handles base and modifier tags with automatic inheritance.

- `EffectsManager` - Controls effect application, stacking, and lifecycle.

- `EntityAbilities` - Grants and activates abilities, handles cooldowns/costs, and manages instancing.

- `EventManager` - Dispatches and listens to gameplay events for triggers and reactions.

- `SharedVariables` - Entity-level variable bag for cross-ability communication through Statescript graphs.

### Advanced Features

Forge supports a variety of gameplay mechanics through specialized subsystems:

- **[Effect Duration](docs/effects/duration.md)**: Control how long effects remain active.

- **[Effect Stacking](docs/effects/stacking.md)**: Configure how multiple instances of effects combine.

- **[Periodic Effects](docs/effects/periodic.md)**: Create effects that execute repeatedly on a schedule.

- **[Modifiers](docs/effects/modifiers.md)**: Define how effects change attribute values.

- **[Effect Components](docs/effects/components.md)**: Extend effects with custom behaviors.

- **[Custom Calculators](docs/effects/calculators.md)**: Flexible logic execution within the effects pipeline.

## Project Status

⚠️ **Work in Progress** - This project is currently under active development and not ready for production use.

### Current Features ✅

- **Tags System**: Complete hierarchical tag system with inheritance.

- **Attributes System**: Full attribute management with modifiers and overrides.

- **Effects System**: Comprehensive effect application with stacking support.

- **Cues System**: Visual feedback system for effect application/removal.

- **Custom Calculators**: Flexible logic execution for effects.

- **Abilities System**: Ability granting, activation, instancing, costs, cooldowns, and tag-based requirements.

- **Events System**: Gameplay event handling, tagging, and trigger support.

- **Statescript**: State-based scripting system for defining ability behaviors through node graphs.

### Planned Features 🚧

- **Multiplayer Support**: Network replication for all systems.

- **More Built-in Content**: More built-in components, nodes and resolvers.

## Installation

### Requirements

Forge targets:

- .NET Standard 2.1 (for broad compatibility)

- .NET 8 (for modern features)

Install via NuGet, reference the Forge project directly, or download the precompiled `.dll` from the Releases page.

### NuGet (Recommended)

Install the package via .NET CLI:

```shell

dotnet add package Gamesmiths.Forge

```

Or search for `Gamesmiths.Forge` in the NuGet Package Manager UI in Visual Studio.

### Manual Installation

If you need to build from source or make local changes:

1. Clone this repository.

2. Reference the Forge project in your solution.

3. Follow the [Quick Start Guide](docs/quick-start.md).

## Documentation

For comprehensive documentation, explore the [docs](docs) directory, starting with the [documentation overview](docs/README.md).

## Contributing

This project is not currently accepting contributions as it's still in early development. However, if you're interested in contributing or have suggestions, feel free to reach out via GitHub issues or discussions.

## License

Copyright © Gamesmiths Guild. See [LICENSE](LICENSE) for details.