# 📖 Configuration

First install, really important!

ox_lib is required and must be started up before of_pause in your server.cfg.

Mugshot

The mugshot feature requires the MugShotBase64 dependency to be enabled in configuration config.lua/{ mugshot }.

The configuration for of-pausemenu can be found inside the config.lua file. Below is a breakdown of each option available.

# Grid Layout

Defines how widgets are arranged in the pause menu. Each set (a, b, c, d) must be rectangular and adjacent.

Example:

gridLayout = {
  { 'a', 'a', 'b', 'd' },
  { 'a', 'a', 'c', 'd' }
}

Key	Description
`a`	Map widget
`b`	Players list
`c`	Police panel
`d`	Discord section

# General Settings

Option	Description
`framework`	Framework to use. Supported: `esx`, `qb`, `standalone`.
`locale`	Language used. Check `of_pause/lang/*.lua` to add or edit locales.
`server_refresh`	Interval (ms) to refresh server data. Automatically updates when police status changes.

# Police Settings

The way this system works is really simple. If current police (on duty) is equal or greater than minDuty, then the pausemenu will display (available). Otherwise, it'll display unavailable unless /forceStatusCommand true is executed, then TRUE (Available) will be forced and minDuty ignored.

Option	Description
`jobName`	Name of the police job. Default: `police`.
`minDuty`	Minimum number of officers on duty to display police-related UI.
`rankForCommand`	Minimum rank required to use the `forcepolice` command. Set `nil` to disable.
`forceStatusCommand`	Command to override minimum police requirement. Usage: `/forcepolice true` or `/forcepolice false`.

# Frontend Settings

Option	Description
`url:shop`	URL used for shop link in the UI.
`url:discord`	Discord invite or community URL.
`url:rules`	Link to server rules page.
`mugshot`	Enable mugshot as player profile picture (requires MugShotBase64).

# Aliases

Maps internal framework names

_alias = {
  ['qb'] = 'qb-core',
  ['esx'] = 'es_extended',
}

Change ONLY if you are using any of these frameworks under a different name (Eg. renamed qb-core myserver-core). If you are using a standalone framework you will need to setup 'client/modules/bridge/standalone.lua' and 'client/modules/bridge/standalone.lua'

For any questions or issues, reach out on our Discord.