Config File

A copy of the config file is here

Config = Config or {}

Config.Debug = false -- Set to false on live server. Only used for testing and restarting the script frequently.

Config.UseSynSociety = false -- Using SynSociety will disable the society system in this script and use SynSociety instead. This script will become multijob system only

Config.Locale = 'en' -- Create more in language folder and share on discord :).

Config.BossMenuLocationDistance = 2.0 -- When to display to open the boss menu

Config.EmployeeListSorting = "firstname" -- Sort by "firstname" or "lastname" or "backwardsfirstname" or "backwardslastname" or "none"

Config.AllowSocietyWebhooks = true -- Allow societies to have their own webhooks to get notified in discord seperately. If false, it will only disable being able to set on client side. So recommended to decide when welcoming this script. 

--[[
 âââââââ âââââââ ââââ   ââââââââ   ââââ ââââââ ââââ   ââââââââââ ââââââââ
ââââââââââââââââââââââ ââââââââââ ââââââââââââââââââ  âââââââââââââââââââ
âââ     âââ   âââââââââââââââââââââââââââââââââââââââ ââââââ  âââââââââââ
âââ     âââ   ââââââââââââââââââââââââââââââââââââââââââââââ  âââââââââââ
ââââââââââââââââââââ âââ ââââââ âââ ââââââ  ââââââ ââââââââââââââââââââââ
 âââââââ âââââââ âââ     ââââââ     ââââââ  ââââââ  ââââââââââââ ââââââââ
--> Below are commands that are used by admins to manage societies. For groupsAllowed, you use the group names such as "admin", "superadmin", "owner" etc. These are linked to the VORP User Table.
--> There are 3 duty commands for all players. Only enabled when Config.DutySystem is enabled.
]]
local StaffGroups = {
    ['headmoderator'] = true,
    ['admin'] = true,
    ['superadmin'] = true,
    ['owner'] = true,
}
Config.Commands = {
    SetJob = { command = "setjob", help = "Set a player's job", params = {{name = "id", help = "Player Id"}, {name = "job", help = "Job Name"}, {name = "grade", help = "Job Grade"}}, groupAllowed = StaffGroups},
    RemoveJob = { command = "removejob", help = "Remove a job from player", params = {{name = "id", help = "Player Id"}, {name = "job/ current", help = "Job Name, leave blank for current job"}}, groupAllowed = StaffGroups},
    CreateJob = { command = "createjob", help = "Create a job", params = {{name = "job", help = "Job Name"}, {name = "label", help = "Job Label"}}, groupAllowed = StaffGroups},
    DeleteJob = { command = "deletejob", help = "Delete a job", params = {{name = "job", help = "Job Name"},}, groupAllowed = StaffGroups},
    SetBossMenuLocation = { command = "setbossmenu", help = "Set boss menu location at current spot", params = {{name = "job", help = "Job Name"},}, groupAllowed = StaffGroups},
    ManageBossMenuLocation = { command = "managebossmenu", help = "Delete/ TP boss menu location", params = {{name = "job", help = "Job Name"},}, groupAllowed = StaffGroups},
    JobMenu = { command = "jobmenu", help = "Open the job menu" }, -- Job Menu command for players to open their job menu
    OnDuty = { command = "onduty", help = "Toggle on/off duty status" }, -- This command is used to toggle on duty status for the player. (Config.DutySystem.Enabled must be true)
    OffDuty = { command = "offduty", help = "Toggle off duty status" }, -- This command is used to toggle off duty status for the player. (Config.DutySystem.Enabled must be true)
    ToggleDuty = { command = "toggleduty", help = "Toggle on/off duty status" }, -- This command is used to toggle on/off duty status for the player. (Config.DutySystem.Enabled must be true)
    Bill = { command = "bill", help = "Bill a player for services", params = {{name = "id", help = "Player Id"}, {name = "amount", help = "Amount to bill"}}},
    ViewBills = { command = "viewbills", help = "View all bills for a society", },
}


--[[
âââââââ âââ   âââââââââââââââ   âââ    âââââââââââ   ââââââââââââââââââââââââââââââââ   ââââ
âââââââââââ   ââââââââââââââââ ââââ    ââââââââââââ ââââââââââââââââââââââââââââââââââ âââââ
âââ  ââââââ   âââ   âââ    âââââââ     ââââââââ âââââââ ââââââââ   âââ   ââââââ  âââââââââââ
âââ  ââââââ   âââ   âââ     âââââ      ââââââââ  âââââ  ââââââââ   âââ   ââââââ  âââââââââââ
âââââââââââââââââ   âââ      âââ       ââââââââ   âââ   ââââââââ   âââ   âââââââââââ âââ âââ
âââââââ  âââââââ    âââ      âââ       ââââââââ   âââ   ââââââââ   âââ   âââââââââââ     âââ
--> Allows a variable to be used to check if player is on duty or not.
--> If false, it will disable the on/off duty system and will not check if player is on duty.
--> If you want to use the duty system, you need to set Enabled to true. No need to delete the commands they will be disabled automatically.
--> If you want to use the regional duty system, you need to set RegionalDuty to a table with job names and locations. This is mainly used for police job.
--> How to include in other scripts? Check our documentation. Link is in the README.md file.
]]
Config.DutySystem = {
    Enabled = true, -- Enable or disable the duty system
    RegionalDuty = {
        ["police"] = { -- Job name
            ["valentine"] = {label = "Valentine Police Station", description = "Sheriff's Office"},
            ["strawberry"] = {label = "Strawberry Police Station", description = "Sheriff's Office"},
            ["rhodes"] = {label = "Rhodes Police Station", description = "Sheriff's Office"},
            ["blackwater"] = {label = "Blackwater Police Station", description = "Sheriff's Office"},
        },
    }
}


--[[
     âââ âââââââ âââââââ     ââââ   ââââââââââââââââ   ââââââ   âââ
     ââââââââââââââââââââ    âââââ ââââââââââââââââââ  ââââââ   âââ
     ââââââ   âââââââââââ    âââââââââââââââââ  ââââââ ââââââ   âââ
ââ   ââââââ   âââââââââââ    âââââââââââââââââ  âââââââââââââ   âââ
âââââââââââââââââââââââââ    âââ âââ ââââââââââââââ âââââââââââââââ
 ââââââ  âââââââ âââââââ     âââ     ââââââââââââââ  âââââ âââââââ 
--> Set how many jobs a player can have. If false, it will disable the job limit.
--> To disable job menu, remove the command from Config.Commands.JobMenu.command
]]
Config.JobMenu = {
    MaxJobsPerPlayer = 3, -- Max jobs per player or false to disable
    MaxJobsPerGroup = {
        ["owner"] = false, -- false means no limit
        ["superadmin"] = false,
        ["admin"] = false,
        ["headmoderator"] = 5,
        ["moderator"] = 5,
        ["discordmoderator"] = 5,
        ["helper"] = 4,
    }
}


--[[
âââââââ  ââââââ âââ   âââ     ââââââââââ  âââââââââââ ââââââââââ  âââ
ââââââââââââââââââââ ââââ    âââââââââââ  ââââââââââââââââââââââ ââââ
ââââââââââââââââ âââââââ     âââ     ââââââââââââââ  âââ     âââââââ 
âââââââ ââââââââ  âââââ      âââ     ââââââââââââââ  âââ     âââââââ 
âââ     âââ  âââ   âââ       âââââââââââ  ââââââââââââââââââââââ  âââ
âââ     âââ  âââ   âââ        ââââââââââ  âââââââââââ ââââââââââ  âââ
--> PayChecks are used to pay players for their work in the society. The paycheck is set by a boss in-game via bossmenu.
--> If you want to use the PayCheck system, you need to set Enabled to true.
]]
Config.PayChecks = {
    Enabled = true, -- Enable or disable the paycheck system
    Interval = 15, -- Every 15 minutes
    PayOutOfSocietyExcept = { -- Jobs that should not be paid out of society account
        ["police"] = true,
        ["doctor"] = true,
    },
    PayOnlyWhenOnDuty = true, -- Pay only when player is on duty (Config.DutySystem must be true)
    SetMaxPaycheck = false, -- Set max paycheck for all jobs allowed to set or false
    NotifyIfSocietyBroke = true, -- Notify player when not paid due to society being broke
}


--[[
âââââââââââââââââ ââââââ âââââââââââ  âââ
ââââââââââââââââââââââââââââââââââââ  âââ
ââââââââ   âââ   ââââââââââââââââââââââââ
ââââââââ   âââ   ââââââââââââââââââââââââ
ââââââââ   âââ   âââ  ââââââââââââââ  âââ
ââââââââ   âââ   âââ  ââââââââââââââ  âââ
--> Allows players to store items in a stash that is linked to the society.
--> If you want to use the stash, you need to set Enabled to true.
--> Have custom slot limits for certain jobs rather than using the default slots.
]]
Config.Stash = {
    Enabled = true,
    DefaultSlots = 10000, -- Default slots for the stash
    Slots = {
        ["police"] = 20000,
    }
}
Config.ManagementStash = {
    Enabled = true,
    DefaultSlots = 400, -- Default slots for the stash
    Slots = {
        ["police"] = 800,
    }
}


--[[
âââââââ ââââââ     âââ     âââââââ   âââ âââââââ     âââââââââââ   ââââââââââââââââââââââââââââââââ   ââââ
ââââââââââââââ     âââ     ââââââââ  âââââââââââ     ââââââââââââ ââââââââââââââââââââââââââââââââââ âââââ
ââââââââââââââ     âââ     âââââââââ ââââââ  ââââ    ââââââââ âââââââ ââââââââ   âââ   ââââââ  âââââââââââ
ââââââââââââââ     âââ     ââââââââââââââââ   âââ    ââââââââ  âââââ  ââââââââ   âââ   ââââââ  âââââââââââ
âââââââââââââââââââââââââââââââââ âââââââââââââââ    ââââââââ   âââ   ââââââââ   âââ   âââââââââââ âââ âââ
âââââââ âââââââââââââââââââââââââ  âââââ âââââââ     ââââââââ   âââ   ââââââââ   âââ   âââââââââââ     âââ
--> Allows players to bill other players for services. If you want to use the billing system, you need to set Enabled to true.
]]
Config.BillingSystem = {
    Enabled = true,
    DefaultMaxAmount = 5000, -- Max amount for a bill to avoid abuse, or set to false to disable limiter.
    MaxAmount = {
        ["police"] = false, -- false to disable limit
        ["doctor"] = 200, -- Max amount for doctor bills is 200
    },
    BillWithoutConfirmation = false, -- If true, customer will be not be asked to confirm the bill, money will come out instantly.
    BillWithoutConfirmationPerJob = { -- Overrides BillWithoutConfirmation for selected jobs
        ["police"] = true, -- If true, police can bill without confirmation
        ["doctor"] = true, -- If true, doctor can bill without confirmation
    },
    AllowNegativeMoney = false, -- If true, players can bill even if the customer has no money. This is mainly used for police and doctor jobs.
    AllowNegativeMoneyPerJob = { -- Overrides AllowNegativeMoney for selected jobs
        ["police"] = true, -- If true, police can bill even if the customer has no money
        ["doctor"] = true, -- If true, doctor can bill even if the customer has no money
    },
}


-- Deprecated. It is available but not recommended.
Config.BossMenuCommand = false -- "bossmenu" or false (to disable)

PreviousEZ Society & Job Menu NextExports

Last updated 20 days ago

Was this helpful?

Config = Config or {} Config.Debug = false -- Set to false on live server. Only used for testing and restarting the script frequently. Config.UseSynSociety = false -- Using SynSociety will disable the society system in this script and use SynSociety instead. This script will become multijob system only Config.Locale = 'en' -- Create more in language folder and share on discord :). Config.BossMenuLocationDistance = 2.0 -- When to display to open the boss menu Config.EmployeeListSorting = "firstname" -- Sort by "firstname" or "lastname" or "backwardsfirstname" or "backwardslastname" or "none" Config.AllowSocietyWebhooks = true -- Allow societies to have their own webhooks to get notified in discord seperately. If false, it will only disable being able to set on client side. So recommended to decide when welcoming this script. --[[ âââââââ âââââââ ââââ ââââââââ ââââ ââââââ ââââ ââââââââââ ââââââââ ââââââââââââââââââââââ ââââââââââ ââââââââââââââââââ âââââââââââââââââââ âââ âââ âââââââââââââââââââââââââââââââââââââââ ââââââ âââââââââââ âââ âââ ââââââââââââââââââââââââââââââââââââââââââââââ âââââââââââ ââââââââââââââââââââ âââ ââââââ âââ ââââââ ââââââ ââââââââââââââââââââââ âââââââ âââââââ âââ ââââââ ââââââ ââââââ ââââââââââââ ââââââââ --> Below are commands that are used by admins to manage societies. For groupsAllowed, you use the group names such as "admin", "superadmin", "owner" etc. These are linked to the VORP User Table. --> There are 3 duty commands for all players. Only enabled when Config.DutySystem is enabled. ]] local StaffGroups = { ['headmoderator'] = true, ['admin'] = true, ['superadmin'] = true, ['owner'] = true, } Config.Commands = { SetJob = { command = "setjob", help = "Set a player's job", params = {{name = "id", help = "Player Id"}, {name = "job", help = "Job Name"}, {name = "grade", help = "Job Grade"}}, groupAllowed = StaffGroups}, RemoveJob = { command = "removejob", help = "Remove a job from player", params = {{name = "id", help = "Player Id"}, {name = "job/ current", help = "Job Name, leave blank for current job"}}, groupAllowed = StaffGroups}, CreateJob = { command = "createjob", help = "Create a job", params = {{name = "job", help = "Job Name"}, {name = "label", help = "Job Label"}}, groupAllowed = StaffGroups}, DeleteJob = { command = "deletejob", help = "Delete a job", params = {{name = "job", help = "Job Name"},}, groupAllowed = StaffGroups}, SetBossMenuLocation = { command = "setbossmenu", help = "Set boss menu location at current spot", params = {{name = "job", help = "Job Name"},}, groupAllowed = StaffGroups}, ManageBossMenuLocation = { command = "managebossmenu", help = "Delete/ TP boss menu location", params = {{name = "job", help = "Job Name"},}, groupAllowed = StaffGroups}, JobMenu = { command = "jobmenu", help = "Open the job menu" }, -- Job Menu command for players to open their job menu OnDuty = { command = "onduty", help = "Toggle on/off duty status" }, -- This command is used to toggle on duty status for the player. (Config.DutySystem.Enabled must be true) OffDuty = { command = "offduty", help = "Toggle off duty status" }, -- This command is used to toggle off duty status for the player. (Config.DutySystem.Enabled must be true) ToggleDuty = { command = "toggleduty", help = "Toggle on/off duty status" }, -- This command is used to toggle on/off duty status for the player. (Config.DutySystem.Enabled must be true) Bill = { command = "bill", help = "Bill a player for services", params = {{name = "id", help = "Player Id"}, {name = "amount", help = "Amount to bill"}}}, ViewBills = { command = "viewbills", help = "View all bills for a society", }, } --[[ âââââââ âââ âââââââââââââââ âââ âââââââââââ ââââââââââââââââââââââââââââââââ ââââ âââââââââââ ââââââââââââââââ ââââ ââââââââââââ ââââââââââââââââââââââââââââââââââ âââââ âââ ââââââ âââ âââ âââââââ ââââââââ âââââââ ââââââââ âââ ââââââ âââââââââââ âââ ââââââ âââ âââ âââââ ââââââââ âââââ ââââââââ âââ ââââââ âââââââââââ âââââââââââââââââ âââ âââ ââââââââ âââ ââââââââ âââ âââââââââââ âââ âââ âââââââ âââââââ âââ âââ ââââââââ âââ ââââââââ âââ âââââââââââ âââ --> Allows a variable to be used to check if player is on duty or not. --> If false, it will disable the on/off duty system and will not check if player is on duty. --> If you want to use the duty system, you need to set Enabled to true. No need to delete the commands they will be disabled automatically. --> If you want to use the regional duty system, you need to set RegionalDuty to a table with job names and locations. This is mainly used for police job. --> How to include in other scripts? Check our documentation. Link is in the README.md file. ]] Config.DutySystem = { Enabled = true, -- Enable or disable the duty system RegionalDuty = { ["police"] = { -- Job name ["valentine"] = {label = "Valentine Police Station", description = "Sheriff's Office"}, ["strawberry"] = {label = "Strawberry Police Station", description = "Sheriff's Office"}, ["rhodes"] = {label = "Rhodes Police Station", description = "Sheriff's Office"}, ["blackwater"] = {label = "Blackwater Police Station", description = "Sheriff's Office"}, }, } } --[[ âââ âââââââ âââââââ ââââ ââââââââââââââââ ââââââ âââ ââââââââââââââââââââ âââââ ââââââââââââââââââ ââââââ âââ ââââââ âââââââââââ âââââââââââââââââ ââââââ ââââââ âââ ââ ââââââ âââââââââââ âââââââââââââââââ âââââââââââââ âââ âââââââââââââââââââââââââ âââ âââ ââââââââââââââ âââââââââââââââ ââââââ âââââââ âââââââ âââ ââââââââââââââ âââââ âââââââ --> Set how many jobs a player can have. If false, it will disable the job limit. --> To disable job menu, remove the command from Config.Commands.JobMenu.command ]] Config.JobMenu = { MaxJobsPerPlayer = 3, -- Max jobs per player or false to disable MaxJobsPerGroup = { ["owner"] = false, -- false means no limit ["superadmin"] = false, ["admin"] = false, ["headmoderator"] = 5, ["moderator"] = 5, ["discordmoderator"] = 5, ["helper"] = 4, } } --[[ âââââââ ââââââ âââ âââ ââââââââââ âââââââââââ ââââââââââ âââ ââââââââââââââââââââ ââââ âââââââââââ ââââââââââââââââââââââ ââââ ââââââââââââââââ âââââââ âââ ââââââââââââââ âââ âââââââ âââââââ ââââââââ âââââ âââ ââââââââââââââ âââ âââââââ âââ âââ âââ âââ âââââââââââ ââââââââââââââââââââââ âââ âââ âââ âââ âââ ââââââââââ âââââââââââ ââââââââââ âââ --> PayChecks are used to pay players for their work in the society. The paycheck is set by a boss in-game via bossmenu. --> If you want to use the PayCheck system, you need to set Enabled to true. ]] Config.PayChecks = { Enabled = true, -- Enable or disable the paycheck system Interval = 15, -- Every 15 minutes PayOutOfSocietyExcept = { -- Jobs that should not be paid out of society account ["police"] = true, ["doctor"] = true, }, PayOnlyWhenOnDuty = true, -- Pay only when player is on duty (Config.DutySystem must be true) SetMaxPaycheck = false, -- Set max paycheck for all jobs allowed to set or false NotifyIfSocietyBroke = true, -- Notify player when not paid due to society being broke } --[[ âââââââââââââââââ ââââââ âââââââââââ âââ ââââââââââââââââââââââââââââââââââââ âââ ââââââââ âââ ââââââââââââââââââââââââ ââââââââ âââ ââââââââââââââââââââââââ ââââââââ âââ âââ ââââââââââââââ âââ ââââââââ âââ âââ ââââââââââââââ âââ --> Allows players to store items in a stash that is linked to the society. --> If you want to use the stash, you need to set Enabled to true. --> Have custom slot limits for certain jobs rather than using the default slots. ]] Config.Stash = { Enabled = true, DefaultSlots = 10000, -- Default slots for the stash Slots = { ["police"] = 20000, } } Config.ManagementStash = { Enabled = true, DefaultSlots = 400, -- Default slots for the stash Slots = { ["police"] = 800, } } --[[ âââââââ ââââââ âââ âââââââ âââ âââââââ âââââââââââ ââââââââââââââââââââââââââââââââ ââââ ââââââââââââââ âââ ââââââââ âââââââââââ ââââââââââââ ââââââââââââââââââââââââââââââââââ âââââ ââââââââââââââ âââ âââââââââ ââââââ ââââ ââââââââ âââââââ ââââââââ âââ ââââââ âââââââââââ ââââââââââââââ âââ ââââââââââââââââ âââ ââââââââ âââââ ââââââââ âââ ââââââ âââââââââââ âââââââââââââââââââââââââââââââââ âââââââââââââââ ââââââââ âââ ââââââââ âââ âââââââââââ âââ âââ âââââââ âââââââââââââââââââââââââ âââââ âââââââ ââââââââ âââ ââââââââ âââ âââââââââââ âââ --> Allows players to bill other players for services. If you want to use the billing system, you need to set Enabled to true. ]] Config.BillingSystem = { Enabled = true, DefaultMaxAmount = 5000, -- Max amount for a bill to avoid abuse, or set to false to disable limiter. MaxAmount = { ["police"] = false, -- false to disable limit ["doctor"] = 200, -- Max amount for doctor bills is 200 }, BillWithoutConfirmation = false, -- If true, customer will be not be asked to confirm the bill, money will come out instantly. BillWithoutConfirmationPerJob = { -- Overrides BillWithoutConfirmation for selected jobs ["police"] = true, -- If true, police can bill without confirmation ["doctor"] = true, -- If true, doctor can bill without confirmation }, AllowNegativeMoney = false, -- If true, players can bill even if the customer has no money. This is mainly used for police and doctor jobs. AllowNegativeMoneyPerJob = { -- Overrides AllowNegativeMoney for selected jobs ["police"] = true, -- If true, police can bill even if the customer has no money ["doctor"] = true, -- If true, doctor can bill even if the customer has no money }, } -- Deprecated. It is available but not recommended. Config.BossMenuCommand = false -- "bossmenu" or false (to disable)