> ## 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.

# Installation

> Install FA Minigames and start it before resources that use its client exports.

FA Minigames has no framework, inventory, database, or server-side dependency.

## Install the resource

<Steps>
  <Step title="Add the folder">
    Place `fa_minigames` in your server's resources directory. The examples and consumers below use this name.

    ```text theme={null}
    resources/
    └── [fa-scripts]/
        ├── fa_minigames/
        └── your_resource/
    ```
  </Step>

  <Step title="Rename only when needed">
    You can rename this open-source resource. If you do, update its `ensure` line and every call such as `exports.fa_minigames:Skillbar()` to use the new resource name.
  </Step>

  <Step title="Start it first">
    Add the resource before every consumer in `server.cfg`.

    ```cfg server.cfg theme={null}
    ensure fa_minigames
    ensure your_resource
    ```
  </Step>

  <Step title="Restart and verify">
    Restart the server and run an export from an in-game client. Check that the NUI opens, receives input, closes, and returns a result.
  </Step>
</Steps>

## Use it with FA Shop Robbery

FA Shop Robbery can use FA Minigames for its bundled safe keypad and drill. Start `fa_minigames` before `fa_shoprobbery`, then select the bridge in its configuration.

```lua config/config.lua theme={null}
Config.Minigames.Safe = 'fa_minigames'
```

The minigame resource is not limited to Shop Robbery. You can call its exports from any client resource.

<Note>
  Browser builds and static checks cannot prove FiveM NUI focus or live input behavior. Test your actual resource order and gameplay flow in-game.
</Note>