> For the complete documentation index, see [llms.txt](https://docs.yeistudios.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.yeistudios.com/scripts/car-wipe/compatibility.md).

# Compatibility

Check supported frameworks, dependencies, permissions, and notifications.

## Compatibility

| Category                   | Compatible with                                                                                                                                                                                                        |
| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Frameworks**             | Framework-agnostic — vehicle deletion logic doesn't depend on any framework. Native notification hooks exist for **ESX** and **QBCore**, plus a `print` fallback if neither is running.                                |
| **Required dependency**    | [ox\_lib](https://github.com/overextended/ox_lib) — hard dependency, used for `lib.callback` (all client↔server communication) and NUI. The resource will not start without it.                                        |
| **Permissions**            | ACE permissions only (`Config.AcePermission`) — no dependency on framework job/rank systems, group-based permission resources, or Discord role checks.                                                                 |
| **Player spawn detection** | Listens for `QBCore:Client:OnPlayerLoaded`, `qbx_core:client:playerLoaded`, and `esx:playerLoaded` (in addition to its own resource start) to correctly re-open the countdown card for players who reconnect mid-wipe. |
| **Discord logging**        | Any standard Discord webhook URL — no bot token or extra Discord integration resource required.                                                                                                                        |
| **UI**                     | Custom NUI (HTML/CSS/JS), fully independent of framework — same behavior on ESX, QBCore, QBX, or standalone.                                                                                                           |

{% hint style="success" %}
Because the cleanup logic works directly on native vehicle/object entities (not framework-owned vehicle records), `yei-carwipe` works identically regardless of which framework — or none — your server runs.
{% endhint %}

#### Notification fallback

| Framework detected                      | Notification method used               |
| --------------------------------------- | -------------------------------------- |
| `es_extended` running                   | `esx:showNotification`                 |
| `qb-core` running (and ESX not running) | `QBCore:Notify`                        |
| Neither running                         | Falls back to a server console `print` |

#### Not required

`yei-carwipe` does **not** depend on: `oxmysql` or any database, `ox_target`/`qb-target`, `ox_inventory`, or any vehicle-keys resource — it has no interaction with vehicle ownership, only with live entities currently spawned in the world.


---

# 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, and the optional `goal` query parameter:

```
GET https://docs.yeistudios.com/scripts/car-wipe/compatibility.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
