> For the complete documentation index, see [llms.txt](https://docs.northscripts.dev/site/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.northscripts.dev/site/documentation/resources/bossmenu/installation.md).

# Installation

1. Download the resource and place the `north_bossmenu` folder in your `resources` directory. Keep the folder name as it is: exports and events use it.
2. Start the server. There is no SQL file to import. On first start the `bossmenu_*` tables are created and the console prints what was detected:

   ```
   ready (framework: esx, inventory: ox_inventory, target: ox_target, bank: esx_addonaccount)
   ```
3. Check that line. If something shows as `none`, `standalone` or `fallback` when you expected a resource name, that resource started after `north_bossmenu`. Move the `ensure` line down or set the value by hand in the config.
4. Edit `config/config.lua` to taste.

***

## First-time setup

Everything below is done in game by the boss of a job. No coordinates go in the config.

### 1. Place the boss menu

1. Join as the boss (highest grade) of the job.
2. Run `/setbossmenu`.
3. Choose **Marker** or **Ped**, aim where you want it and confirm.

The point now exists for that job. Only players who can open the menu see it.

`/setbossmenu` works once per job. After that the point is moved from **Settings → Boss Menu Location** inside the menu. Server admins can run the command again at any time, for the job they currently hold.

### 2. Place the other points

Open the menu and go to **Settings → Business Management**:

| Point              | What it does                                                            |
| ------------------ | ----------------------------------------------------------------------- |
| Boss Menu Location | Moves the boss menu point                                               |
| On Duty Location   | Employees clock in and out here                                         |
| Stash Location     | Create named stashes, choose which grades can open each one, place them |
| Wardrobe Location  | Create wardrobes where employees put on the job outfits                 |

Duty, stash and wardrobe points are visible to every employee of the job.

### Placement controls

| Key                 | Action                                   |
| ------------------- | ---------------------------------------- |
| Mouse               | Aim                                      |
| Arrow keys          | Nudge forward, back, left, right         |
| Page Up / Page Down | Raise / lower                            |
| Scroll wheel        | Rotate                                   |
| Q / E               | Previous / next marker type or ped model |
| Enter               | Confirm                                  |
| Backspace           | Cancel                                   |

All of these can be changed in `Config.PlacementKeys`.

***