> For the complete documentation index, see [llms.txt](https://0grav1ty.gitbook.io/zerogravity/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://0grav1ty.gitbook.io/zerogravity/scripts/pin-code-minigame.md).

# PIN Code Minigame

## Overview

<figure><img src="/files/TOZCKPbeGqYgPKVjGMNq" alt=""><figcaption></figcaption></figure>

The **PIN Code Minigame** is designed for GTA V FiveM servers. It challenges players to enter a PIN code within a designated time limit. The minigame offers options such as customizable PIN length, time limits, and multiple attempts.

## Features

* **Customizable PIN Code Length:** Set the length of the PIN as needed.
* **Time Limit:** Configure the time allowed to enter the PIN.
* **Multiple Attempts:** Players can have several tries to input the correct code.
* **Predefined or Random Code:** Use a fixed code for testing or generate one randomly.
* **Native UI:** Uses native notifications and a custom NUI interface for an immersive experience.

## Installation & Usage

1. **Installation:**
   * Copy the `0g_pingame` folder (which contains the following files) to your FiveM resources directory:
     * `fxmanifest.lua`
     * `client.lua`
     * `server.lua`
     * `html/index.html`
     * `html/css/pin_code.css`
     * `html/scripts/pin_code.js`
     * `README.md`
   * Add `start 0g_pingame` to your `server.cfg`.
2. **Usage:**
   * To start the minigame in-game, type the command:

     ```
     /test_pincode
     ```
   * Upon successful completion, an event is triggered that can reward the player (see **Events** section).

## Events

* **0gravity\_pincodes:rewardPlayer(success)**
  * Triggered when the minigame ends.
  * Parameter `success` is a boolean indicating if the player entered the correct PIN.

For more details on the PIN Code Minigame, refer to the inline comments in the source code.