VehicleSpawnMenu

VehicleSpawnMenu is a resource for FiveM by Albo1125 that provides vehicle spawn menu functionality. It is available at https://github.com/Albo1125/VehicleSpawnMenu

Installation & Usage

Download the latest release.
Unzip the VehicleSpawnMenu folder into your resources folder on your FiveM server.
Add the following to your server.cfg file:

ensure VehicleSpawnMenu

Optionally, create a file called vehicles.json and save your menu setup to it. See Customising your vehicles for further guidance.
Optionally, customise the command in sv_VehicleSpawnMenu.lua.

Commands & Controls

/vs - Opens the VehicleSpawnMenu.

Customising your vehicles

You have two options for loading your VehicleSpawnMenu.

Firstly, you can add a vehicles.json file. If this file is created inside the resource folder, it will always be used.
Secondly, you can load your vehicles.json contents dynamically. If no vehicles.json file is present in the resource folder, the client will trigger a server event VehicleSpawnMenu:RequestCategoriesJsonString() when they use the /vs command. The client will then listen for a VehicleSpawnMenu:CategoriesJsonString(jsonString) event from the server. jsonString should be a valid JSON string in the vehicles.json format.

You can add as many SubCategories and VehicleSpawns to the root array as you like. An example vehicles.example.json file is included. JSON reference is as follows.

SubCategory

"Name" string indicating the (unique?) name of this SubCategory
A "SubCategories" and/or "VehicleSpawns" array containing further SubCategory or VehicleSpawn entries.

VehicleSpawn

If this is selected, a vehicle will be spawned with the appropriate properties. The spawning client will also trigger a server event as follows: VehicleSpawnMenu:VehicleSpawned(Name, VehicleModelName, Plate).

"Name" string indicating the display name of this VehicleSpawn
"VehicleModelName" is the ingame model name/spawncode of this vehicle
"Plate" the plate to set on this vehicle when it is spawned
"LiveryNumber" optional number representing which livery to set on the vehicle when it is spawned.

Improvements & Licencing

Please view the license. Improvements and new feature additions are very welcome, please feel free to create a pull request. As a guideline, please do not release separate versions with minor modifications, but contribute to this repository directly. However, if you really do wish to release modified versions of my work, proper credit is always required and you should always link back to this original source and respect the licence.

lsvmoretti / vehiclespawnmenu Goto Github PK