# Configuration structure
## 1. Box Configuration
Use the path `stylegroup_battleroyale\shared\config\loots` If you want to modify loot box locations on specific maps.
## 2. Vehicle Settings
Use the path `stylegroup_battleroyale\shared\config\vehicles` If you want to add other types of vehicles and vehicle span coordinates to specific maps.
## 3. Patents and Rewards
In this configuration step, you can set up the complete Patent/Rank and reward system. You will specify the reward items for each patent, as well as the points required to achieve each patent, and their names if you wish to modify them.
```lua
[1] = {
minPoints = 50, -- QUANTIDADE MINIMA DE PONTOS DA PRIMEIRA PATENTE
name = 'Esmeralda', -- NOME QUE IRA APARECER DA PATENTE
photo = 'esmeralda', -- NOME DA IMAGEM DA PATENTE // PARA ALTERAR ACESSE A PASTA INTERFACE DO SCRIPT E APENAS SUBSTITUA A IMAGEM
prizes = { -- ITENS QUE SERÁ POSSIVEL RESGATAR APÓS ATINGIR A PATENTE ESPECIFICA
{ name = 'Vip Qualquer', image = 'https://support.pbisrewards.com/wp-content/uploads/2021/09/article-reward-group.png', type = 'role', amount = nil, spawn = 'Ballas' },
{ name = 'Five Seven', image = 'http://YOUR-IP/scriptbattleroyale/WEAPON_PISTOL_MK2.png', type = 'item', amount = 1, spawn = 'WEAPON_PISTOL_MK2' },
{ name = 'Moeda', image = 'http://YOUR-IP/scriptbattleroyale/Dinheiro.png', type = 'money', amount = 1, spawn = 'dollar' },
{ name = 'Akuma', image = 'https://docs.fivem.net/vehicles/akuma.webp', type = 'vehicle', amount = nil, spawn = 'akuma' },
{ name = 'Diamante', image = 'http://YOUR-IP/scriptbattleroyale/Diamante.png', type = 'gems', amount = 1, spawn = 'dollar' },
},
},
```
It is possible to award different types of rewards to the winning team, such as:
* Server-specific items.
* Permission groups such as VIPs and others.
* Vehicles.
* Gem system.
* Money.
## 4. Points in the match
Use the data in this field to indicate the number of points a player will score for a kill and the score the top 10 players will receive at the end of the event.
```lua
Config.Points = { -- CONFIGURAÇÕES DE PONTUAÇÕES DENTRO DOS EVENTOS
['kill'] = 1, -- TOTAL DE PONTOS POR KILL FEITA DENTRO DO EVENTO [MODO FFA NÃO É LEVADO EM CONSIDERAÇÃO]
['win'] = 5, -- NÃO MEXA AQUI [APENAS UMA SEGURANÇA CASO VOCÊ MODIFIQUE ERRADO OS PONTOS DE 1 A 10º]
['Rank'] = {
[1] = 10, -- TOTAL DE PONTOS DE QUEM FICAR EM PRIMEIRO LUGAR NO EVENTO
[2] = 9, -- TOTAL DE PONTOS DE QUEM FICAR EM SEGUNDO LUGAR NO EVENTO
[3] = 8, -- TOTAL DE PONTOS DE QUEM FICAR EM TERCEIRO LUGAR NO EVENTO
[4] = 7, -- TOTAL DE PONTOS DE QUEM FICAR EM QUARTO LUGAR NO EVENTO
[5] = 6, -- TOTAL DE PONTOS DE QUEM FICAR EM QUINTO LUGAR NO EVENTO
[6] = 5, -- TOTAL DE PONTOS DE QUEM FICAR EM SEXTO LUGAR NO EVENTO
[7] = 4, -- TOTAL DE PONTOS DE QUEM FICAR EM SETIMO LUGAR NO EVENTO
[8] = 3, -- TOTAL DE PONTOS DE QUEM FICAR EM OITAVO LUGAR NO EVENTO
[9] = 2, -- TOTAL DE PONTOS DE QUEM FICAR EM NOVO LUGAR NO EVENTO
[10] = 1 -- TOTAL DE PONTOS DE QUEM FICAR EM DECIMO LUGAR NO EVENTO
}
}
```
Do not tamper with the code \[win]; it is only a validation in case you make a mistake or delete something in the first 10 positions.
## 5. Match Duration \[Safe Sync]
Modifying this field requires full attention to avoid problems. The data added to the `"maxtimer"` field works in sync with the data added to `"maxZones"` within the `maps.lua` file.
That is, by default we are sending the script set to a duration of 600 seconds to be distributed across a total of 5 safe zones.
This means that the match will last 10 minutes and will be divided equally among each safe zone.
```lua
Config.GameModes = { -- TEMPO TOTAL DE CADA MODO DE PARTIDA EM SEGUNDOS [OU SEJA, O TEMPO COLOCADO AQUI, SERÁ DIVIDIDO PELO NUMERO DE SEIF COLOCADO EM "maxZones" DENTRO DE MAPS.LUA ]
['solo'] = {
maxTimer = 600 -- 600 SEGUNDOS = [10MINUTOS DE PARTIDA] LOGO 10MINUTOS/DIVIDO POR 5[NUMERO DE SEIF] = 2MINUTOS POR SEIF
},
['duo'] = {
maxTimer = 600 -- 600 SEGUNDOS = [10MINUTOS DE PARTIDA] LOGO 10MINUTOS/DIVIDO POR 5[NUMERO DE SEIF] = 2MINUTOS POR SEIF
},
['trio'] = {
maxTimer = 600 -- 600 SEGUNDOS = [10MINUTOS DE PARTIDA] LOGO 10MINUTOS/DIVIDO POR 5[NUMERO DE SEIF] = 2MINUTOS POR SEIF
},
['squad'] = {
maxTimer = 600 -- 600 SEGUNDOS = [10MINUTOS DE PARTIDA] LOGO 10MINUTOS/DIVIDO POR 5[NUMERO DE SEIF] = 2MINUTOS POR SEIF
},
['custom'] = {
maxTimer = 600 -- 600 SEGUNDOS = [10MINUTOS DE PARTIDA] LOGO 10MINUTOS/DIVIDO POR 5[NUMERO DE SEIF] = 2MINUTOS POR SEIF
}
}
```
If you want to increase or decrease the match duration, remember to also modify the number of safe zones.
## 6. Podium FFA
Only the highest-ranked players in Battle Royale will be visible in the HALL.
```lua
Config.Podium = { -- LOCALIZAÇÕES DOS NPC DO PODIUM DE RANK [TOP 5 JOGADORES]
[1] = {
coords = vector4(-3761.74, -3819.89, 1490.57, 181.42), -- LOCALIZAÇÃO NPC
ped = 'mp_m_bogdangoon' -- MODELO NPC
},
[2] = {
coords = vector4(-3756.52, -3817.38, 1490.57, 178.59), -- LOCALIZAÇÃO NPC
ped = 'mp_m_bogdangoon' -- MODELO NPC
},
[3] = {
coords = vector4(-3766.76, -3817.48, 1490.57, 175.75), -- LOCALIZAÇÃO NPC
ped = 'mp_m_bogdangoon' -- MODELO NPC
},
[4] = {
coords = vector4(-3759.46, -3813.81, 1490.57, 181.42), -- LOCALIZAÇÃO NPC
ped = 'mp_m_bogdangoon' -- MODELO NPC
},
[5] = {
coords = vector4(-3763.92, -3813.96, 1490.57, 175.75), -- LOCALIZAÇÃO NPC
ped = 'mp_m_bogdangoon' -- MODELO NPC
},
}
```
## 7. Monetization System
A major advantage of Battle Royale is its automatic management capability, eliminating the need for server administration.
We have the following information available;
```lua
Monetize = { -- SISTEMA PARA SER USADO CASO VOCÊ QUEIRA MONETIZAR SEU SERVIDOR USANDO O BATTLE ROYALE [ENTREGA DE PERMISSÃO APÓS AQUISIÇÃO/LOJA]
PermissionEvents = false, -- SE AQUI ESTIVER [TRUE] O COMANDO /EVENTS PASSAR A TER UMA VERIFICAÇÃO DE PERMISSÃO PARA SER USADO / [FALSE] TODOS PODEM ACESSAR
Permissions = { -- ADICIONE OS GRUPOS/PERMISSÃO QUE PODEM USAR O COMANDO EVENTS CASO ADICIONE [TRUE] EM "PermissionEvents"
'TorneioBattle',
'torneiosbattle.permissao'
}
},
```
If you set `"PermissionEvents"` to true, all created events will be checked to see if the player is in a specific group. This group can then be sold in your city store as registrations/vacancies.
Add the names of your server's groups within `"Permissions"`
## 8. Audio settings
The Battle Royale has 4 types of sounds available during events. These are:
* 1 - \[countdown] - 10-second countdown in FFA to start the Battle Royale event.
* 2 - \[gazmexendo] - Information that the gas is starting to move.
* 3 - \[heartbeat] - Heartbeat indicating that you are outside the safe zone and losing health.
* 4 - \[newgas] - This audio will play every time a new safe zone is created on the map.
If you wish to change the audio to other models, just remember to use the same name as the original file.
To modify the audio files, go to the directory:
`stylegroup_stream_battleroyale\web-side\audios`
## 9. Images and logo
If you want to change any image in the Battle Royale script or to insert your server logo, simply go to the directory:
`stylegroup_battleroyale\interface\assets`
## 10. Image Hosting
The script also has images that need to be hosted somewhere to be available for viewing in the script, such as all the images of:
* Weapons.
* Icons.
You must add the images to the directory of your local machine \[VPS]:
`xampp\htdocs`
Or to any other location where you want to host the images. After performing this action, go to the script's configuration files in gamemode.lua and maps.lua and change the YOUR-IP field to the IP address of your hosting location.
## 11. Reset Database
The Battle Royale mode features a system of Ranks, redeemed Rewards, and all player history data within a match.
\
However, we have a way to reset this data if your server wants to at some point.
\
Within the directory;
`stylegroup_battleroyale\shared\config/gamemode.lua`
\
We have made the variable available with the command;
```lua
CommandResetRanking = 'resetranking', -- Command to reset data
```
By using this command, you will be completely clearing the database.
All data already retrieved by the player will be locked again until they reach the required rank again.
The ranking section will be completely reset with no information displayed.
## 12. Maps and vehicles
The Battle Royale mode includes the exclusive FFA Map, exclusive to our product.
It also comes with 2 types of exclusive aircraft.
Model 1 Plane
Model 2 Plane
Model car
