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

# Installation

## Requirements

| Dependency                                         | Required      |
| -------------------------------------------------- | ------------- |
| [ox\_lib](https://github.com/overextended/ox_lib)  | Yes           |
| [oxmysql](https://github.com/overextended/oxmysql) | Yes           |
| ESX, QBCore, or QBox                               | Yes (any one) |

***

## Download

Clone or download from GitHub:

```bash
git clone https://github.com/ZlomaScripts/zloma_core.git
```

Or download the latest release from the [Releases page](https://github.com/ZlomaScripts/zloma_core/releases).

***

## Setup

1. Place `zloma_core` in your resources folder:

   ```
   resources/
   └── [zloma]/
       └── zloma_core/
   ```
2. Add to `server.cfg` — **before** any scripts that use it:

   ```cfg
   ensure ox_lib
   ensure oxmysql
   ensure zloma_core
   ```
3. Restart your server. Done.

***

## Verify

You should see this in your server console:

```
========================================
ZLOMA CORE v1.0.0 - System Detection
========================================
Framework: QBCore
Inventory: ox_inventory
Billing: okokBilling
Notification: ox_lib
Keys: Renewed-Vehiclekeys
Target: ox_target
Fuel: lc_fuel
Society: qb-banking
========================================
```

Every detected system means zloma\_core found it and is ready to use. `NONE DETECTED` is fine for optional systems — zloma\_core just skips those features with a warning instead of crashing.

And on the client (F8 console):

```
========================================
ZLOMA CORE - Client Detection
========================================
Notification: ox_lib
Keys: Renewed-Vehiclekeys
Target: ox_target
Fuel: lc_fuel
========================================
```


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://zloma-scripts.gitbook.io/zloma-scripts/zloma_core-free/installation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
