# BRK Notify

BRK Notify is a shared notification system for RedM scripts

it is made as a dependency for supported BRK scripts, but can also be used by other developers through client and server exports

the goal is to give scripts one clean notification resource instead of rebuilding notification UI in every resource

## features

* stacked text notifications

* loot notifications using inventory item images

* announcement banner

* animal identifying notifications

* exact animal model and hash matching

* individual images for supported animals

* shared animal resolver export for other scripts

* client exports

* server relay exports

* configurable size, position, duration, and colors

* public language config

* built in test command

## animal notifications

BRK Notify can identify the animal model being interacted with and display the matching animal image

supported scripts can send the animal model or hash and BRK Notify handles the image, broad animal type, exact name, and optional detail text

these notifications are made for BRK scripts such as Resourceful Ranger, Critter Care, and Ranching, but the resolver and notifications can also be exported for use in other resources

```

```

```

local identity = exports.brk_notify:ResolveAnimal(GetEntityModel(animal))

```

## loot notify

the loot notify is made for scripts that give items to players

common uses include harvesting rewards, loot rewards, crafting results, job rewards, shop messages, and item pickup messages

instead of using native game texture icons, loot notify uses inventory item images so custom server items can show the correct image too

```

```

```

exports.brk_notify:LootNotify({

item = 'prime_beef',

label = 'Prime Beef',

amount = 2,

duration = 2200,

})

```

## dependency use

some BRK scripts require BRK Notify

make sure `brk_notify` starts before any script that uses it

```

```

```

ensure brk_notify

ensure your_script_here

```

## developer use

BRK Notify can also be used by other scripts through client and server exports

notification text, images, animal models, duration, colors, and placement can be controlled through the available exports and configuration

## included

*

config

*

language config

*

readme

*

examples

*

client exports

*

server relay exports

*

shared animal resolver

*

NUI files

*

bundled UI assets

*

bundled animal images

*

support for BRK script integrations

Youtube: https://www.youtube.com/shorts/EcE1YJ1cn-c

Tebex: https://brk-scripting-studios.tebex.io/package/7563285

Discord: https://discord.gg/NPcYyTYaf

Github: https://github.com/blakelyrachelle

## support

support is available through Discord

please turn debug on, reproduce the issue, and send a screenshot of your F8 console when opening a ticket

| | |

|----|----|

| Code is accessible | No |

| Subscription based | No |

| Lines approximately | 1,300+ |

| Requirements | RedM |

| Support | Yes |

config, language config, readme, and examples are accessible

source code is protected through asset escrow