Codineer Docs
Search…
Mailman Pro
This makes delivering parcels and letters fun!

Installing Mailman Pro

This guide will show you how to install Mailman Pro.
This guide is very detailed but the basics that are always the same can be found in the Installation tutorial and should be enough for most server owners.
Please note that this guide is written for Mailman Pro version 1.4.0 and the installation might be different for older or newer versions.
  1. 1.
    Unpack the file you downloaded before. Now there are two folders: MailmanPro and Translations
  2. 2.
    Copy the MailmanPro folder to your FiveM servers resources folder.
  3. 3.
    Open the config.json file included in your just copied MailmanPro folder.
  4. 4.
    Enter the Transaction ID you got with your Purchase in the TransactionID field.
  5. 5.
    Edit the config file to your likings and close it (do not forget to save).
  6. 6.
    Open your servers config.cfg file and enter ensure MailmanPro in a new line.

Installing Translations

Please note that third party translations could contain malicious code and you should read through them before installing them. All translations included with your Mailman Pro download are offical translations and are not containing malicious code.
The english version of Mailman Pro is already pre-installed and you do not have to install any additional translations to use Mailman Pro in english.
  1. 1.
    Open the folder you got with your Mailman Pro download. It contains two folders: MailmanPro and Translations.
  2. 2.
    Open the Translations folder.
  3. 3.
    Open the folder of the language you want to use. In my case German.
  4. 4.
    Copy all files in there into your Mailman Pro installation (the MailmanPro folder in your FiveM servers resources folder).
    1. 1.
      If it asks if you want to replace or skip select Replace.
  5. 5.
    Restart the script

Key System implementation

Please note that the implementation for car key systems is only included in Mailman Pro version 1.6.2 or newer.
Please note that this is a client side event. If your car key system needs server side implementation you will have to implement the bridge yourself.
Mailman Pro has an event called MailmanPro:CarSpawned that is triggered whenever a vehicle is being spawned for the player.

Parameters

  1. 1.
    Vehicle Handle
    Can be used to retrieve the vehicle object or for native calls
  2. 2.
    License Plate
    Can be used as identifier for some key resources

Example implementation

C# Example
1
EventHandlers["MailmanPro:CarSpawned"] += new Action<int, string>(TargetFunction);
2
3
private void TargetFunction(int handle, string plate)
4
{
5
myKeyScript.unlockCar(handle);
6
}
Copied!
Lua Example
1
AddEventHandler("MailmanPro:CarSpawned", function(handle, plate)
2
myKeyScript.unlockCar(handle)
3
end)
Copied!
JS Example
1
on('MailmanPro:CarSpawned', (handle, plate) => {
2
myKeyScript.unlockCar(handle);
3
});
Copied!
Last modified 15d ago