Configuration

Every option in config.lua, including language.

Not released yet. These pages are written from the code of manniche_bossmenu and can change before the release.

General

Option	Default	What it does
`Config.Locale`	`'da'`	Language: `'da'` or `'en'`. Also sets the money format.
`Config.Debug`	`false`	Prints debug messages to the server and client console.

Language

Two languages exist in shared/locales.lua: da and en. Set Config.Locale to switch. With da money shows as 1.234 DKK. With en it shows as $1,234. The UI texts come from web/src/lib/i18n.js, so a change to UI texts needs a rebuild of web/.

Opening the menu

Option	Default	What it does
`Config.Command`	`'bossmenu'`	Command that opens the tablet.
`Config.Keybind`	`''`	Optional key, for example `'F6'`. Empty means no key.
`Config.OpenDistanceToMarker`	`false`	If `true`, the player must stand at the job's boss zone. Checked on the server.
`Config.ZoneDistance`	`5.0`	Metres from the zone.
`Config.BossZones`	empty	One `vector3` per job name, for example `police = vector3(460.0, -985.0, 30.7)`. Used only when `OpenDistanceToMarker` is `true`. A job without a zone cannot open the menu then.

UI

`Config.UI`

Option	Default	What it does
`defaultLayout`	`'sidebar'`	`'sidebar'` or `'topbar'`.
`allowLayoutSwitch`	`true`	Players may switch layout in Settings.
`defaultTheme`	`'midnight'`	Key of a theme in `themes`.
`notifications`	`true`	Default for in-NUI notifications.
`themes`	midnight, emerald, crimson, royal	Colour themes. Each has `label`, `accent`, `accent2`, `bg`, `surface`, `text`, `muted`. You can edit or add themes.

`Config.UI.transparency`

Affects the UI only, not the game behind it.

Option	Default	What it does
`allowToggle`	`true`	Show the "Transparent UI" toggle in Settings.
`defaultOn`	`false`	Transparent UI on by default.
`panelOpacity`	`0.85`	UI opacity when transparent is on (0-1).
`dimOnMouseLeave`	`true`	Show the "Dim" toggle in Settings.
`dimDefaultOn`	`false`	Dim on by default.
`dimOpacity`	`0.5`	UI opacity when the mouse leaves the panel (0-1).

Features

Config.Features switches whole modules on or off. A module that is off is hidden in the UI and refused on the server.

Option	Default	What it does
`economy`	`true`	Economy tab: deposit, withdraw, balance.
`history`	`true`	Transaction history.
`members`	`true`	Employee list.
`hire`	`true`	Hire nearby players. They must accept.
`fire`	`true`	Fire members.
`promoteDemote`	`true`	Promote and demote.
`rankManagement`	`true`	Create, edit and delete ranks.
`specialTraining`	`true`	Special trainings, only for jobs that define them.
`settings`	`true`	Settings tab.

Economy

The money is the esx_addonaccount account named <accountPrefix><job>, for example society_police.

Option	Default	What it does
`accountPrefix`	`'society_'`	Prefix of the account name.
`minAmount`	`1`	Smallest amount per transaction.
`maxAmount`	`10000000`	Largest amount per transaction.
`cooldown.deposit`	`3`	Seconds between two deposits per player. Starts only after a successful action.
`cooldown.withdraw`	`5`	Seconds between two withdrawals per player. Starts only after a successful action.
`serverLogEvent`	`true`	Fire the server event `manniche_bossmenu:serverLog` for every action.

Members and hiring

`Config.Members`

Option	Default	What it does
`hireDistance`	`8.0`	Metres for the nearby list and the hire offer (1-15).
`maxHireDistance`	`15.0`	Hard cap. Checked again when the target accepts.
`showOfflineMembers`	`true`	Show offline members in the Members tab.

`Config.Hire`

Option	Default	What it does
`onlyUnemployed`	`true`	Only players with the job `unemployedJob` can be hired.
`unemployedJob`	`'unemployed'`	Also the job fired players get (grade 0).
`offerSeconds`	`30`	How long a job offer stays open.

Ranks

Option	Default	What it does
`Config.Ranks.maxSalary`	`1000`	Highest salary a boss may set. A job can override it with its own `maxSalary`.
`Config.Ranks.maxLabelLength`	`32`	Longest rank label.
`Config.RankSync.refreshOnChange`	`true`	Calls `ESX.RefreshJob(job)` after rank changes.

Jobs

Config.Jobs lists the jobs that get the menu. Ranks are read from the ESX job_grades table, so you do not list them here. Defaults: police, ambulance, mechanic, taxi, cardealer.

Key	Required	What it does
`label`	yes	Name shown in the menu.
`type`	no	`'job'` or `'gang'`. Cosmetic.
`minGrade`	no	Lowest grade that may open the menu. Default: the boss grade.
`maxSalary`	no	Overrides `Config.Ranks.maxSalary` for this job.
`training`	no	List of `{ id = '...', label = '...' }` special trainings.

police = {
    label = 'Police',
    type = 'job',
    training = {
        { id = 'k9', label = 'K9 unit' },
    },
},

Discord webhook

Option	Default	What it does
`Config.Webhook.enabled`	`false`	Send log entries to Discord.
`Config.Webhook.url`	`''`	Discord webhook URL. Keep it out of version control.
`Config.Webhook.botName`	`'Boss menu'`	Name shown on the message.
`Config.Webhook.color`	`3447003`	Embed colour.