Car Wash

{:links-list}

This script has been completely rewritten so be sure to read ALL of these instructions to avoid making mistakes setting the script up.

INSTALLATION

  1. Open the downloaded ZIP product file and drop the folder in it somewhere in your resources folder.
  2. Add your product key (get it here) to the settings.ini file
  3. Add start BigDaddy-CarWash to your server.cfg.

DO NOT RENAME THE FOLDER.

If you change the name of the folder it will not function correctly so leave the name as it is.

{:is-danger}

QBCore Installation

This script is integrated with QBCore but a few extra steps are required for setup (as with most QBCore scripts).

  • To be able to use this resource you will be required to modify your qb-smallresources. YOU MUST REMOVE carwash.lua, from the client folder to remedy a conflict between the scripts.

  • There is a database table to be able to use the business ownership aspect. You must have a mysql database already created and connected to your server.

  • This script is compatible with ox-mysql, mysql-async and ghmattimysql so any of those will work

  • Run the createtable.sql file found in the root of the script

  • There is a locations.json file in the root. This is how the script builds the car wash locations. It comes preconfigured with several locations. There are in-game tools to add locations visually.

DO NOT edit the locations.json file directly. You WILL break the script if you change the items in that file. Use the in-game tools for managing your locations. You've been warned.

{:is-danger}

There are admin tools to add, edit, delete carwash locations. There are also tools to set up the locations as purchasable businesses that players can buy and receive revenue from. (see below for instructions on those tools)

{:is-info}

server.lua is where money is setup. Just set your framework at the top of the file for any of the included frameworks. If your framework is not included there is a custom section to add your own money integration. More info here.

Targeting

This script is compatible with both QB Target and OX Target. Both will work automatically.

Inventory

This script is compatible with both QB Inventory and OX Inventory. Both will work automatically.

CONFIGURATION

SETTING DEFAULT DESCRIPTION
[licensing]
key1 none This is where you put your product key
[settings]
useMoney true set this to false if you do not want to use a money framework
[locales]
buyWash Press $ to buy a car wash leave the $ in as that will be replaced by the key/button to use.
occupied Car wash in use, please wait...
noMoney You do not have enough money in the bank to buy a car wash
cancelled Car Wash has been cancelled

HOW TO PLAY

There are car wash blips on the maps for each location. Drive up to the pay kiosk and it will prompt you to press a key/button to purchase a wash. Once pressed it will take you through the car wash. You don't have to do anything else.

ADMIN TOOLS

Car wash locations

NOTE: You must have permissions (defined in settings.ini) to use the admin tools

  • Walk to any location you would like to add a car wash.

  • Use the carwashadd command and you will be shown a menu.

  • Type in a UNIQUE NAME (it cannot match any name of any other wash).

If you are placing hand wash items and one location has several, give it the same name but increment a number on the end. Be sure the names are exact with just the number being different. This will group them together when being sold (if using QBCore and setup for that).

{:is-info}

  • After entering the name choose a car wash type from the buttons below and one will be spawned on screen but partially transparent with a gizmo beneath it. Use that gizmo to move the carwash around until it is exatly where you want it and hit ENTER. If you want to cancel hit DEL.

  • If you want to edit the position, you can use the ADMIN menu using the target on the pay machine part of the wash location or using the carwashedit command.

  • Deleting a carwash location can also be done in the ADMIN menu or using the carwashdelete command.

Setting up businesses

  • Use the targeting ADMIN menu on the paymachine of a car wash and you will see a form with all the information related to this location. Fill in the price and description and click ADD LISTING to make this location purchasable as a business.
  • Using the same menu you can edit the listing, remove the listing, and even edit the location's position using the gizmo.

NOTE: if the location is owned already, you cannot remove it.

{:is-info}

  • When a location is purchasable but unowned, there will be a FOR SALE sign near the pay machine of the location. The targeting on that sign has options to see and purchase the property if you choose to.

REVENUE and UTILITES

If the property is listed as purchasable it accrues revenue and utilities each time it is used. Those go into a holding account until the owner uses the OWNER MENU to collection revenue and pay utilities.

MAINTENANCE

There are occassions when the car wash could experience mechanical failures. This will render the location closed until the owner comes to the location and uses the OWNER MENU to pay the maintenance costs to reopen. If the location remains closed for mechanical issues for too long, it will be foreclosed on by the city and put back up for sale. So it is important owners stay on top of their business or they will lose it with no compensation from the city. This is agreed upon when purchased.