Configuration
All settings are in the config/ folder. Each file is about one topic and has comments that explain every line.
Before you start
- Open the files with a text editor (Notepad++, VS Code). Not with Word.
- Change only the value on the right of the
=. - Keep the commas
,and quotes'...'as they are. - After a change, restart the resource (
restart vault-festival). Players inside the festival may need to reconnect. After installing or updating the festival, or adding music files, restart the whole server instead. - If you delete a line or put a wrong value, the festival uses the default value and writes a warning in the server console. It does not break.
- A missing comma, quote or bracket is different: the file cannot be read. The server console shows the file name and the line number. Fix it and restart.
Some settings are only the starting value: the theme, the position, the island and the default quality. Once an admin changes them in game, the server remembers the game choice and the config value is not used any more.
| File | What is inside |
|---|---|
| general.lua | Language, command name, starting position, view distance. |
| permissions.lua | Permissions and operator jobs. |
| stage.lua | The themes. |
| island.lua | The park island. |
| audio.lua | Volume, distance and the song list. |
| quality.lua | Graphics quality and beams. |
| effects.lua | Pyro and effect particles. |
| economy.lua | Tickets, stalls and lockers. |
| controls.lua | Portable desk and default keys. |
| building.lua | Limits of the set-up editor. |
general.lua
| Setting | Default | What it does |
|---|---|---|
Config.Locale |
'en' |
Language of every text and screen. 'en' English, 'es' Spanish. See Languages. |
Config.Command |
'festival' |
Name of the command. With 'fest', players type /fest console. |
Config.DefaultOrigin |
vector4(-2400.0, -1300.0, 1.5, 310.0) |
Starting position: x, y, z and the direction the stage faces. In the sea off Del Perro. Only used until someone moves the festival. “Move to default spot” in the admin panel goes back here. |
Config.DrawDistance |
800.0 |
Metres. Farther than this, the festival is not shown and nothing can be bought. |
How to get a position: stand at the spot and use your admin menu’s “copy coords” option, or simply use /festival here in game (easier).
permissions.lua
Config.Permissions = {
operate = 'vault-festival.operate',
admin = 'vault-festival.admin',
operatorJobs = { 'festival' },
venueAdminOnly = true,
}
| Setting | What it does |
|---|---|
operate |
Permission name for operators. |
admin |
Permission name for admins. |
operatorJobs |
Jobs that can operate. {} = none. Example: { 'festival', 'dj' }. |
venueAdminOnly |
true: only admins move, mount and unmount the festival. false: operators can too. |
More: Commands and permissions.
stage.lua
| Setting | Default | What it does |
|---|---|---|
Config.Themes |
all six | The themes players can choose. To hide one, delete its line. Do not change the ids. label is the name shown: a text, or a key from the language file. |
Config.DefaultTheme |
'amphitheatre' |
The starting theme. Only used until someone chooses one. |
Example, hiding the Clockwork city and renaming the Spire:
Config.Themes = {
{ id = 'amphitheatre', label = 'theme_amphitheatre' },
{ id = 'leviathan', label = 'theme_leviathan' },
{ id = 'observatory', label = 'theme_observatory' },
{ id = 'phoenix', label = 'theme_phoenix' },
{ id = 'spire', label = 'The White Tower' },
}
island.lua
Config.Island = {
enabled = true,
vegetation = true,
heightOverWater = 1.5,
heightOverLand = 0.1,
}
| Setting | What it does |
|---|---|
enabled |
true: the festival stands on its island. false: on the map ground. |
vegetation |
false removes about 500 trees, bushes and rocks. Use it if players crash or objects disappear near the festival. |
heightOverWater |
Metres above the sea when you place it in the water. |
heightOverLand |
Metres above the ground when you place it on land. |
enabled and vegetation are only the starting values: the admin panel changes them live.
audio.lua
| Setting | Default | What it does |
|---|---|---|
Config.Audio.range |
350.0 |
Metres where the music can no longer be heard. The live screens also turn on inside this distance. |
Config.Audio.fullVolumeRange |
40.0 |
Inside this distance, full volume. |
Config.Audio.volume |
0.8 |
Maximum volume, from 0.0 to 1.0. |
Config.Tracks |
empty | Your songs. |
Adding songs:
Config.Tracks = {
{ name = 'Opening set', file = 'opening.ogg' }, -- file in music/
{ name = 'Closing set', url = 'https://example.com/b.ogg' }, -- direct link
}
More: Music.
quality.lua
Each player chooses Low, Medium or High with /festival quality. These are what each level means:
Config.Quality = {
low = { lights = 8, beams = 0.5, lensFlares = false },
medium = { lights = 16, beams = 1.0, lensFlares = true },
high = { lights = 32, beams = 1.0, lensFlares = true },
}
| Setting | What it does |
|---|---|
lights |
How many lights shine real light on the ground and buildings at once. This costs the most FPS. |
beams |
Share of light beams drawn. 0.5 = half, 1.0 = all. |
lensFlares |
The bright dot on each light. |
Config.DefaultQuality |
Quality for players who have not chosen. 'medium'. The admin panel can change it. |
Config.Render.technique |
How beams are drawn: 1 flat, 2 with a soft fade (default), 3 thin lines (cheapest). |
Config.Render.beamLength |
Beam length in metres for each type (beam, spot, wash, laser). |
Config.Render.beamWidth |
Beam width at the far end, in metres. |
Config.Render.faces |
2 (default): beams always visible. 1 or -1: half the cost, but beams may only be visible from one side. Test with /festival faces 1 and /festival faces -1 and keep the one that looks right. |
Config.LiveScreens |
true: LED screens show live visuals and the desks have touch screens. false: static image, no touch screens, better FPS. |
effects.lua
Each effect is a game particle: a dictionary (dict), an effect (fx) and a size (scale).
Config.Pyro = {
flames = { { dict = 'core', fx = 'ent_sht_flame', scale = 5.0 } },
-- co2, sparks, comets, fireworks, confetti...
}
If a list has several, each shot picks one at random.
| Group | Effects |
|---|---|
Config.Pyro |
flames, co2, sparks, comets, fireworks, confetti |
Config.Effects |
smoke, low_fog, smoke_jets, streamers, bubbles, haze, fountains, waterfalls, waterfall_splash |
Config.EffectCooldown |
400: milliseconds between two manual shots of the same effect. |
If an effect does not show: some particles do not exist on every game version. Test another one:
- In game, type
/festival ptfx core ent_sht_flame 2.0(dictionary, effect, size). It appears 6 m in front of you. - When you find one you like, put it in the file under the effect you want.
- Restart the resource.
/festival debug shows the pyro points in yellow. Particles must shoot upwards: one that shoots sideways cannot be rotated, choose another.
economy.lua
Tickets
Config.Tickets = {
required = true,
graceSeconds = 15,
general = { item = 'festival_wristband', price = 150 },
vip = { item = 'festival_wristband_vip', price = 600 },
}
| Setting | What it does |
|---|---|
required |
true: you need a wristband inside the fence. false: anyone can enter (the booths still sell). |
graceSeconds |
Seconds without a wristband before being taken to the entrance. |
item |
The item name in your inventory. |
price |
The price. |
Example: free festival. Set required = false.
Example: cheaper tickets. general = { item = 'festival_wristband', price = 50 }.
Stalls
Config.Stalls = {
bar = { label = 'stall_bar', items = { { item = 'beer', price = 12 }, { item = 'whiskey', price = 20 }, { item = 'sprunk', price = 6 } } },
food = { label = 'stall_food', items = { { item = 'burger', price = 15 }, { item = 'sandwich', price = 10 } } },
water = { label = 'stall_water', items = { { item = 'water', price = 5 } } },
merch = { label = 'stall_merch', items = {} },
}
- Every
itemmust exist in your inventory. With ox_inventory that stall sells nothing and the server console warns you at start. With the QBCore or ESX inventory there is no warning: the purchase fails with “It does not fit in the inventory” and the money is given back. Check the item names. items = {}= that stall sells nothing.
Example: sell a T-shirt at the merch stall.
merch = { label = 'stall_merch', items = { { item = 'festival_tshirt', price = 40 } } },
(You must create the festival_tshirt item in your inventory first.)
Lockers
| Setting | Default | What it does |
|---|---|---|
Config.Lockers.slots |
20 |
Slots of each personal locker. |
Config.Lockers.maxWeight |
30000 |
Maximum weight, in grams. |
Lockers only work with ox_inventory.
controls.lua
Portable desk
| Setting | Default | What it does |
|---|---|---|
Config.Desk.item |
'festival_desk' |
The item that takes out the desk. |
Config.Desk.requireItem |
true |
false: operators can use /festival desk without the item. |
Default keys
Config.Keys = {
console = 'F7', putAway = 'F9', blinders = 'J', strobe = '6', blackout = 'O',
previous = '7', go = '8', nextPalette = '9', tap = '0',
masterUp = 'PAGEUP', masterDown = 'PAGEDOWN',
smoke = 'INSERT', co2 = 'DELETE', flames = 'END', freeze = '',
touchScreens = 'LMENU', admin = '',
}
- Use FiveM key names:
'F7','J','LMENU'(left Alt),'LCONTROL','PAGEUP'…''= no key. - Important: these are only the first-time keys. A player who already joined keeps the keys they had. Each player changes them in Settings > Key Bindings > FiveM.
F7is used by billing on many ESX servers, andLMENU(Alt) by the pma-voice radio. Change them before opening your server to players if you have those scripts.
building.lua
Limits of the set-up editor:
| Setting | Default | What it does |
|---|---|---|
Config.Building.maxPieces |
30 |
Maximum pieces placed at once. |
Config.Building.maxFixtures |
64 |
Maximum extra lights across all pieces. |
Config.Building.radius |
250.0 |
Maximum metres from the stage. |
More pieces cost more FPS for everyone near the festival.
Advanced: scenes and palettes
The file shared/escenas.lua holds the 13 scenes and 8 colour palettes. It is open so advanced users can edit them.
- Make a copy of the file before you touch it.
- A palette is three colours in RGB (0 to 255). Example:
{ nombre = 'Ocean', { 0, 110, 255 }, { 0, 255, 210 }, { 255, 255, 255 } }, - To change a scene, copy an existing one and change its values. The comments in the file explain each field.
- Saved light shows remember scenes by name and palettes by position. If you delete or reorder them, press Regenerate on your shows.
- The names shown in the console come from the language file, not from this file. To rename a scene, change
nombresEscenainlocales/<language>.lua. Palettes are named by position innombresPaleta: if you add a 9th palette, add a 9th name there too.