Installation
Follow these steps in order. It takes about 10 minutes.
1. Download
- Go to the Cfx.re portal (keymaster) and open Granted Assets.
- Download vault-festival.
- Unzip it. You get a folder called
vault-festival.
2. Copy the folder
- Copy the
vault-festivalfolder into your server’sresourcesfolder. You can put it inside a category folder, for exampleresources/[vault]/vault-festival. - Do not rename the folder. Other scripts and the inventory item call it by the name
vault-festival. If you rename it, the desk item and every export stop working.
What you should see inside:
vault-festival/
config/ <- your settings (you can edit these)
locales/ <- the languages (you can edit these)
install/ <- the inventory items
music/ <- put your song files here
shows/ <- the server saves the light shows here
docs/ <- this documentation
fxmanifest.lua
... (other folders: do not touch)
3. Start it in server.cfg
Open server.cfg. Add ensure vault-festival after the scripts it uses. The festival looks for them only once, when it starts. Anything that starts later is not seen.
ensure ox_lib
ensure qbx_core # or qb-core, or es_extended
ensure ox_inventory # if you use it
ensure ox_target # or qb-target, if you use one
ensure vault-festival
4. Give permissions
Add this line to server.cfg (or to your permissions file):
add_ace group.admin vault-festival.admin allow
This makes your admins festival admins. They can do everything. This line is for Qbox and ESX.
QBCore: QBCore admins are not in group.admin. Use these lines instead:
add_ace qbcore.god vault-festival.admin allow
add_ace qbcore.admin vault-festival.admin allow
Optional: let another group run the lights but not move the venue:
add_ace group.mod vault-festival.operate allow
The difference between operator and admin is explained in Commands and permissions.
Tip: on Qbox and ESX your admins must actually be in
group.admin. On most servers that is done with a line likeadd_principal identifier.fivem:123456 group.admin.
5. Add the items to your inventory
The festival uses 3 items:
| Item | What it is |
|---|---|
festival_wristband |
General ticket. |
festival_wristband_vip |
VIP ticket (also counts as general). |
festival_desk |
Portable lighting desk (a tablet). |
Open the install/ folder and use the file for your inventory:
- ox_inventory: open
install/items_ox.lua, copy everything inside, and paste it intoox_inventory/data/items.lua(before the last}). - QBCore inventory: open
install/items_qb.lua, copy the lines, and paste them intoqb-core/shared/items.lua. - ESX: run
install/items_esx.sqlon your database (with HeidiSQL, phpMyAdmin…). If youritemstable has alimitcolumn instead ofweight, change it in the file first.
Item images are not included. Put your own PNG files in your inventory’s image folder if you want icons.
Check the stall items too. The stalls sell beer, whiskey, sprunk, burger, sandwich and water by default. They must exist in your inventory. If not, change them in config/economy.lua (see Configuration).
6. Restart the WHOLE server
- Stop the server completely and start it again. Do not just type
ensure vault-festivalorrestart vault-festival. - Every player (you too) must disconnect and connect again.
Why? The festival brings new 3D models. The game only loads new models when the server starts and the player connects. With a simple restart of the resource, the stage is missing or appears half built.
7. Escrow (license) check
This resource is protected by the Cfx.re Asset Escrow. Your server’s license key must belong to the same Cfx.re account that bought the resource.
If the server console shows an error like “You lack the required entitlement”, the license key belongs to another account. Use a key from the account that bought it, or transfer the asset to the right account in the Cfx.re portal.
8. Final check
- Look at the server console when it starts. There should be no red errors from
vault-festival. - Join the server.
- By default the festival is already built, on its island, in the sea off Del Perro beach. Fly there, or go to the spot you want and type
/festival here. - Type
/festival console. The lighting console should open on the left of your screen. - Type
/festival admin. The admin panel should open.
If something fails, see Troubleshooting and FAQ.
Next steps
Updating to a new version
- Make a copy of your
config/andlocales/folders, and of yourmusic/andshows/folders. - Replace the
vault-festivalfolder with the new one. - Put your copies back.
- Restart the whole server.
Your saved data (position, theme, set-up pieces, light shows) is kept.