> For the complete documentation index, see [llms.txt](https://zynoxdev.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://zynoxdev.gitbook.io/docs/zynox-resources/zx_nameguard/installation.md).

# Installation

Zynox Studio Documents > ZYNOX RESOURCES > 🛡️ ZX - Name Guard

## 📥 Installation

Dependencies, drag and drop setup, server.cfg order, configuration, and verification.

***

### 1️⃣ Check dependencies

Make sure your server environment meets the basic prerequisites:

* **Artifacts**: FXServer Recommended Build **6683+** or higher (Cerulean).
* **Database Library**: `oxmysql` (v2.0.0+) running and connected to MySQL.
* **Framework**: Native auto-detection for **Qbox**, **QBCore**, **ESX Legacy**, or **Standalone**.
* **Database Schema**: Zero SQL imports required! Dynamically reads existing character tables (`players` or `users`).

***

### 2️⃣ Add the resource

1. Download the resource from your [Cfx.re Keymaster Grants](https://keymaster.fivem.net/asset-grants).
2. Extract the downloaded `.zip` archive.
3. **Drag and drop** the resource folder into your server's `resources` directory:

   ```
   resources/
   └── zx_nameGuard/
   ```

> \[!TIP] Ensure the folder name is `zx_nameGuard` without spaces or unusual special characters.

***

### 3️⃣ Update server.cfg

Open your `server.cfg` file and ensure the startup order is correct. `zx_nameGuard` must start **after** `oxmysql` and your core framework:

```cfg
# Database Library
ensure oxmysql

# Core Framework (Choose your framework)
ensure qbx_core      # If using Qbox
# ensure qb-core     # If using QB-Core
# ensure es_extended # If using ESX

# If using standalone ConnectQueue (Optional)
# ensure connectqueue

# Zynox Development Name Guard
ensure zx_nameGuard
```

> \[!IMPORTANT] Always ensure `zx_nameGuard` is started **after** `oxmysql` and your core framework. If `zx_nameGuard` starts before your database is ready, early queue verification queries may fail.

***

### 4️⃣ Configuration options

1. Open `config.lua` in your preferred code editor.
2. Select your preferred rejection style:
   * `Config.RejectStyle = 'adaptive_card'` (Interactive NUI card on connection screen with 12s timeout)
   * `Config.RejectStyle = 'text_message'` (Clean instant drop modal — recommended if running third-party queue scripts like `connectqueue`)
3. Set your Discord Webhook URL in `Config.Discord.WebhookURL` to receive live audit logs.
4. Save the file.

***

### 5️⃣ Test in-game & verify

#### 1. In-Game Preview Command

Test the glassmorphism NUI warning card without reconnecting or changing your profile name:

1. Join your server as an admin.
2. In chat or F8 console, run:

   ```
   /testnamecheck
   ```
3. The interactive card will appear on-screen with the logo, clipboard copy button, and step-by-step instructions.

#### 2. Live Connection Test

1. Set your FiveM profile name in FiveM settings to something different from your character name (e.g. `Test_Player`).
2. Attempt to connect to the server.
3. The server will intercept your connection and present the rejection notice with your registered character name.

***

### 6️⃣ Tebex & FiveM Escrow Notes

If you obtained this resource through **Tebex**:

* The resource is granted to your Cfx.re account through **FiveM Keymaster**.
* Ensure your server's `sv_licenseKey` matches the Keymaster account where the asset was granted.
* `config.lua` and the `web/` UI folder remain 100% open and customizable.

***

-# © 2026 Zynox Development • [Official Store](https://zynoxdev.tebex.store/) • [Discord](https://discord.gg/2yuPTmsqjX)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://zynoxdev.gitbook.io/docs/zynox-resources/zx_nameguard/installation.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.