Installation

STEP 1 - Dependencies

Dependencies: It is important to use the dependencies that are indicated in this step, do not use others, otherwise you will receive critical errors

Releases · overextended/oxmysqlGitHub

Releases · overextended/ox_libGitHub

STEP 2 - Start order

It is important to put the resources in the correct order, oxmysql should be started before es_extended followed by ox_lib (should be on top of your starting scripts)

In order for the resource to start correctly and not receive any errors, we must start the resources in the following order

ensure oxmysql
ensure ox_lib

STEP 3 - Script Config

You can fully configure the script based on what your server needs. Here you can find a detailed explaination about all the possible configuration that you can use.

```lua
--[[ _______           __                                 _______                     
|       \         |  \                               |       \                    
| ▓▓▓▓▓▓▓\ ______ | ▓▓__    __ __    __  ______      | ▓▓▓▓▓▓▓\ ______  __     __ 
| ▓▓  | ▓▓/      \| ▓▓  \  |  \  \  /  \/      \     | ▓▓  | ▓▓/      \|  \   /  \
| ▓▓  | ▓▓  ▓▓▓▓▓▓\ ▓▓ ▓▓  | ▓▓\▓▓\/  ▓▓  ▓▓▓▓▓▓\    | ▓▓  | ▓▓  ▓▓▓▓▓▓\\▓▓\ /  ▓▓
| ▓▓  | ▓▓ ▓▓    ▓▓ ▓▓ ▓▓  | ▓▓ >▓▓  ▓▓| ▓▓    ▓▓    | ▓▓  | ▓▓ ▓▓    ▓▓ \▓▓\  ▓▓ 
| ▓▓__/ ▓▓ ▓▓▓▓▓▓▓▓ ▓▓ ▓▓__/ ▓▓/  ▓▓▓▓\| ▓▓▓▓▓▓▓▓    | ▓▓__/ ▓▓ ▓▓▓▓▓▓▓▓  \▓▓ ▓▓  
| ▓▓    ▓▓\▓▓     \ ▓▓\▓▓    ▓▓  ▓▓ \▓▓\\▓▓     \    | ▓▓    ▓▓\▓▓     \   \▓▓▓   
 \▓▓▓▓▓▓▓  \▓▓▓▓▓▓▓\▓▓ \▓▓▓▓▓▓ \▓▓   \▓▓ \▓▓▓▓▓▓▓     \▓▓▓▓▓▓▓  \▓▓▓▓▓▓▓    \▓    
 
           ______________________________________
  ________|           Deluxe Wipe System         |_______
  \       |      deluxedevelopment.tebex.io      |      /
   \      |                                      |     /
   /      |______________________________________|     \
  /__________)                                (_________\                                                                           
  
    Discord Support: https://discord.gg/pqXAbDBmVM


Before you go ahead make sure you have downloaded and installed these dependency or you might have issues running this script.
1] Mysql or OXMySQL: https://github.com/overextended/oxmysql/releases
2] OXLib : https://github.com/overextended/ox_lib/releases

Make sure you have in your server cfg:

ensure oxmysql
ensure ox_lib

]]

Config = {}

Config.ESX = 'new' -- If you use esx above 1.8 keep new, otherwise type: old

Config.WipeCommand = 'Wipe' -- The command to open the menu

Config.AllowWipes = {'superadmin','admin', 'mod', 'helper'} -- Roles that can use the wipe menu

Config.Notificationtype = 'okokChat' -- Type of notification (Available: ox , esx, okokChat [if you use and set okokChat, it will display chat notifications])
Config.OxAlignNotifications = 'center-left' -- Available: 'top' or 'top-right' or 'top-left' or 'bottom' or 'bottom-right' or 'bottom-left' or 'center-right' or 'center-left' [You must have Config.Notificationtype = 'ox']


-- Configure your database settings
Config.MultiCharacterString = 'char1:' -- The prefix before the fivem identifier saved in database (VERY IMPORTANT, MAKE SURE TO MATCH IT BASED ON YOUR CONFIG.)

--[[ You can add or remove anything you want. Everything is smoothly optimized and configurable

Example to add query:
After "phone" table, add this (example):
    phone = 'DELETE FROM phone_numbers WHERE identifier = ?',
    example = 'DELETE FROM example_database WHERE identifier = ?,
--]]

Config.TotalWipeDB = {
    user = 'DELETE FROM users WHERE identifier = ?',
    vehicles = 'DELETE FROM owned_vehicles WHERE owner = ?',
    billing = 'DELETE FROM okokbilling WHERE receiver_identifier = ?',
    banking = 'DELETE FROM okokbanking_transactions WHERE sender_identifier = ?',
    phone = 'DELETE FROM phone_numbers WHERE identifier = ?',
}

-- Set up car wipes
Config.CarWipeDB = {
    vehicles = 'DELETE FROM owned_vehicles WHERE owner = ?',
}

Config.CustomWipeDB = {
 -- Add any query that you want to add in the custom wipe
    vehicles = 'DELETE FROM owned_vehicles WHERE owner = ?',
}

-- Translate everything according to your language there. [Keep the syntax to keep the best configuration]
Config.Translation = {
    ["menu_name"] ='[DeluxeDevelopment] WIPE MENU',
    ["license_id"] = "License ID FiveM",
    ["license_id_description"] = "Type the license fivem identifier (Also available from tx). You can choose between total wipe, money, and other types.",
    ["wipe_reason"] = "Wipe Reason",
    ["wipe_reason_description"] = "Type the wipe reason.",
    ["id_player"] = "Current WIPED Player ID (If online)",
    ["id_player_description"] = "If the player that you are wipeing is online, type his id. If not, don't type anything.",
    ["complete_wipe"] = "Complete wipe",
    ["car_wipe"] = "Car wipe",
    ["custom_wipe"] = "Custom wipe",
    ["kick_message"] = "You have been total wiped, please restart the game.",
    ["no_permissions"] = "You don't have permissions.",
    ["no_permissions_esx"] = "You don't have permissions to open the wipe menu.",
    ["not_admin"] = "You are not an admin.",
    ["wiped_title"] = "You have been wiped.",
    ["wipe_title_admin"] = "Wipe completed",
    ["wipe_message"] = "You received a ",
    ["to_player"] = " To player with identifier ",
    ["completed"] = " successfully completed",
    ["invalid"] = "Identifier is invalid",
    ["invalid_identifier"] = "You need to type a valid identifier",
}
```

STEP 4 - Webhook Config

You can setup discord webhooks for wipe logs too. It's pretty simple and it's explained there:

```lua

--░██╗░░░░░░░██╗███████╗██████╗░██╗░░██╗░█████╗░░█████╗░██╗░░██╗░██████╗
--░██║░░██╗░░██║██╔════╝██╔══██╗██║░░██║██╔══██╗██╔══██╗██║░██╔╝██╔════╝
--░╚██╗████╗██╔╝█████╗░░██████╦╝███████║██║░░██║██║░░██║█████═╝░╚█████╗░
--░░████╔═████║░██╔══╝░░██╔══██╗██╔══██║██║░░██║██║░░██║██╔═██╗░░╚═══██╗
--░░╚██╔╝░╚██╔╝░███████╗██████╦╝██║░░██║╚█████╔╝╚█████╔╝██║░╚██╗██████╔╝
--░░░╚═╝░░░╚═╝░░╚══════╝╚═════╝░╚═╝░░╚═╝░╚════╝░░╚════╝░╚═╝░░╚═╝╚═════╝░

Config.EnableWebHook = false -- Enable or disable the discord logs (deluxe-wipe) [true = active, false = disabled]
Config.WebhookURL = '' -- Your discord webhook link
Config.WebhookTitle = 'Deluxe Wipe' -- The webhook title
	
	-- Color Settings
Config.WebhookColor = '3145631' -- Green, Red: 16711680,  Yellow: 16777073
```