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

# Installation & Configuration

Install Striga Notify in a few minutes and set it up.

{% stepper %}
{% step %}

### Add the resource

Put the `striga-notify` folder in your `resources` folder.
{% endstep %}

{% step %}

### Start it in server.cfg

Start `striga-core` **first**, after ox\_lib, oxmysql and your framework. Then start Striga Notify:

```
ensure ox_lib
ensure oxmysql
ensure qb-core        # or qbx_core / es_extended
ensure striga-core
ensure striga-notify
```

{% hint style="warning" %}
Striga Notify needs **striga-core 0.1.0 or newer**.

* No striga-core: Striga Notify does not start.
* striga-core too old: striga-core stops Striga Notify and prints a red error in the server console. Update striga-core.
  {% endhint %}
  {% endstep %}

{% step %}

### Turn it on in striga-core

Open `striga-core/config.json` and set:

```json
"notify": "striga-notify"
```

All Striga scripts (Tokyo HUD, Chat, Inventory...) now show their notifications with Striga Notify.
{% endstep %}

{% step %}

### Catch your other scripts

Do the step for your framework on the [Integration](/docs/striga-notify/integration.md) page, so **every** script on your server uses the new design.
{% endstep %}

{% step %}

### Restart the server

Restart the whole server (not only the resource) and you are done.
{% endstep %}
{% endstepper %}

{% hint style="info" %}
striga-core checks for new versions when the server starts and prints a red `UPDATE` line when one is out. See [Updates & Versions](/docs/updates-and-versions.md).
{% endhint %}

***

## Player settings

Players change their settings in two places. Both change the same settings:

* `/notifysettings`, the Striga Notify panel
* `/hud`, the Striga Tokyo HUD menu, **Notifications** block (only when the HUD runs, through the striga-core settings hub). See [Settings Menu (/hud)](/docs/striga-tokyo-hud/settings-menu.md).

Set `Config.Ui.Settings = false` to lock them. Everyone then sees your config values, in both places.

### Colors

Every type has a fixed color: Info blue, Success green, Warning amber, Error red. A script can still set its own icon color with `iconColor`.

***

## Config

File: `editable/config.lua`

### General

| Option            | Default            | What it does                                                                                                                                                   |
| ----------------- | ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Locale`          | `'auto'`           | `'auto'` follows the striga-core server language. A code (e.g. `'tr'`) pins this script to `editable/locales/<code>.json`. See [Languages](/docs/languages.md) |
| `SettingsCommand` | `'notifysettings'` | Command for the player settings panel. `false` = no command                                                                                                    |
| `TestCommand`     | `false`            | Set e.g. `'notifytest'` to show one notification of every type                                                                                                 |
| `Capture.Esx`     | `true`             | Show ESX notifications (ESX only)                                                                                                                              |

### Look (`Config.Ui`)

| Option                | Default       | What it does                                                    |
| --------------------- | ------------- | --------------------------------------------------------------- |
| `Accent`              | `'#f43f5e'`   | Color of the `/notifysettings` panel when there is no HUD theme |
| `Style`               | `'card'`      | `card`, `tinted`, `compact`                                     |
| `IconStyle`           | `'tile'`      | `plain`, `tile`, `bar`                                          |
| `Position`            | `'top-right'` | See the positions below                                         |
| `OffsetX` / `OffsetY` | `24`          | Distance from the screen edge (px at 1080p)                     |
| `Width`               | `340`         | Width of a notification (px at 1080p)                           |
| `Opacity`             | `70`          | Background opacity, 30 to 100                                   |
| `Size`                | `100`         | Size in %, 80 to 140                                            |
| `Blur`                | `8`           | Background blur, 0 to 16 (0 = off)                              |
| `Duration`            | `5000`        | Duration in ms when a script gives none                         |
| `MaxVisible`          | `5`           | Notifications on screen at once (older ones leave)              |
| `Progress`            | `true`        | Time bar at the bottom                                          |
| `Sound`               | `true`        | Soft sound on a new notification                                |
| `Settings`            | `true`        | `false` = players cannot change anything                        |

**Positions:** `top-left`, `top`, `top-right`, `center-left`, `center-right`, `bottom-left`, `bottom`, `bottom-right`

{% hint style="info" %}
The `Config.Ui` values are the **defaults**. Players can still change them for themselves in `/notifysettings` or `/hud`, unless you set `Settings = false`.
{% endhint %}

***

## Test it

1. Set `Config.TestCommand = 'notifytest'` and restart the resource.
2. In game, type `/notifytest`. You see one Info, Success, Warning and Error notification.
3. Type `/notifysettings` and try the looks.
4. Set `TestCommand` back to `false` when you are done.

{% content-ref url="/pages/BsDd3TRicHwDqcTOl223" %}
[Integration](/docs/striga-notify/integration.md)
{% endcontent-ref %}


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://striga.gitbook.io/docs/striga-notify/installation-and-configuration.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.