> ## Documentation Index
> Fetch the complete documentation index at: https://docs.engagefabric.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Discover EngageFabric, the multi-tenant gamification framework. Add XP, levels, quests, leaderboards, and achievements to any app with our REST API.

![EngageFabric Admin Dashboard](https://mintcdn.com/none-01b345a3/WFBnX5u36dbsHuKA/images/admin-dashboard-preview.png?fit=max\&auto=format\&n=WFBnX5u36dbsHuKA\&q=85\&s=776c0ff0d121d7acaf098ff573580a80)

## What is EngageFabric?

EngageFabric is a **multi-tenant SaaS gamification framework** that helps you add engaging game mechanics to your applications. Whether you're building a learning platform, e-commerce site, fitness app, or any product that benefits from user engagement, EngageFabric provides the infrastructure you need.

> [card] [Quick Start](https://docs.engagefabric.com/quickstart.md)
>
> Get up and running with EngageFabric in under 5 minutes

> [card] [API Reference](https://docs.engagefabric.com/api-reference/overview.md)
>
> Explore our comprehensive REST API documentation

> [card] [JavaScript SDK](https://docs.engagefabric.com/sdks/javascript.md)
>
> Integrate EngageFabric into your web application

> [card] [React Components](https://docs.engagefabric.com/sdks/react.md)
>
> Pre-built UI components for React applications

## Core Features

### Player Management

Track and manage players across your application with XP, levels, currencies, and lives.

> [accordion] Experience Points (XP)
>
> Award XP to players for completing actions. XP accumulates and contributes to level progression.

> [accordion] Levels
>
> Configure level curves (linear, exponential, or custom tables) to create meaningful progression.

> [accordion] Currencies
>
> Support multiple virtual currencies (coins, gems, tokens) with configurable earn and spend rates.

> [accordion] Lives/Energy
>
> Implement energy systems with automatic regeneration for session-based gameplay.

### Quests & Adventures

Create engaging quest systems with multi-step objectives and seasonal adventures.

```javascript theme={null}
// Track quest progress automatically
await engagefabric.events.track({
  name: 'lesson_completed',
  properties: {
    courseId: 'math-101',
    lessonId: 'lesson-5',
    score: 95
  }
});
```

### Leaderboards

Real-time competitive rankings with support for:

* **Global leaderboards** - All players compete together
* **Segmented leaderboards** - Filter by region, tier, or custom segments
* **Time-boxed leaderboards** - Daily, weekly, monthly competitions

### Real-Time Features

WebSocket-powered real-time updates for:

* Live XP and level changes
* Quest progress notifications
* Leaderboard position updates
* Multiplayer lobby state
* Chat messages

## Architecture Overview

EngageFabric uses a modern, scalable architecture:

```mermaid theme={null}
graph LR
    A[Your App] --> B[EngageFabric API]
    A --> C[WebSocket Gateway]
    B --> D[(PostgreSQL)]
    B --> E[(Redis)]
    C --> E
```

> [!NOTE]
>
> EngageFabric is designed for high throughput with sub-200ms API latency (p95) and real-time WebSocket connections.

## Use Cases

> [card] EdTech
>
> Gamify learning with XP, badges, and course completion quests

> [card] E-Commerce
>
> Loyalty programs with points, tiers, and rewards

> [card] Fitness
>
> Track workouts, streaks, and competitive challenges

> [card] SaaS Products
>
> User onboarding, feature adoption, and engagement

> [card] Gaming
>
> Progression systems, achievements, and multiplayer

> [card] Community
>
> Reputation, badges, and contribution tracking

## Getting Help

> [card] [Discord Community](https://discord.gg/engagefabric)
>
> Join our community for support and discussions

> [card] [GitHub Issues](https://github.com/engagefabric/engagefabric/issues)
>
> Report bugs or request features


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.