VIP Shop

Buy Here

FiveM Forums Post

YouTube Showcase Video

Translate

• Click here to translate this page.

• How do I change language?

INSTALLATION GUIDE

Step 0 - First Steps

ensure es_extended
ensure cd_vipshop

Step 0 - For existing customers

Step 1 - Fxmanifest

Step 2 - Configure Resource

Step 3 - SQL Database

Step 4 - Install Dependencies

Step 5 - Create a Game Server

Create your game server on your Tebex Webstore to generate your secret key. Watch this Video Guide if you have not done this before.

Below is some important information from the Video guide above.

sv_tebexSecret CHANGE_ME

Step 6 - Create a Product

Create a product on your Tebex Webstore and use the command we have provided below. Watch this Video Guide if you have not done this before.

Below is the command we speak about in the video.

tebex_purchase {"transaction_id":"{transaction}", "package":"{packageName}", "date":"{time} {date}", "buyer_name":"{purchaserName}", "buyer_email":"{email}"}

Step 7 - Config.TebexListings

The name of the product on your tebex webstore MUST be exactly the same as the ProductName inside the Config.TebexListings table in the configs/config.lua. The amount is the number of coins a player will receive when they purchase this product.

Step 8 - Customise The UI

You can add or remove products in the Config.Shop config table in the configs/config.lua. There are commented-out examples at the bottom of the config.lua that will explain everything you need to know to create custom products that your server can sell in-game. You can also remove or add more products on the in-game shop UI.

RegisterServerEvent('cd_vipshop:UpdateCharInfo')
AddEventHandler('cd_vipshop:UpdateCharInfo', function(source, action, data)
	if action == 'charname' then
		QBCore.Players[source].PlayerData.charinfo.firstname = data.firstname
		QBCore.Players[source].PlayerData.charinfo.lastname = data.lastname
	elseif action == 'phone' then
		QBCore.Players[source].PlayerData.charinfo.phone = data.phone
	end
	QBCore.Player.Save(source)
	QBCore.Players[source].Functions.UpdatePlayerData()
end)

Step 9 - Redeem a Purchase

When a player has purchased a product from your tebex webstore, tebex will trigger a chat command on your server within 2-10 minutes to log the purchase information to your database. After this is done, the player can do the following chat command in-game - /redeem (tebex_transaction_id_here) , which will then save the player's donator coins to the database, and they will be available to spend.

OPTIONAL FEATURES

This section is to help you understand how the built-in features of this resource work and, if applicable, how you can make them compatible with other resources. These features are not required. They are optional and can be configured in the [configs/config.lua].

Subscriptions

To allow compatibility with reoccurring/monthly subscriptions, repeat the final part of #Step 6 where you add a command, but on the 2nd command, change when the command is sent - as seen in this screenshot. This will automatically add the same amount of donator tokens to a player when their subscription renews.

Vehicle Stock

How does vehicle stock work?

This allows you to limit each vehicle that can be sold through the VIP shop. The vehicle stock is saved in the database and can be changed anytime. Only the vehicles you add to the database will have limited stock. If a vehicle is not in the vehicle stock database, it can be sold unlimited times.

How do I use this vehicle stock feature?

1. Make sure Config.VehicleStock is enabled in the [configs/config.lua].

2. Go to your server's database and find the [cd_vipshop_vehiclestock] database table - EXAMPLE.

3. Vehicle stock can only be changed in the database. You must add the vehicle spawn model and the vehicle stock amount to the database. Here is a VIDEO EXAMPLE.

zdiscord Integration

Add the 3 files in the download below into your zdiscord/server/commands folder. Then you can use the bot commands below in your discord. This is currently QBCore only unless you modify the code.

/pointlist [cid]

/pointadd [cid] [points_to_add]

/pointremove [cid] [points_to_remove]

INFORMATION

Chat Commands

These chat commands can be renamed and/or disabled in the Keys and Commands section of the [configs/config.lua].

The exact usage for each command will be displayed in the chat suggestions when using the commands in-game.

Exports

These exports are completely optional; you can use them if needed.

exports['cd_vipshop']:GetBalance(source)

exports['cd_vipshop']:AddBalance(source, amount)

exports['cd_vipshop']:RemoveBalance(source, amount)

exports['cd_vipshop']:CanPurchaseCheck(source, cost)

COMMON ISSUES

Please check out our Troubleshooting Guide before contacting our support.

🔔 Folder Name Make sure the name of the folder is cd_donatorshop.

Can’t Redeem a Purchase?

eg., if a player has made a purchase on your tebex store and the purchase is still not able to be redeemed in game after 10 minutes.

Copy

✔️ Assuming you have followed the steps above correctly; if tebex is not sending the purchase data to your server the problem might be that your sv_tebexSecret key is active on one of your test/dev/local host servers and therefore tebex is sending the data to the wrong server instead, so remove this sv_tebexSecret key from your other servers. Or the issue may simply be that tebex is having issues on their side.

SQL Unknown Column?

eg., if you see an SQL error in the server console similar to this example - ER_BAD_FIELD_ERROR: Unknown colum 'job_personalspawn' in 'where clause'.

Copy

✔️ You are missing one of the required database columns. The SQL file can be found in the "READ_ME_AFTER_PURCHASING" folder.

Tebex Secret Key?

eg., if you see this authentication error In your server console [cd_donatorshop] - Unable To Start (sv_tebexSecret is nil).

Copy

✔️ This means [#Step 5] has not been completed correctly.

Redeemed 0 Balance?

eg., if a player redeems a purchase and it say they redeemed 0 balance in the notification when it should clearly be a higher number.

Copy

✔️ This can only happen if the Product Name on your tebex store does not match with the ProductName in the Config.TebexListings. They must match exactly - caps lock, spaces and punctuation marks.

Not All Display Vehicles Spawned?

eg., if some of the display vehicles just stopped spawning and the vehicle UI isnt visible.

Copy

✔️ This happens because the [Model] for one of the vehicles you added to the Config.Vehicle table in the [configs/config.lua] file was the wrong spawn name. An easy way to identify the problem vehicle is to look for the last vehicle that spawned successfully and it will be the next vehicle in the list.

ERROR CODES

If you see an error code not listed below, please open a script support ticket in the Codesign Discord.

CHANGELOG

Files Changed

Not every update requires you to replace the whole folder. We do this because we understand it's a pain to redo the configs for every update.

• All Files - This means you should delete your old cd_vipshop folder, download and add in the latest version, reconfigure the configs folder and restart your server.

• All Files Except config.lua - This means you should do all of the above (in the All Files section) but additionally make a backup of the config.lua file and replace the new config.lua file with the one you made a backup of.

• Specific Files - This means you can copy and paste the SPECIFIC new files over the old ones and restart the server.

Update Type

On rare occasions, you are forced to update to the latest version. Mostly due to authentication updates where the old versions will no longer work.

• Mandatory - This means you MUST update to this new version, or the old versions will no longer work.

• Optional - This means it's completely your choice whether you wish to update to the latest version. But we do not offer support for old versions for obvious reasons; they are old.

fxmanifest.lua - (IMPORTANT)
server/server.lua - (IMPORTANT)
server/reward_players.lua
client/functions.lua

fxmanifest.lua - (IMPORTANT)
configs/server_customise_me.lua
client/functions.lua

fxmanifest.lua
server/main/server.lua
configs/locales.lua (added ['redeem_error']) locale).

fxmanifest.lua
client/other/display_vehicles.lua
client/other/test_drive.lua
configs/server_customise_me.lua
server/other - (delete this folder)