> 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/zloma_core.md).

# Overview

**Universal Framework Wrapper for FiveM**

zloma\_core provides a unified API across ESX, QBCore, and QBox. It auto-detects your server's systems at startup and wraps them behind consistent exports — so scripts work everywhere without framework-specific code.

***

## Why zloma\_core?

| Without zloma\_core                         | With zloma\_core                        |
| ------------------------------------------- | --------------------------------------- |
| Write separate code for ESX and QBCore      | One codebase works everywhere           |
| Update scripts when frameworks change       | zloma\_core handles version differences |
| Hardcode inventory/keys/target system       | Auto-detected, swap anytime             |
| Support headaches from framework mismatches | Graceful fallbacks, no crashes          |

***

## What It Wraps

| Category            | Systems                                                           | Count |
| ------------------- | ----------------------------------------------------------------- | ----- |
| **Framework**       | ESX, QBCore, QBox                                                 | 3     |
| **Inventory**       | ox\_inventory, qb-inventory, qs-inventory, ps-inventory, and more | 12    |
| **Notification**    | ox\_lib, wasabi\_notify, fl-notify, brutal\_notify, and more      | 15    |
| **Keys**            | Renewed-Vehiclekeys, qb-vehiclekeys, wasabi\_carlock, and more    | 21    |
| **Fuel**            | lc\_fuel, LegacyFuel, ox\_fuel, Renewed-Fuel, and more            | 16    |
| **Society/Banking** | esx\_addonaccount, qb-banking, okokBanking, and more              | 18    |
| **Billing**         | okokBilling, esx\_billing, qb-billing                             | 4     |
| **Target**          | ox\_target, qb-target, qtarget                                    | 3     |

**Total: 90+ supported systems**, all auto-detected at runtime.

***

## Quick Example

```lua
-- Server-side: works on ESX, QBCore, and QBox
local Core = exports['zloma_core']

local job = Core:GetPlayerJob(source)
Core:AddItem(source, 'phone', 1)
Core:AddMoney(source, 500, 'bank')
```

```lua
-- Client-side: works with any notification/keys/target system
local Core = exports['zloma_core']

Core:Notify('Vehicle stored!', 'success', 5000)
Core:GiveKeys(plate)
Core:AddEntity(vehicle, options)
```

No framework checks. No `if ESX then ... elseif QB then ...`. Just exports.

***

## Next Steps

* [Installation](/zloma-scripts/zloma_core-free/installation.md) — get it running
* [Configuration](/zloma-scripts/zloma_core-free/configuration.md) — manual overrides & debug mode
* [Supported Systems](/zloma-scripts/zloma_core-free/supported-systems.md) — full list of every system
* [API Reference](/zloma-scripts/zloma_core-free/api-reference.md) — all exports documented
* [Contributing](/zloma-scripts/zloma_core-free/contributing.md) — add new system support


---

# 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/zloma_core.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.
