> For the complete documentation index, see [llms.txt](https://zloma-scripts.gitbook.io/zloma-scripts/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://zloma-scripts.gitbook.io/zloma-scripts/zloma_bossmenu-free/installation.md).

# Installation

## Requirements

| Dependency                                         | Required                |
| -------------------------------------------------- | ----------------------- |
| [ox\_lib](https://github.com/overextended/ox_lib)  | Yes                     |
| [oxmysql](https://github.com/overextended/oxmysql) | Yes                     |
| zloma\_core                                        | Yes                     |
| Stash-capable inventory supported by zloma\_core   | Only for stash features |

***

## Setup

1. Place `zloma_bossmenu` inside your resources folder.
2. Import the SQL schema from `zloma_bossmenu/sql/install.sql`.
3. Ensure dependencies start before `zloma_bossmenu`.

```cfg
ensure ox_lib
ensure oxmysql
ensure zloma_core
ensure zloma_bossmenu
```

4. Open `shared/config.lua` and review:

* `Config.Creator.allowedGroups`
* `Config.UnemployedJob`
* `Config.Money`
* `Config.Salary`
* `Config.DiscordWebhooks`
* `Config.Language`
* `Config.PlayerStashes`

5. If you need to force a specific appearance resource for wardrobes, set `ZlomaCore.Config.Manual.Appearance` in `zloma_core/shared/config.lua`.
6. Add the optional stash items to your inventory if you want player-owned stashes.

Boss and player stash flows are routed through `zloma_core`, so they can use any inventory backend that `zloma_core` currently supports.

Admin stash-content preview is best-effort on some backends. If an inventory exposes stash open/register APIs but not stash-read APIs, the stash still works normally while the preview panel may show an empty result.

Default stash item names expected by the resource:

* `small_wardrobe`
* `safe`
* `large_safe`

7. If you change the UI source under `zloma_bossmenu/ui`, rebuild it so `ui/dist` stays in sync with the files loaded by `fxmanifest.lua`.

## First Start Checks

* Use `/bossmenuadmin` as an allowed admin to verify the admin dashboard opens.
* Create one test menu and confirm the menu target, stash, and wardrobe save correctly.
* Deposit and withdraw a small amount once to verify your detected banking system is wired correctly through `zloma_core`.
* If player stashes are enabled, place one stash, test PIN setup, wrong-PIN handling, and owner removal.
* Switch `Config.Language` between `en` and `hr` once to verify creator, stash, and salary labels all render correctly.

## Common Notes

* The public release defaults to English in `Config.Language`.
* Wardrobe access is provided through `zloma_core`, not directly by this resource.
* Salary payouts are processed on a timed server thread, so you should test with a short interval on a dev server before using production values.
* Boss and player stash flows are now opened through `zloma_core`; if the detected inventory does not support stash registration/opening, stash features remain unavailable while the rest of the resource still works.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://zloma-scripts.gitbook.io/zloma-scripts/zloma_bossmenu-free/installation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.