Commands and permissions
Who can do what
There are three kinds of player:
| Kind | Who | What they can do |
|---|---|---|
| Player | Everyone | Watch, listen, buy tickets and drinks, choose their own graphics quality. |
| Operator | Players with vault-festival.operate, players with an operator job, and players with temporary access |
Run the show: console, portable desk, touch screens, set-up editor, change the theme. |
| Admin | Players with vault-festival.admin |
Everything an operator can do, plus: the admin panel, moving, mounting and unmounting the festival. |
An admin is always an operator too.
Giving permissions
In server.cfg:
# Admins: everything
add_ace group.admin vault-festival.admin allow
# Optional: moderators run the lights
add_ace group.mod vault-festival.operate allow
You can give it to one player too:
add_ace identifier.fivem:123456 vault-festival.operate allow
Operator jobs
Players with a job listed in config/permissions.lua are operators while they have that job:
operatorJobs = { 'festival' },
The job must exist in your framework. This script does not create it.
Temporary access and blocks
From the admin panel, an admin can:
- Give temporary access to a player for 1 to 1440 minutes. It ends when the time runs out or the player leaves the server.
- Close the console of an operator and block them for some minutes. Admins cannot be blocked.
Who can move the venue?
In config/permissions.lua:
venueAdminOnly = true,
true(default): only admins can move (here), mount and unmount the festival.false: operators can do it too.
Changing the theme is always allowed to operators.
Commands
The command is /festival by default. You can change its name with Config.Command in config/general.lua. Type /festival alone to see the list.
| Command | Who | What it does |
|---|---|---|
/festival |
Everyone | Shows the list of actions. |
/festival console |
Operator | Opens the lighting console. |
/festival desk |
Operator | Takes out or puts away the portable desk. |
/festival setup |
Operator | Opens the set-up editor. |
/festival admin |
Admin | Opens the admin panel. |
/festival here |
Admin * | Moves the festival to your position and direction. |
/festival mount |
Admin * | Builds the festival for everyone. |
/festival unmount |
Admin * | Takes the festival down for everyone. |
/festival theme <id> |
Operator | Changes the theme: amphitheatre, leviathan, observatory, phoenix, clockwork or spire. Without an id it shows the list. |
/festival quality <low|medium|high> |
Everyone | Your own graphics quality. Saved on your computer. |
* Operators too, if venueAdminOnly = false.
Tools (everyone, only on your own screen)
These help to test and tune. They change nothing for other players.
| Command | What it does |
|---|---|
/festival debug |
Shows a line with lights on, beam pieces drawn, real lights and FPS. It also marks the pyro points in yellow. |
/festival cap <n> |
Changes how many beam pieces your game draws per frame (default 1200, 0 = no limit). Only until you reconnect. For testing. |
/festival faces <1|-1|2> |
Test of the faces setting of beams (see Configuration). |
/festival ptfx <dict> <fx> [scale] |
Fires a particle 6 m in front of you, to test it. |
Keys
Default keys. Each player can change them in Settings > Key Bindings > FiveM (entries that start with “Festival:”). Server owners can change the defaults in config/controls.lua.
| Key | What it does | When |
|---|---|---|
| F7 | Open or close the console | With the desk out, or with the console open |
| F9 | Put the desk away | Desk out |
| J (hold) | Flash and blinders | Desk out |
| 6 (hold) | Full strobe | Desk out |
| O | Blackout | Desk out |
| 7 / 8 | Previous scene / GO (next scene) | Desk out |
| 9 | Next palette | Desk out |
| 0 | Tap tempo | Desk out |
| Page Up / Page Down | Master up / down | Desk out |
| Insert (hold) | Smoke | Desk out |
| Delete (hold) | CO2 (armed) | Desk out |
| End (hold) | Flames (armed) | Desk out |
| (none) | Freeze | Desk out |
| Left Alt (hold) | Touch the desk screens | Near a lighting desk |
| (none) | Open the admin panel | Anytime (admins) |
Console shortcuts are listed in the In-game guide.