# Welcome!

This is the official documentation for every fivem script by mxo-scripts


# MXO Notify

This is the official documentation for the mxo-notify FiveM script

Preview: [YouTube](https://www.youtube.com/watch?v=B32lO9yNuUY)\
Purchase: <https://store.mxo-scripts.com>


# Installation

Here you will learn how to install the script correctly to avoid errors.

## Download

First of all you have to download the mxo-notify.zip from your cfx keymaster. Then unpack the zip file into the resources folder of your server.

Next you have to start the script in your server.cfg.

```lua
ensure mxo-notify
```

Finally, restart your server once and the script is ready to use.


# Integration

To be able to include the notifications now, here is how you trigger the notifications in other scripts

### Notifications

#### Client Side

```lua
exports['mxo-notify']:Alert('Title', 'Message', Time, 'type')
```

#### Server Side

```lua
TriggerClientEvent('mxo-notify:Alert', source, 'Title', 'Message', Time, 'type')
```

### Announcements

#### Client Side

```lua
exports['mxo-notify']:Announce('Title', 'Message', Time, 'type')
```

#### Server Side

```lua
TriggerClientEvent('mxo-notify:Announce', source, 'Title', 'Message', Time, 'type')
```

### Configuration

#### Available types

These types are configured by default. Feel free to add more types by your own.

* success (<mark style="color:green;">green</mark>)
* info (<mark style="color:blue;">blue</mark>)
* error (<mark style="color:red;">red</mark>)
* warning (<mark style="color:yellow;">yellow</mark>)

#### **Add more types**

You can add your own types by simply adding them to config.lua. Once you have added them there, you can integrate the new types into other scripts. See more at the config.lua

#### Ad

#### Changing Sound

To change the sound of the notification, you need to replace the sound.mp3 file.&#x20;

The file is located at <mark style="color:blue;">`mxo-notify/html/sound.mp3`</mark>

#### Common Errors

<details>

<summary>Help, the icons are not displayed</summary>

If the items are not displayed, you have probably selected a premium icon from FontAwesome. Make sure that the icon is a Free icon.

</details>

<details>

<summary>The message is displayed only for a short time</summary>

This happens when you specify the Time as seconds. The time must be specified in milliseconds. 1 Second = 1000 milliseconds

</details>


# MXO Revivestation

This is the official documentation for the mxo-moneywash FiveM script


# Installation

Here you will learn how to install the script correctly to avoid errors.

## Download

First of all you have to download the mxo-moneywash.zip from your cfx keymaster. Then unpack the zip file into the resources folder of your server.

Next you have to start the script in your server.cfg.

```lua
ensure mxo-revivestation
```

Finally, restart your server once and the script is ready to use.


# Configuration

To avoid errors, we explain here how to configure the script correctly

## Setup Framework

To use the correct function that provides the framework to the script, you must either set `Config.GetSharedObjectFunction` to `true` here, or use the `GetESX()` function.

If you want to use the `GetESX()` function, you have to set `Config.GetSharedObjectFunction` to `false`.

If you are using ESX 1.7.5 or later, set `Config.GetSharedObjectFunction` to `true`.

## Revive Trigger

By default, the esx\_ambulancejob is enabled. However, you can change the trigger by entering your revive trigger in the config.

```lua
Config.Revive = function(player) 
    TriggerClientEvent('esx_ambulancejob:revive', player)
    -- Insert your revive code here
end
```

## Change language

{% hint style="warning" %}
If you change the language, make sure the file also exists under `./locales` and the language exists under `./html/language.js`
{% endhint %}

Change the value to the language you want to use

```lua
Config.Locale = 'en'
```

## Add custom Notify

If you want to change the default notify messages, change the value in the config.

```lua
function SendNotify(message, _type)
    exports['mxo-notify']:Alert('Moneywash', message, 4000, _type)
end
```

## Blacklisted Deathcauses

If a player has died from a death cause that is blacklisted, he cannot be revived in revivestation. To add a blacklisted death cause just put it in the list.

```lua
Config.BlacklistedDeathCauses = ["Explosion", "Burn", "Gas", ...]
```

possible death causes are:

* Animal
* Bullet
* Burn
* Car
* Drown
* Explosion
* FallDamage
* Gas
* Knife
* Melee


# MXO Moneywash

This is the official documentation for the mxo-moneywash FiveM script

Preview: [YouTube](https://www.youtube.com/watch?v=T5mpRxPKLyk)\
Purchase: [https://store.mxo-scripts.com](https://store.mxo-scripts.com/package/5485704)


# Installation

Here you will learn how to install the script correctly to avoid errors.

## Download

First of all you have to download the mxo-moneywash.zip from your cfx keymaster. Then unpack the zip file into the resources folder of your server.

Next you have to start the script in your server.cfg.

```lua
ensure mxo-moneywash
```

Finally, restart your server once and the script is ready to use.


# Configuration

To avoid errors, we explain here how to configure the script correctly

## Change language

{% hint style="warning" %}
If you change the language, make sure the file also exists under `./locales` and the language exists under `./html/language.js`
{% endhint %}

Change the value to the language you want to use

```lua
Config.Locale = 'en'
```

## Using Blackmoney / Money as Items

If you have money and black money as items, then you should set the `Config.IsBlackMoneyItem` value to `true`. Then adjust the item names. If you do not have the money as items, set the correct accounts

```lua
Config.IsBlackMoneyItem = true
Config.BlackMoneyAccount = 'black_money'
Config.BlackMoneyItem = 'black_money'
Config.MoneyAccount = 'money'
Config.MoneyItem = 'cash'
```

## Add custom Notify

If you want to change the default notify messages, change the value in the config.

```lua
function SendNotify(message, _type)
    exports['mxo-notify']:Alert('Moneywash', message, 4000, _type)
end
```


