> For the complete documentation index, see [llms.txt](https://w-labs.gitbook.io/w-labs-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://w-labs.gitbook.io/w-labs-docs/paid-scripts/wlabs-minigames.md).

# WLabs Minigames

WLabs Minigames is a reusable hacking minigame library for FiveM servers. Other resources can start a minigame through exports and receive either a simple success boolean or a detailed result object.

Store link: [View WLabs Minigames](https://wlabs.tebex.io/package/minigames?utm_source=docs\&utm_medium=documentation\&utm_campaign=minigames)

Works standalone, or inside the free W-Labs Tablet/Phone.

The resource includes four minigames:

* Signal Trace - mirror a randomized relay pulse route.
* Circuit Spoof - rotate relay tiles to compile a clean IN to OUT circuit.
* Cipher Grid - find the matching 4-tile packet while the terminal grid cycles.
* Chip Sweep - sweep a thermal board and lock only overheated chips.

## Display Modes

Minigames can run in three display modes:

* Standalone NUI overlay.
* WLabs phone app.
* WLabs tablet app.

Export config and display mode are separate.

Exports use `shared/config.lua` as the default difficulty, then merge in any values passed by the calling script. Default exports run as standalone NUI. Explicit exports are also available for each display mode, so individual scenarios can force phone, tablet, or standalone behavior without changing the difficulty values.

The phone/tablet Minigames app menu uses device-tuned fallback settings, then applies the matching values from `shared/config.lua`. For example, setting `Config.CircuitSpoof.iterations = 2` makes the app menu require two successful Circuit Spoof runs.

## Requirements

Required:

* FiveM artifact with Lua 5.4 support.

Optional:

* `wlabs-tablet` - required only when using phone or tablet display exports.

WLabs Minigames does not require a framework, inventory, target system, or database.

When `wlabs-tablet` is running, WLabs Minigames registers its phone/tablet app automatically.

## Pages

* [Getting started](/w-labs-docs/paid-scripts/wlabs-minigames/getting-started.md)
* [Configuration](/w-labs-docs/paid-scripts/wlabs-minigames/configuration.md)
* [Difficulties](/w-labs-docs/paid-scripts/wlabs-minigames/difficulties.md)
* [Exports](/w-labs-docs/paid-scripts/wlabs-minigames/exports.md)
