Skip to content

Commit e6289db

Browse files
committed
feat(vzn-cleanerjob): improve config
1 parent e633184 commit e6289db

1 file changed

Lines changed: 12 additions & 9 deletions

File tree

pages/vzn-cleanerjob/config.mdx

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,19 @@
66

77
### LOGS
88

9-
To Configure logs go to `config_server.lua` and put here your discord webhook
9+
To Configure logs go to `config/config_server.lua` and put here your discord webhook
1010

1111
- if you want to edit logs logic go to `server/editable/functions.lua` on function called `SendLog`
1212

13-
```lua filename="config.lua"
13+
```lua filename="config/config.lua"
1414
-- your wehbhook where logs will be sent
1515
---@type string
1616
SConfig.LogWebhook = "your_webhook_here"
1717
```
1818

1919
### FRAMEWORK NAMES
2020

21-
```lua filename="config.lua"
21+
```lua filename="config/config.lua"
2222
--- If you have custom name of exports / resourceName, change it here to script can works correctly.
2323
--- If you wanna connect your custom framework look at bridge/custom/*.lua.
2424
--- If you wanna edit your framework functions etc look at bridge/your_framework/*.lua
@@ -37,9 +37,9 @@ Config.Framework = {
3737

3838
### JOB NAME
3939

40-
if you want to change job name required to do job change it in `config.lua`
40+
if you want to change job name required to do job change it in `config/config.lua`
4141

42-
```lua filename="config.lua"
42+
```lua filename="config/config.lua"
4343
--- job name that player needs have to use job (remember to add job to db for ESX or to jobs.lua for QBCore)
4444
---@type string
4545
Config.JobName = "cleaner"
@@ -50,7 +50,7 @@ Config.JobName = "cleaner"
5050
- If player should earn money in cash, set this field to `cash` (ESX too, not money)
5151
- If player should earn money in bank account, set this field to `bank`
5252

53-
```lua filename="config.lua"
53+
```lua filename="config/config.lua"
5454
--- in which method player will be getting salary for job
5555
---@type 'cash' | 'bank'
5656
Config.SalaryMethod = "cash"
@@ -63,7 +63,7 @@ Config.SalaryMethod = "cash"
6363
- pedHeading: `number` heading of ped
6464
- vehiclesSpawnPoints `vector4[]` points where vehicles will be spawn (if first is busy, vehicle will be spawned on second etc)
6565

66-
```lua filename="config.lua"
66+
```lua filename="config/config.lua"
6767
Config.StartJob = {
6868
pedModel = "cs_bankman",
6969
pedCoords = vec3(1231.49, -1083.04, 38.51),
@@ -85,7 +85,7 @@ Config.StartJob = {
8585
- xp: `number` multiplier how much player earn more xp for work with friend
8686
- you can edit bonus logic in `server/editable/functions.lua` in function called `WorkWithFriendBonus`
8787

88-
```lua filename="config.lua"
88+
```lua filename="config/config.lua"
8989
--- multipliers of amounts if player work with friend
9090
Config.WorkWithFriendBonus = {
9191
money = 1.15,
@@ -99,7 +99,7 @@ Config.WorkWithFriendBonus = {
9999
- male: `table` clothes for male
100100
- female: `table` clothes for female
101101

102-
```lua filename="config.lua"
102+
```lua filename="config/config.lua"
103103
Config.Clothes = {
104104
enabled = true, -- if you set it to false, player clothes won't change in job,
105105
male = {
@@ -125,6 +125,7 @@ Config.Clothes = {
125125

126126
### PAVEMENT CLEANING
127127

128+
- `config/config_pavementCleaning.lua`
128129
- minXP: `number` minimum xp player need to work in this type
129130
- type: `"pavementCleaning"` dont change
130131
- data: `table`
@@ -143,6 +144,7 @@ Config.Clothes = {
143144

144145
### APARTMENT CLEANING
145146

147+
- `config/config_apartmentCleaning.lua`
146148
- minXP: `number` minimum xp player need to work in this type
147149
- type: `"apartmentCleaning"` dont change
148150
- data: `table`
@@ -163,6 +165,7 @@ Config.Clothes = {
163165

164166
### ROAD CLEANING
165167

168+
- `config/config_roadCleaning.lua`
166169
- minXP: `number` minimum xp player need to work in this type
167170
- type: `"roadCleaning"` dont change
168171
- data: `table`

0 commit comments

Comments
 (0)