Flux Framework

Flux is a modular gameplay framework for Unity.

It started as a collection of systems that I found myself rebuilding in almost every project. Instead of copying the same code over and over, the goal became to create a clean foundation that could be reused, extended, and adapted to different games.

Flux doesn't try to replace Unity or force a specific architecture. It provides a small Core and a set of independent gameplay modules that can be used together or separately.

Features

• Modular architecture
• Service Registry
• Typed Event Bus
• Save System
• ScriptableObject-based configuration
• Independent gameplay modules
• Examples and documentation
• Editor debugging tools
• EditMode tests

Included Modules

Core

• Bootstrapper
• Module System
• Service Registry
• Event Bus
• Save System
• Configuration

Gameplay

• Movement
• Interaction
• Inventory
• Attributes
• Progression

Advanced

• Quests
• Dialogue
• Object Pool
• Audio
• AI Foundation
• Crafting

Quick Start

1. Add a FluxBootstrapper to your scene.
2. Create a FluxSettings asset.
3. Add the modules you want to use.
4. Assign the settings asset to the bootstrapper.
5. Press Play.

using Flux;

FluxContext context = FluxBootstrapper.Current;

IInventoryService inventory =
    context.Services.Resolve<IInventoryService>();

context.Events.Publish(new MyGameplayEvent());

Project Structure

FluxFramework/
├── Runtime/
├── Editor/
├── Examples/
├── Tests/
├── Documentation/
├── package.json
├── README.md
└── CHANGELOG.md

Documentation

Additional documentation can be found in the Documentation folder, including architecture, module development, API overview and usage examples.

Future

Flux is actively evolving. The focus is on keeping the framework lightweight, modular and easy to extend while gradually expanding the available gameplay systems.