Installation | 0Resmon

Requirements#

Resource	Required	Notes
ox_lib	Yes	Menus, notifications, text UI
oxmysql	Yes	Database access
Framework	Yes	`qb-core`, `qbx_core` or `es_extended`
object_gizmo	Yes	Fine placement while building a car wash in game
`frkn-carwashmap`	Optional	Map replacement for the vanilla car wash locations

The script detects your framework automatically. No edits are needed for QBCore, QBX or ESX.

Step 1 - Add the resource#

Drag the frkn-carwash folder into your resources directory, for example:

resources/frkn-carwash

Step 2 - Import the database table#

Import carwashes.sql into your database. It creates a single table:

CREATE TABLE IF NOT EXISTS `frkn_carwashes` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `name` varchar(50) NOT NULL,
  ...
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

Missing columns are added automatically when the server starts, so updating the script never requires a manual SQL migration.

Step 3 - Start the resource#

Add it to your server.cfg after your framework, ox_lib and oxmysql:

ensure ox_lib
ensure oxmysql
ensure qb-core

ensure frkn-carwash

Step 4 - Set your language#

Open shared/config.lua:

Locale = 'en', -- 'en' , 'tr' , 'de' , 'fr' , 'it' , 'es' , 'pt' , 'ru' , 'ar'

Step 5 - Give yourself access#

Admin commands are limited to the permission groups listed in the config:

AdminGroups = {
    'admin',
    'god'
}

Type /carwashes in game to open the admin menu and create your first car wash.

To let a player build one car wash without giving them admin rights, use /givewash [player id]. That player can then run /carwashes a single time.

Optional - frkn-carwashmap#

frkn-carwashmap replaces the vanilla GTA car wash locations with the map props used by this script.

ensure frkn-carwashmap
ensure frkn-carwash

What it changes:

The default GTA car washes are removed. The old drive-through buildings no longer exist at those locations.
The new wash machines and signage are placed at the same spots.

If PublicCarwashes.Enabled is true in the config, ownerless public car washes are created at those locations automatically. Players can drive up and pay the configured price straight away - there is no owner, no office and no business menu.

PublicCarwashes = {
    Enabled = true, -- false = none of them appear
    ...
}

Set it to false if you would rather have players buy and run every car wash themselves.

Optional - Vehicle key integrations#

Keys are handed out automatically after a mobile wash mission if one of these is running:

t1ger_keys
qs-vehiclekeys
Renewed-Vehiclekeys

Troubleshooting#

Problem	Fix
Props do not appear	Make sure the resource folder name is exactly `frkn-carwash` and the server cache is cleared
`/carwashes` says no permission	Add your group to `AdminGroups`, or use `/givewash [id]`
Menus do not open	`ox_lib` must start before `frkn-carwash`
Car washes are missing after a restart	Check that `oxmysql` is running and `carwashes.sql` was imported
Old GTA car wash still visible	`frkn-carwashmap` is not started, or it starts after `frkn-carwash`