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

# FA Minigames

> Use free, framework-independent NUI minigames in your FiveM resource.

FA Minigames is a free NUI resource for FiveM. It provides ten client-side minigames through a small synchronous export API.

<Note>
  This documentation covers FA Minigames **1.0.0**. The examples assume the resource folder is named `fa_minigames`.
</Note>

## What you get

<Columns cols={3}>
  <Card title="Framework independent" icon="puzzle-piece">
    Use it with ESX, QBCore, Qbox, standalone resources, or your own framework.
  </Card>

  <Card title="Ten games" icon="gamepad">
    Choose from drilling, keypad, memory, matching, and terminal challenges.
  </Card>

  <Card title="Simple result contract" icon="code">
    Each export waits for completion and returns a result table to your Lua coroutine.
  </Card>
</Columns>

## Available games

| Export        | Player objective                                            |
| ------------- | ----------------------------------------------------------- |
| `Drill`       | Balance pressure, drill speed, and heat to clear four pins. |
| `Keypad`      | Enter a four-digit code.                                    |
| `Skillbar`    | Stop the moving marker inside the target area.              |
| `Sequence`    | Repeat the displayed button sequence.                       |
| `Lockpick`    | Find the lock's binding angle and apply tension.            |
| `Pattern`     | Memorize and recreate a highlighted grid pattern.           |
| `Wires`       | Connect matching labelled wire channels.                    |
| `Circuit`     | Rotate tiles until the circuit is connected.                |
| `Fingerprint` | Align all fingerprint slices.                               |
| `Terminal`    | Select the requested terminal token across multiple traces. |

## Start here

<Columns cols={2}>
  <Card title="Install the resource" icon="download" href="/scripts/fa-minigames/installation">Put the resource in your server and start it in the right order.</Card>
  <Card title="Use the exports" icon="code" href="/scripts/fa-minigames/api-reference">Copy the result-handling pattern and select a game.</Card>
  <Card title="Tune difficulty" icon="sliders" href="/scripts/fa-minigames/configuration">Use presets or safely override individual game options.</Card>
  <Card title="Get help" icon="life-ring" href="/scripts/fa-minigames/troubleshooting">Resolve startup, NUI, timeout, and API problems.</Card>
</Columns>

<Warning>
  A successful minigame is client-provided input. Your owning resource must validate permissions, distance, state, attempts, rate limits, and rewards on its server.
</Warning>