> 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/getting-started/installation.md).

# Installation

All ZLOMA scripts require **zloma\_core** as the base dependency. Install it first, then add whichever scripts you need.

***

## Requirements

| Dependency    | Link                                                                       |
| ------------- | -------------------------------------------------------------------------- |
| **ox\_lib**   | [github.com/overextended/ox\_lib](https://github.com/overextended/ox_lib)  |
| **oxmysql**   | [github.com/overextended/oxmysql](https://github.com/overextended/oxmysql) |
| **Framework** | ESX, QBCore, or QBox                                                       |

***

## Step 1: Install zloma\_core

1. Download or clone `zloma_core` from [GitHub](https://github.com/ZlomaScripts/zloma_core)
2. Place it in your resources folder:

   ```
   resources/
   └── [zloma]/
       └── zloma_core/
   ```
3. Add to your `server.cfg`:

   ```cfg
   ensure ox_lib
   ensure oxmysql
   ensure zloma_core
   ```

That's it — zloma\_core auto-detects your framework, inventory, keys, target, fuel, notifications, billing, and society systems on startup.

***

## Step 2: Add ZLOMA Scripts

Add any ZLOMA scripts **after** zloma\_core in your `server.cfg`:

```cfg
# Dependencies
ensure ox_lib
ensure oxmysql

# Framework (whichever you use)
ensure es_extended    # or qb-core / qbx_core

# ZLOMA Scripts
ensure zloma_core
ensure zloma_garages  # paid
# ensure zloma_keys   # coming soon
```

> **Important:** zloma\_core must start **before** any script that uses it.

***

## Verify Installation

On server start, you should see in your 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
========================================
```

If any system shows `NONE DETECTED`, that's fine — it just means you don't have that type of resource installed. zloma\_core will gracefully skip those features.

***

## Troubleshooting

| Problem                  | Solution                                                                      |
| ------------------------ | ----------------------------------------------------------------------------- |
| "No framework detected"  | Make sure ESX/QBCore/QBox starts **before** zloma\_core                       |
| "Inventory not detected" | Check your inventory resource name matches a supported system                 |
| Script errors on start   | Enable debug mode: set `ZlomaCore.Config.Debug = true` in `shared/config.lua` |


---

# 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/getting-started/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.