Installation

description: Install yei-carwipe and configure its required dependency.

Installation

Installation

yei-carwipe — By YeiDeV from Yei Studios · v2.1.0

A modern vehicle cleanup ("carwipe") system for FiveM with a custom admin UI panel: countdown warning before wipe, occupied-vehicle protection, ignore zones, scheduled/interval automation, and Discord logs.

Prerequisites

• ox_lib — required dependency, declared in fxmanifest.lua. The resource won't start without it.

{% hint style="danger" %} The resource folder must be named exactly yei-carwipe. The script checks its own resource name on startup (server/init.lua) and will print a red security alert and automatically stop itself if the folder was renamed. {% endhint %}

Installation steps

1. Extract the ZIP into your resources folder, keeping the folder name exactly yei-carwipe — do not rename it (see the warning above).
2. Final structure should look like this:

resources/[standalone]/yei-carwipe/fxmanifest.lua
resources/[standalone]/yei-carwipe/client/client.lua
resources/[standalone]/yei-carwipe/server/init.lua
resources/[standalone]/yei-carwipe/server/discord.lua
resources/[standalone]/yei-carwipe/server/permissions.lua
resources/[standalone]/yei-carwipe/server/server.lua
resources/[standalone]/yei-carwipe/shared/config/config.lua
resources/[standalone]/yei-carwipe/shared/lang/lang.lua
resources/[standalone]/yei-carwipe/shared/utils.lua
resources/[standalone]/yei-carwipe/ui/index.html
resources/[standalone]/yei-carwipe/ui/css/style.css
resources/[standalone]/yei-carwipe/ui/js/script.js
resources/[standalone]/yei-carwipe/ui/sound/open.wav
resources/[standalone]/yei-carwipe/ui/sound/delete.wav

3. In your server.cfg, add (respecting the order — ox_lib before the resource):

ensure ox_lib
ensure yei-carwipe

add_ace group.admin yei-carwipe.use allow
add_principal identifier.license:YOUR_LICENSE group.admin

{% hint style="warning" %} Replace identifier.license:YOUR_LICENSE with your actual license identifier (or attach the ACE to whatever admin group/principal your server already uses). {% endhint %}

4. Restart the server (or refresh + ensure yei-carwipe). On startup, the console will print a banner confirming the version, the resource name check passed, the default countdown, the active automation mode, and the available commands.

{% hint style="success" %} That's it — the script is ready. No carwipe runs automatically on startup by default (both Schedule and IntervalTime come disabled out of the box). Continue to Configuration to customize timing, ignore zones, and the Discord webhook. {% endhint %}